Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow
action are required for this request. Optional fields that aren't specified are set to null.
- updateMaintenanceWindowTask :: Text -> Text -> UpdateMaintenanceWindowTask
- data UpdateMaintenanceWindowTask
- umwtServiceRoleARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtReplace :: Lens' UpdateMaintenanceWindowTask (Maybe Bool)
- umwtTaskParameters :: Lens' UpdateMaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- umwtPriority :: Lens' UpdateMaintenanceWindowTask (Maybe Natural)
- umwtTaskARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtMaxErrors :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtTaskInvocationParameters :: Lens' UpdateMaintenanceWindowTask (Maybe MaintenanceWindowTaskInvocationParameters)
- umwtName :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtTargets :: Lens' UpdateMaintenanceWindowTask [Target]
- umwtLoggingInfo :: Lens' UpdateMaintenanceWindowTask (Maybe LoggingInfo)
- umwtDescription :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtMaxConcurrency :: Lens' UpdateMaintenanceWindowTask (Maybe Text)
- umwtWindowId :: Lens' UpdateMaintenanceWindowTask Text
- umwtWindowTaskId :: Lens' UpdateMaintenanceWindowTask Text
- updateMaintenanceWindowTaskResponse :: Int -> UpdateMaintenanceWindowTaskResponse
- data UpdateMaintenanceWindowTaskResponse
- umwtrsServiceRoleARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsWindowTaskId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsTaskParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- umwtrsPriority :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Natural)
- umwtrsTaskARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsMaxErrors :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsTaskInvocationParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters)
- umwtrsName :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsTargets :: Lens' UpdateMaintenanceWindowTaskResponse [Target]
- umwtrsLoggingInfo :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe LoggingInfo)
- umwtrsDescription :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsMaxConcurrency :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsWindowId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)
- umwtrsResponseStatus :: Lens' UpdateMaintenanceWindowTaskResponse Int
Creating a Request
updateMaintenanceWindowTask Source #
Creates a value of UpdateMaintenanceWindowTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umwtServiceRoleARN
- The IAM service role ARN to modify. The system assumes this role during task execution.umwtReplace
- If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.umwtTaskParameters
- The parameters to modify. 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 charactersumwtPriority
- The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.umwtTaskARN
- The task ARN to modify.umwtMaxErrors
- The newMaxErrors
value to specify.MaxErrors
is the maximum number of errors that are allowed before the task stops being scheduled.umwtTaskInvocationParameters
- The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.umwtName
- The new task name to specify.umwtTargets
- The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.umwtLoggingInfo
- The new logging location in Amazon S3 to specify.umwtDescription
- The new task description to specify.umwtMaxConcurrency
- The newMaxConcurrency
value you want to specify.MaxConcurrency
is the number of targets that are allowed to run this task in parallel.umwtWindowId
- The Maintenance Window ID that contains the task to modify.umwtWindowTaskId
- The task ID to modify.
data UpdateMaintenanceWindowTask Source #
See: updateMaintenanceWindowTask
smart constructor.
Request Lenses
umwtServiceRoleARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #
The IAM service role ARN to modify. The system assumes this role during task execution.
umwtReplace :: Lens' UpdateMaintenanceWindowTask (Maybe Bool) Source #
If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
umwtTaskParameters :: Lens' UpdateMaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
The parameters to modify. 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
umwtPriority :: 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.
umwtTaskARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #
The task ARN to modify.
umwtMaxErrors :: 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.
umwtTaskInvocationParameters :: 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.
umwtTargets :: Lens' UpdateMaintenanceWindowTask [Target] Source #
The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
umwtLoggingInfo :: Lens' UpdateMaintenanceWindowTask (Maybe LoggingInfo) Source #
The new logging location in Amazon S3 to specify.
umwtDescription :: Lens' UpdateMaintenanceWindowTask (Maybe Text) Source #
The new task description to specify.
umwtMaxConcurrency :: 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.
umwtWindowId :: Lens' UpdateMaintenanceWindowTask Text Source #
The Maintenance Window ID that contains the task to modify.
umwtWindowTaskId :: Lens' UpdateMaintenanceWindowTask Text Source #
The task ID to modify.
Destructuring the Response
updateMaintenanceWindowTaskResponse Source #
Creates a value of UpdateMaintenanceWindowTaskResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umwtrsServiceRoleARN
- The updated service role ARN value.umwtrsWindowTaskId
- The task ID of the Maintenance Window that was updated.umwtrsTaskParameters
- The updated parameter values.umwtrsPriority
- The updated priority value.umwtrsTaskARN
- The updated task ARN value.umwtrsMaxErrors
- The updated MaxErrors value.umwtrsTaskInvocationParameters
- The updated parameter values.umwtrsName
- The updated task name.umwtrsTargets
- The updated target values.umwtrsLoggingInfo
- The updated logging information in Amazon S3.umwtrsDescription
- The updated task description.umwtrsMaxConcurrency
- The updated MaxConcurrency value.umwtrsWindowId
- The ID of the Maintenance Window that was updated.umwtrsResponseStatus
- -- | The response status code.
data UpdateMaintenanceWindowTaskResponse Source #
See: updateMaintenanceWindowTaskResponse
smart constructor.
Response Lenses
umwtrsServiceRoleARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated service role ARN value.
umwtrsWindowTaskId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The task ID of the Maintenance Window that was updated.
umwtrsTaskParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
The updated parameter values.
umwtrsPriority :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Natural) Source #
The updated priority value.
umwtrsTaskARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated task ARN value.
umwtrsMaxErrors :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated MaxErrors value.
umwtrsTaskInvocationParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters) Source #
The updated parameter values.
umwtrsName :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated task name.
umwtrsTargets :: Lens' UpdateMaintenanceWindowTaskResponse [Target] Source #
The updated target values.
umwtrsLoggingInfo :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe LoggingInfo) Source #
The updated logging information in Amazon S3.
umwtrsDescription :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated task description.
umwtrsMaxConcurrency :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The updated MaxConcurrency value.
umwtrsWindowId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text) Source #
The ID of the Maintenance Window that was updated.
umwtrsResponseStatus :: Lens' UpdateMaintenanceWindowTaskResponse Int Source #
- - | The response status code.