Module Values_1.UpdateMaintenanceWindowTaskResultSource

Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values: TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript. ServiceRoleArn TaskInvocationParameters Priority MaxConcurrency MaxErrors One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide. If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null. When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

Sourcetype nonrec t = {
  1. windowId : Values_0.MaintenanceWindowId.t option;
    (*

    The ID of the maintenance window that was updated.

    *)
  2. windowTaskId : Values_0.MaintenanceWindowTaskId.t option;
    (*

    The task ID of the maintenance window that was updated.

    *)
  3. targets : Values_0.Targets.t option;
    (*

    The updated target values.

    *)
  4. taskArn : Values_0.MaintenanceWindowTaskArn.t option;
    (*

    The updated task ARN value.

    *)
  5. 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.

    *)
  6. taskParameters : MaintenanceWindowTaskParameters.t option;
    (*

    The updated parameter values. 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.

    *)
  7. taskInvocationParameters : MaintenanceWindowTaskInvocationParameters.t option;
    (*

    The updated parameter values.

    *)
  8. priority : Values_0.MaintenanceWindowTaskPriority.t option;
    (*

    The updated priority value.

    *)
  9. maxConcurrency : Values_0.MaxConcurrency.t option;
    (*

    The updated MaxConcurrency value.

    *)
  10. maxErrors : Values_0.MaxErrors.t option;
    (*

    The updated MaxErrors value.

    *)
  11. loggingInfo : LoggingInfo.t option;
    (*

    The updated logging information in Amazon S3. 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.

    *)
  12. name : Values_0.MaintenanceWindowName.t option;
    (*

    The updated task name.

    *)
  13. description : Values_0.MaintenanceWindowDescription.t option;
    (*

    The updated task description.

    *)
  14. cutoffBehavior : MaintenanceWindowTaskCutoffBehavior.t option;
    (*

    The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

    *)
  15. alarmConfiguration : Values_0.AlarmConfiguration.t option;
    (*

    The details for the CloudWatch alarm you applied to your maintenance window task.

    *)
}
Sourcetype nonrec error = [
  1. | `DoesNotExistException of Values_0.DoesNotExistException.t
  2. | `InternalServerError of Values_0.InternalServerError.t
  3. | `Unknown_operation_error of string * string option
]
Sourceval make : ?windowId:??? -> ?windowTaskId:??? -> ?targets:??? -> ?taskArn:??? -> ?serviceRoleArn:??? -> ?taskParameters:??? -> ?taskInvocationParameters:??? -> ?priority:??? -> ?maxConcurrency:??? -> ?maxErrors:??? -> ?loggingInfo:??? -> ?name:??? -> ?description:??? -> ?cutoffBehavior:??? -> ?alarmConfiguration:??? -> unit -> t
Sourceval 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 ]
Sourceval 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 ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval 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 ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t