Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.UpdateMaintenanceWindowTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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.

Synopsis

Creating a Request

data UpdateMaintenanceWindowTask Source #

See: newUpdateMaintenanceWindowTask smart constructor.

Constructors

UpdateMaintenanceWindowTask'

Fields

alarmConfiguration :: Maybe AlarmConfiguration
The CloudWatch alarm you want to apply to your maintenance window task.
cutoffBehavior :: Maybe MaintenanceWindowTaskCutoffBehavior
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 CancelCommand 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.
description :: Maybe (Sensitive Text)
The new task description to specify.
loggingInfo :: Maybe 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 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.
maxConcurrency :: Maybe Text
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 :: Maybe Text
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.
name :: Maybe Text
The new task name to specify.
priority :: Maybe Natural
The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
replace :: Maybe Bool
If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
serviceRoleArn :: Maybe Text
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 your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.
For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:
- Using service-linked roles for Systems Manager
- Should I use a service-linked role or a custom service role to run maintenance window tasks?
targets :: Maybe [Target]
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 :: Maybe Text
The task ARN to modify.
taskInvocationParameters :: Maybe MaintenanceWindowTaskInvocationParameters
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 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.
taskParameters :: Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))
The parameters to modify.
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.
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
windowId :: Text
The maintenance window ID that contains the task to modify.
windowTaskId :: Text
The task ID to modify.

Instances

Instances details

