Update Maintenance Window Task
ssm_update_maintenance_window_task | R Documentation |
Modifies a task assigned to a maintenance window¶
Description¶
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 aRUN_COMMAND
task fromAWS-RunPowerShellScript
toAWS-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 update_maintenance_window_task
is
null, then the corresponding field isn't modified. If you set Replace
to true, then all fields required by the
register_task_with_maintenance_window
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.
Usage¶
ssm_update_maintenance_window_task(WindowId, WindowTaskId, Targets,
TaskArn, ServiceRoleArn, TaskParameters, TaskInvocationParameters,
Priority, MaxConcurrency, MaxErrors, LoggingInfo, Name, Description,
Replace, CutoffBehavior, AlarmConfiguration)
Arguments¶
WindowId
[required] The maintenance window ID that contains the task to modify.
WindowTaskId
[required] The task ID to modify.
Targets
The targets (either managed nodes or tags) to modify. Managed nodes are specified using the format
Key=instanceids,Values=instanceID_1,instanceID_2
. Tags are specified using the format Key=tag_name,Values=tag_value
.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.
TaskArn
The task ARN to modify.
ServiceRoleArn
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
register_task_with_maintenance_window
.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.
TaskParameters
The parameters to modify.
TaskParameters
has been deprecated. To specify parameters to pass to a task when it runs, instead use theParameters
option in theTaskInvocationParameters
structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.The map has the following format:
Key: string, between 1 and 255 characters
Value: an array of strings, each string is between 1 and 255 characters
TaskInvocationParameters
The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
When you update a maintenance window task that has options specified in
TaskInvocationParameters
, you must provide again all theTaskInvocationParameters
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 specifiedTaskInvocationParameters
values forComment
,NotificationConfig
, andOutputS3BucketName
. If you update the maintenance window task and specify only a differentOutputS3BucketName
value, the values forComment
andNotificationConfig
are removed.Priority
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
MaxConcurrency
The new
MaxConcurrency
value you want to specify.MaxConcurrency
is the number of targets that are allowed to run this task, in parallel.Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.MaxErrors
The new
MaxErrors
value to specify.MaxErrors
is the maximum number of errors that are allowed before the task stops being scheduled.Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
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
. This value doesn't affect the running of your task.LoggingInfo
The new logging location in Amazon S3 to specify.
LoggingInfo
has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.Name
The new task name to specify.
Description
The new task description to specify.
Replace
If True, then all fields that are required by the
register_task_with_maintenance_window
operation are also required for this API request. Optional fields that aren't specified are set to null.CutoffBehavior
Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
CONTINUE_TASK
: When the cutoff time is reached, any tasks that are running continue. The default value.CANCEL_TASK
:For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
For Run Command tasks: When the cutoff time is reached, the system sends a
cancel_command
operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.
The status for tasks that are not completed is
TIMED_OUT
.
AlarmConfiguration
The CloudWatch alarm you want to apply to your maintenance window task.
Value¶
A list with the following syntax:
list(
WindowId = "string",
WindowTaskId = "string",
Targets = list(
list(
Key = "string",
Values = list(
"string"
)
)
),
TaskArn = "string",
ServiceRoleArn = "string",
TaskParameters = list(
list(
Values = list(
"string"
)
)
),
TaskInvocationParameters = list(
RunCommand = list(
Comment = "string",
CloudWatchOutputConfig = list(
CloudWatchLogGroupName = "string",
CloudWatchOutputEnabled = TRUE|FALSE
),
DocumentHash = "string",
DocumentHashType = "Sha256"|"Sha1",
DocumentVersion = "string",
NotificationConfig = list(
NotificationArn = "string",
NotificationEvents = list(
"All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
),
NotificationType = "Command"|"Invocation"
),
OutputS3BucketName = "string",
OutputS3KeyPrefix = "string",
Parameters = list(
list(
"string"
)
),
ServiceRoleArn = "string",
TimeoutSeconds = 123
),
Automation = list(
DocumentVersion = "string",
Parameters = list(
list(
"string"
)
)
),
StepFunctions = list(
Input = "string",
Name = "string"
),
Lambda = list(
ClientContext = "string",
Qualifier = "string",
Payload = raw
)
),
Priority = 123,
MaxConcurrency = "string",
MaxErrors = "string",
LoggingInfo = list(
S3BucketName = "string",
S3KeyPrefix = "string",
S3Region = "string"
),
Name = "string",
Description = "string",
CutoffBehavior = "CONTINUE_TASK"|"CANCEL_TASK",
AlarmConfiguration = list(
IgnorePollAlarmFailure = TRUE|FALSE,
Alarms = list(
list(
Name = "string"
)
)
)
)
Request syntax¶
svc$update_maintenance_window_task(
WindowId = "string",
WindowTaskId = "string",
Targets = list(
list(
Key = "string",
Values = list(
"string"
)
)
),
TaskArn = "string",
ServiceRoleArn = "string",
TaskParameters = list(
list(
Values = list(
"string"
)
)
),
TaskInvocationParameters = list(
RunCommand = list(
Comment = "string",
CloudWatchOutputConfig = list(
CloudWatchLogGroupName = "string",
CloudWatchOutputEnabled = TRUE|FALSE
),
DocumentHash = "string",
DocumentHashType = "Sha256"|"Sha1",
DocumentVersion = "string",
NotificationConfig = list(
NotificationArn = "string",
NotificationEvents = list(
"All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed"
),
NotificationType = "Command"|"Invocation"
),
OutputS3BucketName = "string",
OutputS3KeyPrefix = "string",
Parameters = list(
list(
"string"
)
),
ServiceRoleArn = "string",
TimeoutSeconds = 123
),
Automation = list(
DocumentVersion = "string",
Parameters = list(
list(
"string"
)
)
),
StepFunctions = list(
Input = "string",
Name = "string"
),
Lambda = list(
ClientContext = "string",
Qualifier = "string",
Payload = raw
)
),
Priority = 123,
MaxConcurrency = "string",
MaxErrors = "string",
LoggingInfo = list(
S3BucketName = "string",
S3KeyPrefix = "string",
S3Region = "string"
),
Name = "string",
Description = "string",
Replace = TRUE|FALSE,
CutoffBehavior = "CONTINUE_TASK"|"CANCEL_TASK",
AlarmConfiguration = list(
IgnorePollAlarmFailure = TRUE|FALSE,
Alarms = list(
list(
Name = "string"
)
)
)
)