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 |
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't
supply values for --max-errors
and --max-concurrency
. Instead, the
system inserts a placeholder value of 1
, which may be reported in the
response to this command. These values don't affect the running of your
task and can be ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
Synopsis
- data GetMaintenanceWindowTask = GetMaintenanceWindowTask' {
- windowId :: Text
- windowTaskId :: Text
- newGetMaintenanceWindowTask :: Text -> Text -> GetMaintenanceWindowTask
- getMaintenanceWindowTask_windowId :: Lens' GetMaintenanceWindowTask Text
- getMaintenanceWindowTask_windowTaskId :: Lens' GetMaintenanceWindowTask Text
- data GetMaintenanceWindowTaskResponse = GetMaintenanceWindowTaskResponse' {
- alarmConfiguration :: Maybe AlarmConfiguration
- cutoffBehavior :: Maybe MaintenanceWindowTaskCutoffBehavior
- description :: Maybe (Sensitive Text)
- loggingInfo :: Maybe LoggingInfo
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- name :: Maybe Text
- priority :: Maybe Natural
- serviceRoleArn :: Maybe Text
- targets :: Maybe [Target]
- taskArn :: Maybe Text
- taskInvocationParameters :: Maybe MaintenanceWindowTaskInvocationParameters
- taskParameters :: Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))
- taskType :: Maybe MaintenanceWindowTaskType
- windowId :: Maybe Text
- windowTaskId :: Maybe Text
- httpStatus :: Int
- newGetMaintenanceWindowTaskResponse :: Int -> GetMaintenanceWindowTaskResponse
- getMaintenanceWindowTaskResponse_alarmConfiguration :: Lens' GetMaintenanceWindowTaskResponse (Maybe AlarmConfiguration)
- getMaintenanceWindowTaskResponse_cutoffBehavior :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskCutoffBehavior)
- getMaintenanceWindowTaskResponse_description :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_loggingInfo :: Lens' GetMaintenanceWindowTaskResponse (Maybe LoggingInfo)
- getMaintenanceWindowTaskResponse_maxConcurrency :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_maxErrors :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_name :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_priority :: Lens' GetMaintenanceWindowTaskResponse (Maybe Natural)
- getMaintenanceWindowTaskResponse_serviceRoleArn :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_targets :: Lens' GetMaintenanceWindowTaskResponse (Maybe [Target])
- getMaintenanceWindowTaskResponse_taskArn :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_taskInvocationParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters)
- getMaintenanceWindowTaskResponse_taskParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))
- getMaintenanceWindowTaskResponse_taskType :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskType)
- getMaintenanceWindowTaskResponse_windowId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_windowTaskId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text)
- getMaintenanceWindowTaskResponse_httpStatus :: Lens' GetMaintenanceWindowTaskResponse Int
Creating a Request
data GetMaintenanceWindowTask Source #
See: newGetMaintenanceWindowTask
smart constructor.
GetMaintenanceWindowTask' | |
|
Instances
newGetMaintenanceWindowTask Source #
Create a value of GetMaintenanceWindowTask
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:
GetMaintenanceWindowTask
, getMaintenanceWindowTask_windowId
- The maintenance window ID that includes the task to retrieve.
GetMaintenanceWindowTask
, getMaintenanceWindowTask_windowTaskId
- The maintenance window task ID to retrieve.
Request Lenses
getMaintenanceWindowTask_windowId :: Lens' GetMaintenanceWindowTask Text Source #
The maintenance window ID that includes the task to retrieve.
getMaintenanceWindowTask_windowTaskId :: Lens' GetMaintenanceWindowTask Text Source #
The maintenance window task ID to retrieve.
Destructuring the Response
data GetMaintenanceWindowTaskResponse Source #
See: newGetMaintenanceWindowTaskResponse
smart constructor.
GetMaintenanceWindowTaskResponse' | |
|
Instances
newGetMaintenanceWindowTaskResponse Source #
Create a value of GetMaintenanceWindowTaskResponse
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:
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_alarmConfiguration
- The details for the CloudWatch alarm you applied to your maintenance
window task.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_cutoffBehavior
- The action to take on tasks when the maintenance window cutoff time is
reached. CONTINUE_TASK
means that tasks continue to run. For
Automation, Lambda, Step Functions tasks, CANCEL_TASK
means that
currently running task invocations continue, but no new task invocations
are started. For Run Command tasks, CANCEL_TASK
means the system
attempts to stop the task by sending a CancelCommand
operation.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_description
- The retrieved task description.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_loggingInfo
- The location in Amazon Simple Storage Service (Amazon S3) where the task
results are logged.
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.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_maxConcurrency
- The maximum number of targets allowed to run this task in parallel.
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
, which may be reported in the response to this
command. This value doesn't affect the running of your task and can be
ignored.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_maxErrors
- The maximum number of errors allowed before the task stops being
scheduled.
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
, which may be reported in the response to this
command. This value doesn't affect the running of your task and can be
ignored.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_name
- The retrieved task name.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_priority
- The priority of the task when it runs. The lower the number, the higher
the priority. Tasks that have the same priority are scheduled in
parallel.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_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.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_targets
- The targets where the task should run.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_taskArn
- The resource that the task used during execution. For RUN_COMMAND
and
AUTOMATION
task types, the value of TaskArn
is the SSM document
name/ARN. For LAMBDA
tasks, the value is the function name/ARN. For
STEP_FUNCTIONS
tasks, the value is the state machine ARN.
$sel:taskInvocationParameters:GetMaintenanceWindowTaskResponse'
, getMaintenanceWindowTaskResponse_taskInvocationParameters
- The parameters to pass to the task when it runs.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_taskParameters
- The parameters to pass to the task when it runs.
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.
GetMaintenanceWindowTaskResponse
, getMaintenanceWindowTaskResponse_taskType
- The type of task to run.
GetMaintenanceWindowTask
, getMaintenanceWindowTaskResponse_windowId
- The retrieved maintenance window ID.
GetMaintenanceWindowTask
, getMaintenanceWindowTaskResponse_windowTaskId
- The retrieved maintenance window task ID.
$sel:httpStatus:GetMaintenanceWindowTaskResponse'
, getMaintenanceWindowTaskResponse_httpStatus
- The response's http status code.
Response Lenses
getMaintenanceWindowTaskResponse_alarmConfiguration :: Lens' GetMaintenanceWindowTaskResponse (Maybe AlarmConfiguration) Source #
The details for the CloudWatch alarm you applied to your maintenance window task.
getMaintenanceWindowTaskResponse_cutoffBehavior :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskCutoffBehavior) Source #
The action to take on tasks when the maintenance window cutoff time is
reached. CONTINUE_TASK
means that tasks continue to run. For
Automation, Lambda, Step Functions tasks, CANCEL_TASK
means that
currently running task invocations continue, but no new task invocations
are started. For Run Command tasks, CANCEL_TASK
means the system
attempts to stop the task by sending a CancelCommand
operation.
getMaintenanceWindowTaskResponse_description :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The retrieved task description.
getMaintenanceWindowTaskResponse_loggingInfo :: Lens' GetMaintenanceWindowTaskResponse (Maybe LoggingInfo) Source #
The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.
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.
getMaintenanceWindowTaskResponse_maxConcurrency :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The maximum number of targets allowed to run this task in parallel.
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
, which may be reported in the response to this
command. This value doesn't affect the running of your task and can be
ignored.
getMaintenanceWindowTaskResponse_maxErrors :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The maximum number of errors allowed before the task stops being scheduled.
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
, which may be reported in the response to this
command. This value doesn't affect the running of your task and can be
ignored.
getMaintenanceWindowTaskResponse_name :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The retrieved task name.
getMaintenanceWindowTaskResponse_priority :: Lens' GetMaintenanceWindowTaskResponse (Maybe Natural) Source #
The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
getMaintenanceWindowTaskResponse_serviceRoleArn :: Lens' GetMaintenanceWindowTaskResponse (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.
getMaintenanceWindowTaskResponse_targets :: Lens' GetMaintenanceWindowTaskResponse (Maybe [Target]) Source #
The targets where the task should run.
getMaintenanceWindowTaskResponse_taskArn :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The resource that the task used during execution. For RUN_COMMAND
and
AUTOMATION
task types, the value of TaskArn
is the SSM document
name/ARN. For LAMBDA
tasks, the value is the function name/ARN. For
STEP_FUNCTIONS
tasks, the value is the state machine ARN.
getMaintenanceWindowTaskResponse_taskInvocationParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters) Source #
The parameters to pass to the task when it runs.
getMaintenanceWindowTaskResponse_taskParameters :: Lens' GetMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #
The parameters to pass to the task when it runs.
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.
getMaintenanceWindowTaskResponse_taskType :: Lens' GetMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskType) Source #
The type of task to run.
getMaintenanceWindowTaskResponse_windowId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The retrieved maintenance window ID.
getMaintenanceWindowTaskResponse_windowTaskId :: Lens' GetMaintenanceWindowTaskResponse (Maybe Text) Source #
The retrieved maintenance window task ID.
getMaintenanceWindowTaskResponse_httpStatus :: Lens' GetMaintenanceWindowTaskResponse Int Source #
The response's http status code.