ToJSON UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods toJSON :: UpdateMaintenanceWindowTask -> Value # toEncoding :: UpdateMaintenanceWindowTask -> Encoding # toJSONList :: [UpdateMaintenanceWindowTask] -> Value # toEncodingList :: [UpdateMaintenanceWindowTask] -> Encoding #
ToHeaders UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods toHeaders :: UpdateMaintenanceWindowTask -> [Header] #
ToPath UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods toPath :: UpdateMaintenanceWindowTask -> ByteString #
ToQuery UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods toQuery :: UpdateMaintenanceWindowTask -> QueryString #
AWSRequest UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Associated Types type AWSResponse UpdateMaintenanceWindowTask # Methods request :: (Service -> Service) -> UpdateMaintenanceWindowTask -> Request UpdateMaintenanceWindowTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateMaintenanceWindowTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateMaintenanceWindowTask))) #
Generic UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Associated Types type Rep UpdateMaintenanceWindowTask :: Type -> Type # Methods from :: UpdateMaintenanceWindowTask -> Rep UpdateMaintenanceWindowTask x # to :: Rep UpdateMaintenanceWindowTask x -> UpdateMaintenanceWindowTask #
Show UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods showsPrec :: Int -> UpdateMaintenanceWindowTask -> ShowS # show :: UpdateMaintenanceWindowTask -> String # showList :: [UpdateMaintenanceWindowTask] -> ShowS #
NFData UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods rnf :: UpdateMaintenanceWindowTask -> () #
Eq UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods (==) :: UpdateMaintenanceWindowTask -> UpdateMaintenanceWindowTask -> Bool # (/=) :: UpdateMaintenanceWindowTask -> UpdateMaintenanceWindowTask -> Bool #
Hashable UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods hashWithSalt :: Int -> UpdateMaintenanceWindowTask -> Int # hash :: UpdateMaintenanceWindowTask -> Int #
type AWSResponse UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask type AWSResponse UpdateMaintenanceWindowTask = UpdateMaintenanceWindowTaskResponse
type Rep UpdateMaintenanceWindowTask Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask type Rep UpdateMaintenanceWindowTask = D1 ('MetaData "UpdateMaintenanceWindowTask" "Amazonka.SSM.UpdateMaintenanceWindowTask" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateMaintenanceWindowTask'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :: S1 ('MetaSel ('Just "cutoffBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskCutoffBehavior))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "loggingInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingInfo)))) :: ((S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: (((S1 ('MetaSel ('Just "replace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "taskInvocationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskInvocationParameters)) :: S1 ('MetaSel ('Just "taskParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))))) :: (S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "windowTaskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateMaintenanceWindowTask Source #

Arguments

:: Text	`UpdateMaintenanceWindowTask`
-> Text	`UpdateMaintenanceWindowTask`
-> UpdateMaintenanceWindowTask

Create a value of UpdateMaintenanceWindowTask with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_alarmConfiguration - The CloudWatch alarm you want to apply to your maintenance window task.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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 CancelCommand 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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_description - The new task description to specify.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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 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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_name - The new task name to specify.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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.

$sel:replace:UpdateMaintenanceWindowTask', updateMaintenanceWindowTask_replace - If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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 your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_taskArn - The task ARN to modify.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_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 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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_taskParameters - The parameters to modify.

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.

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

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_windowId - The maintenance window ID that contains the task to modify.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTask_windowTaskId - The task ID to modify.

Request Lenses

updateMaintenanceWindowTask_alarmConfiguration :: Lens' UpdateMaintenanceWindowTask (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your maintenance window task.

updateMaintenanceWindowTask_cutoffBehavior :: Lens' UpdateMaintenanceWindowTask (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

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 CancelCommand 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.

updateMaintenanceWindowTask_description :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The new task description to specify.

updateMaintenanceWindowTask_loggingInfo :: Lens' UpdateMaintenanceWindowTask (Maybe LoggingInfo) Source #

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 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.

updateMaintenanceWindowTask_maxConcurrency :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

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.

updateMaintenanceWindowTask_maxErrors :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

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.

updateMaintenanceWindowTask_name :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The new task name to specify.

updateMaintenanceWindowTask_priority :: Lens' UpdateMaintenanceWindowTask (Maybe Natural) Source #

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

updateMaintenanceWindowTask_replace :: Lens' UpdateMaintenanceWindowTask (Maybe Bool) Source #

If True, then all fields that are required by the RegisterTaskWithMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.

updateMaintenanceWindowTask_serviceRoleArn :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

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 your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

updateMaintenanceWindowTask_targets :: Lens' UpdateMaintenanceWindowTask (Maybe [Target]) Source #

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.

updateMaintenanceWindowTask_taskArn :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #

The task ARN to modify.

updateMaintenanceWindowTask_taskInvocationParameters :: Lens' UpdateMaintenanceWindowTask (Maybe MaintenanceWindowTaskInvocationParameters) Source #

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 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.

updateMaintenanceWindowTask_taskParameters :: Lens' UpdateMaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

The parameters to modify.

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.

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

updateMaintenanceWindowTask_windowId :: Lens' UpdateMaintenanceWindowTask Text Source #

The maintenance window ID that contains the task to modify.

updateMaintenanceWindowTask_windowTaskId :: Lens' UpdateMaintenanceWindowTask Text Source #

The task ID to modify.

Destructuring the Response

data UpdateMaintenanceWindowTaskResponse Source #

See: newUpdateMaintenanceWindowTaskResponse smart constructor.

Constructors

UpdateMaintenanceWindowTaskResponse'

Fields

alarmConfiguration :: Maybe AlarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.
cutoffBehavior :: Maybe MaintenanceWindowTaskCutoffBehavior
The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
description :: Maybe (Sensitive Text)
The updated task description.
loggingInfo :: Maybe LoggingInfo
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.
maxConcurrency :: Maybe Text
The updated MaxConcurrency value.
maxErrors :: Maybe Text
The updated MaxErrors value.
name :: Maybe Text
The updated task name.
priority :: Maybe Natural
The updated priority value.
serviceRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
targets :: Maybe [Target]
The updated target values.
taskArn :: Maybe Text
The updated task ARN value.
taskInvocationParameters :: Maybe MaintenanceWindowTaskInvocationParameters
The updated parameter values.
taskParameters :: Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))
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.
windowId :: Maybe Text
The ID of the maintenance window that was updated.
windowTaskId :: Maybe Text
The task ID of the maintenance window that was updated.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateMaintenanceWindowTaskResponse Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Associated Types type Rep UpdateMaintenanceWindowTaskResponse :: Type -> Type # Methods from :: UpdateMaintenanceWindowTaskResponse -> Rep UpdateMaintenanceWindowTaskResponse x # to :: Rep UpdateMaintenanceWindowTaskResponse x -> UpdateMaintenanceWindowTaskResponse #
Show UpdateMaintenanceWindowTaskResponse Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods showsPrec :: Int -> UpdateMaintenanceWindowTaskResponse -> ShowS # show :: UpdateMaintenanceWindowTaskResponse -> String # showList :: [UpdateMaintenanceWindowTaskResponse] -> ShowS #
NFData UpdateMaintenanceWindowTaskResponse Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods rnf :: UpdateMaintenanceWindowTaskResponse -> () #
Eq UpdateMaintenanceWindowTaskResponse Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask Methods (==) :: UpdateMaintenanceWindowTaskResponse -> UpdateMaintenanceWindowTaskResponse -> Bool # (/=) :: UpdateMaintenanceWindowTaskResponse -> UpdateMaintenanceWindowTaskResponse -> Bool #
type Rep UpdateMaintenanceWindowTaskResponse Source #
Instance details Defined in Amazonka.SSM.UpdateMaintenanceWindowTask type Rep UpdateMaintenanceWindowTaskResponse = D1 ('MetaData "UpdateMaintenanceWindowTaskResponse" "Amazonka.SSM.UpdateMaintenanceWindowTask" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateMaintenanceWindowTaskResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :: S1 ('MetaSel ('Just "cutoffBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskCutoffBehavior))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "loggingInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingInfo)))) :: ((S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: (((S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target]))) :: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskInvocationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskInvocationParameters)))) :: ((S1 ('MetaSel ('Just "taskParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression))))) :: S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "windowTaskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateMaintenanceWindowTaskResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateMaintenanceWindowTaskResponse'`
-> UpdateMaintenanceWindowTaskResponse

Create a value of UpdateMaintenanceWindowTaskResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_alarmConfiguration - The details for the CloudWatch alarm you applied to your maintenance window task.

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

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_description - The updated task description.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_loggingInfo - 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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_maxConcurrency - The updated MaxConcurrency value.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_maxErrors - The updated MaxErrors value.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_name - The updated task name.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_priority - The updated priority value.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_serviceRoleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_targets - The updated target values.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_taskArn - The updated task ARN value.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_taskInvocationParameters - The updated parameter values.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_taskParameters - 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.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_windowId - The ID of the maintenance window that was updated.

UpdateMaintenanceWindowTask, updateMaintenanceWindowTaskResponse_windowTaskId - The task ID of the maintenance window that was updated.

$sel:httpStatus:UpdateMaintenanceWindowTaskResponse', updateMaintenanceWindowTaskResponse_httpStatus - The response's http status code.

Response Lenses

updateMaintenanceWindowTaskResponse_alarmConfiguration :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe AlarmConfiguration) Source #

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

updateMaintenanceWindowTaskResponse_cutoffBehavior :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

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

updateMaintenanceWindowTaskResponse_description :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task description.

updateMaintenanceWindowTaskResponse_loggingInfo :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe LoggingInfo) Source #

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.

updateMaintenanceWindowTaskResponse_maxConcurrency :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated MaxConcurrency value.

updateMaintenanceWindowTaskResponse_maxErrors :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated MaxErrors value.

updateMaintenanceWindowTaskResponse_name :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task name.

updateMaintenanceWindowTaskResponse_priority :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Natural) Source #

The updated priority value.

updateMaintenanceWindowTaskResponse_serviceRoleArn :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

updateMaintenanceWindowTaskResponse_targets :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe [Target]) Source #

The updated target values.

updateMaintenanceWindowTaskResponse_taskArn :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The updated task ARN value.

updateMaintenanceWindowTaskResponse_taskInvocationParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters) Source #

The updated parameter values.

updateMaintenanceWindowTaskResponse_taskParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

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.

updateMaintenanceWindowTaskResponse_windowId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The ID of the maintenance window that was updated.

updateMaintenanceWindowTaskResponse_windowTaskId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #

The task ID of the maintenance window that was updated.

updateMaintenanceWindowTaskResponse_httpStatus :: Lens' UpdateMaintenanceWindowTaskResponse Int Source #

The response's http status code.