Values_1.GetMaintenanceWindowTaskResultSourceRetrieves the details of a maintenance window task. For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored. To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
type nonrec t = {windowId : Values_0.MaintenanceWindowId.t option;The retrieved maintenance window ID.
*)windowTaskId : Values_0.MaintenanceWindowTaskId.t option;The retrieved maintenance window task ID.
*)targets : Values_0.Targets.t option;The targets where the task should run.
*)taskArn : Values_0.MaintenanceWindowTaskArn.t option;The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the value of TaskArn is the SSM document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.
*)serviceRoleArn : Values_0.ServiceRole.t option;The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow. However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.
*)taskType : Values_0.MaintenanceWindowTaskType.t option;The type of task to run.
*)taskParameters : MaintenanceWindowTaskParameters.t option;The parameters to pass to the task when it runs. TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*)taskInvocationParameters : MaintenanceWindowTaskInvocationParameters.t option;The parameters to pass to the task when it runs.
*)priority : Values_0.MaintenanceWindowTaskPriority.t option;The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
*)maxConcurrency : Values_0.MaxConcurrency.t option;The maximum number of targets allowed to run this task in parallel. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
*)maxErrors : Values_0.MaxErrors.t option;The maximum number of errors allowed before the task stops being scheduled. For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
*)loggingInfo : LoggingInfo.t option;The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged. LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.
*)name : Values_0.MaintenanceWindowName.t option;The retrieved task name.
*)description : Values_0.MaintenanceWindowDescription.t option;The retrieved task description.
*)cutoffBehavior : MaintenanceWindowTaskCutoffBehavior.t option;The action to take on tasks when the maintenance window cutoff time is reached. CONTINUE_TASK means that tasks continue to run. For Automation, Lambda, Step Functions tasks, CANCEL_TASK means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, CANCEL_TASK means the system attempts to stop the task by sending a CancelCommand operation.
*)alarmConfiguration : Values_0.AlarmConfiguration.t option;The details for the CloudWatch alarm you applied to your maintenance window task.
*)}type nonrec error = [ | `DoesNotExistException of Values_0.DoesNotExistException.t| `InternalServerError of Values_0.InternalServerError.t| `Unknown_operation_error of string * string option ]val make :
?windowId:??? ->
?windowTaskId:??? ->
?targets:??? ->
?taskArn:??? ->
?serviceRoleArn:??? ->
?taskType:??? ->
?taskParameters:??? ->
?taskInvocationParameters:??? ->
?priority:??? ->
?maxConcurrency:??? ->
?maxErrors:??? ->
?loggingInfo:??? ->
?name:??? ->
?description:??? ->
?cutoffBehavior:??? ->
?alarmConfiguration:??? ->
unit ->
tval error_of_json :
string ->
Yojson.Safe.t ->
[> `DoesNotExistException of Values_0.DoesNotExistException.t
| `InternalServerError of Values_0.InternalServerError.t
| `Unknown_operation_error of string * string option ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `DoesNotExistException of Values_0.DoesNotExistException.t
| `InternalServerError of Values_0.InternalServerError.t
| `Unknown_operation_error of string * string option ]val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `Integer of Values_0.MaintenanceWindowTaskPriority.t
| `List of
[> `Structure of
(string
* [> `List of [> `String of string ] list
| `String of string ])
list ]
list
| `Map of
([> `String of Values_0.MaintenanceWindowTaskParameterName.t ]
* [> `Structure of
(string * [> `List of [> `String of string ] list ]) list ])
list
| `String of Values_0.MaintenanceWindowId.t
| `Structure of
(string
* [> `Boolean of bool
| `List of
[> `Structure of (string * [> `String of string ]) list ] list
| `String of Values_0.S3BucketName.t
| `Structure of
(string
* [> `Blob of MaintenanceWindowLambdaPayload.t
| `Enum of string
| `Integer of Values_0.TimeoutSeconds.t
| `Map of
([> `String of string ]
* [> `List of [> `String of string ] list ])
list
| `String of Values_0.Comment.t
| `Structure of
(string
* [> `Boolean of bool
| `Enum of string
| `List of [> `Enum of string ] list
| `String of string ])
list ])
list ])
list ])
list ]