Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Adds a new task to a Maintenance Window.
- registerTaskWithMaintenanceWindow :: Text -> Text -> Text -> MaintenanceWindowTaskType -> Text -> Text -> RegisterTaskWithMaintenanceWindow
- data RegisterTaskWithMaintenanceWindow
- rtwmwTaskParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- rtwmwPriority :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Natural)
- rtwmwClientToken :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text)
- rtwmwLoggingInfo :: Lens' RegisterTaskWithMaintenanceWindow (Maybe LoggingInfo)
- rtwmwWindowId :: Lens' RegisterTaskWithMaintenanceWindow Text
- rtwmwTargets :: Lens' RegisterTaskWithMaintenanceWindow [Target]
- rtwmwTaskARN :: Lens' RegisterTaskWithMaintenanceWindow Text
- rtwmwServiceRoleARN :: Lens' RegisterTaskWithMaintenanceWindow Text
- rtwmwTaskType :: Lens' RegisterTaskWithMaintenanceWindow MaintenanceWindowTaskType
- rtwmwMaxConcurrency :: Lens' RegisterTaskWithMaintenanceWindow Text
- rtwmwMaxErrors :: Lens' RegisterTaskWithMaintenanceWindow Text
- registerTaskWithMaintenanceWindowResponse :: Int -> RegisterTaskWithMaintenanceWindowResponse
- data RegisterTaskWithMaintenanceWindowResponse
- rtwmwrsWindowTaskId :: Lens' RegisterTaskWithMaintenanceWindowResponse (Maybe Text)
- rtwmwrsResponseStatus :: Lens' RegisterTaskWithMaintenanceWindowResponse Int
Creating a Request
registerTaskWithMaintenanceWindow Source #
:: Text | |
-> Text | |
-> Text | |
-> MaintenanceWindowTaskType | |
-> Text | |
-> Text | |
-> RegisterTaskWithMaintenanceWindow |
Creates a value of RegisterTaskWithMaintenanceWindow
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtwmwTaskParameters
- The parameters that should be passed to the task when it is executed.rtwmwPriority
- The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.rtwmwClientToken
- User-provided idempotency token.rtwmwLoggingInfo
- A structure containing information about an Amazon S3 bucket to write instance-level logs to.rtwmwWindowId
- The id of the Maintenance Window the task should be added to.rtwmwTargets
- The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.rtwmwTaskARN
- The ARN of the task to executertwmwServiceRoleARN
- The role that should be assumed when executing the task.rtwmwTaskType
- The type of task being registered.rtwmwMaxConcurrency
- The maximum number of targets this task can be run for in parallel.rtwmwMaxErrors
- The maximum number of errors allowed before this task stops being scheduled.
data RegisterTaskWithMaintenanceWindow Source #
See: registerTaskWithMaintenanceWindow
smart constructor.
Request Lenses
rtwmwTaskParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
The parameters that should be passed to the task when it is executed.
rtwmwPriority :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Natural) Source #
The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
rtwmwClientToken :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #
User-provided idempotency token.
rtwmwLoggingInfo :: Lens' RegisterTaskWithMaintenanceWindow (Maybe LoggingInfo) Source #
A structure containing information about an Amazon S3 bucket to write instance-level logs to.
rtwmwWindowId :: Lens' RegisterTaskWithMaintenanceWindow Text Source #
The id of the Maintenance Window the task should be added to.
rtwmwTargets :: Lens' RegisterTaskWithMaintenanceWindow [Target] Source #
The targets (either instances or tags). Instances are specified using Key=instanceids,Values=instanceid1,instanceid2. Tags are specified using Key=name,Values=value.
rtwmwTaskARN :: Lens' RegisterTaskWithMaintenanceWindow Text Source #
The ARN of the task to execute
rtwmwServiceRoleARN :: Lens' RegisterTaskWithMaintenanceWindow Text Source #
The role that should be assumed when executing the task.
rtwmwTaskType :: Lens' RegisterTaskWithMaintenanceWindow MaintenanceWindowTaskType Source #
The type of task being registered.
rtwmwMaxConcurrency :: Lens' RegisterTaskWithMaintenanceWindow Text Source #
The maximum number of targets this task can be run for in parallel.
rtwmwMaxErrors :: Lens' RegisterTaskWithMaintenanceWindow Text Source #
The maximum number of errors allowed before this task stops being scheduled.
Destructuring the Response
registerTaskWithMaintenanceWindowResponse Source #
Creates a value of RegisterTaskWithMaintenanceWindowResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtwmwrsWindowTaskId
- The id of the task in the Maintenance Window.rtwmwrsResponseStatus
- -- | The response status code.
data RegisterTaskWithMaintenanceWindowResponse Source #
See: registerTaskWithMaintenanceWindowResponse
smart constructor.
Response Lenses
rtwmwrsWindowTaskId :: Lens' RegisterTaskWithMaintenanceWindowResponse (Maybe Text) Source #
The id of the task in the Maintenance Window.
rtwmwrsResponseStatus :: Lens' RegisterTaskWithMaintenanceWindowResponse Int Source #
- - | The response status code.