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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the details about a specific task run as part of a maintenance window execution.

Synopsis

Creating a Request

data GetMaintenanceWindowExecutionTask Source #

See: newGetMaintenanceWindowExecutionTask smart constructor.

Constructors

GetMaintenanceWindowExecutionTask'
Fields windowExecutionId :: Text The ID of the maintenance window execution that includes the task. taskId :: Text The ID of the specific task execution in the maintenance window task that should be retrieved.

Instances

Instances details

ToJSON GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods toJSON :: GetMaintenanceWindowExecutionTask -> Value # toEncoding :: GetMaintenanceWindowExecutionTask -> Encoding # toJSONList :: [GetMaintenanceWindowExecutionTask] -> Value # toEncodingList :: [GetMaintenanceWindowExecutionTask] -> Encoding #
ToHeaders GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods toHeaders :: GetMaintenanceWindowExecutionTask -> [Header] #
ToPath GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods toPath :: GetMaintenanceWindowExecutionTask -> ByteString #
ToQuery GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods toQuery :: GetMaintenanceWindowExecutionTask -> QueryString #
AWSRequest GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Associated Types type AWSResponse GetMaintenanceWindowExecutionTask # Methods request :: (Service -> Service) -> GetMaintenanceWindowExecutionTask -> Request GetMaintenanceWindowExecutionTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMaintenanceWindowExecutionTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMaintenanceWindowExecutionTask))) #
Generic GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Associated Types type Rep GetMaintenanceWindowExecutionTask :: Type -> Type # Methods from :: GetMaintenanceWindowExecutionTask -> Rep GetMaintenanceWindowExecutionTask x # to :: Rep GetMaintenanceWindowExecutionTask x -> GetMaintenanceWindowExecutionTask #
Read GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods readsPrec :: Int -> ReadS GetMaintenanceWindowExecutionTask # readList :: ReadS [GetMaintenanceWindowExecutionTask] # readPrec :: ReadPrec GetMaintenanceWindowExecutionTask # readListPrec :: ReadPrec [GetMaintenanceWindowExecutionTask] #
Show GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods showsPrec :: Int -> GetMaintenanceWindowExecutionTask -> ShowS # show :: GetMaintenanceWindowExecutionTask -> String # showList :: [GetMaintenanceWindowExecutionTask] -> ShowS #
NFData GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods rnf :: GetMaintenanceWindowExecutionTask -> () #
Eq GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods (==) :: GetMaintenanceWindowExecutionTask -> GetMaintenanceWindowExecutionTask -> Bool # (/=) :: GetMaintenanceWindowExecutionTask -> GetMaintenanceWindowExecutionTask -> Bool #
Hashable GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods hashWithSalt :: Int -> GetMaintenanceWindowExecutionTask -> Int # hash :: GetMaintenanceWindowExecutionTask -> Int #
type AWSResponse GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask type AWSResponse GetMaintenanceWindowExecutionTask = GetMaintenanceWindowExecutionTaskResponse
type Rep GetMaintenanceWindowExecutionTask Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask type Rep GetMaintenanceWindowExecutionTask = D1 ('MetaData "GetMaintenanceWindowExecutionTask" "Amazonka.SSM.GetMaintenanceWindowExecutionTask" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetMaintenanceWindowExecutionTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "windowExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetMaintenanceWindowExecutionTask Source #

Arguments

:: Text	`GetMaintenanceWindowExecutionTask`
-> Text	`$sel:taskId:GetMaintenanceWindowExecutionTask'`
-> GetMaintenanceWindowExecutionTask

Create a value of GetMaintenanceWindowExecutionTask 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:

GetMaintenanceWindowExecutionTask, getMaintenanceWindowExecutionTask_windowExecutionId - The ID of the maintenance window execution that includes the task.

$sel:taskId:GetMaintenanceWindowExecutionTask', getMaintenanceWindowExecutionTask_taskId - The ID of the specific task execution in the maintenance window task that should be retrieved.

Request Lenses

getMaintenanceWindowExecutionTask_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTask Text Source #

The ID of the maintenance window execution that includes the task.

getMaintenanceWindowExecutionTask_taskId :: Lens' GetMaintenanceWindowExecutionTask Text Source #

The ID of the specific task execution in the maintenance window task that should be retrieved.

Destructuring the Response

data GetMaintenanceWindowExecutionTaskResponse Source #

See: newGetMaintenanceWindowExecutionTaskResponse smart constructor.

Constructors

GetMaintenanceWindowExecutionTaskResponse'

Fields

alarmConfiguration :: Maybe AlarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.
endTime :: Maybe POSIX
The time the task execution completed.
maxConcurrency :: Maybe Text
The defined maximum number of task executions that could be run in parallel.
maxErrors :: Maybe Text
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
priority :: Maybe Natural
The priority of the task.
serviceRole :: Maybe Text
The role that was assumed when running the task.
startTime :: Maybe POSIX
The time the task execution started.
status :: Maybe MaintenanceWindowExecutionStatus
The status of the task.
statusDetails :: Maybe Text
The details explaining the status. Not available for all status values.
taskArn :: Maybe Text
The Amazon Resource Name (ARN) of the task that ran.
taskExecutionId :: Maybe Text
The ID of the specific task execution in the maintenance window task that was retrieved.
taskParameters :: Maybe (Sensitive [Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression))])
The parameters passed to the task when it was run.
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 between 1 and 255 characters
triggeredAlarms :: Maybe (NonEmpty AlarmStateInformation)
The CloudWatch alarms that were invoked by the maintenance window task.
type' :: Maybe MaintenanceWindowTaskType
The type of task that was run.
windowExecutionId :: Maybe Text
The ID of the maintenance window execution that includes the task.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetMaintenanceWindowExecutionTaskResponse Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Associated Types type Rep GetMaintenanceWindowExecutionTaskResponse :: Type -> Type # Methods from :: GetMaintenanceWindowExecutionTaskResponse -> Rep GetMaintenanceWindowExecutionTaskResponse x # to :: Rep GetMaintenanceWindowExecutionTaskResponse x -> GetMaintenanceWindowExecutionTaskResponse #
Show GetMaintenanceWindowExecutionTaskResponse Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods showsPrec :: Int -> GetMaintenanceWindowExecutionTaskResponse -> ShowS # show :: GetMaintenanceWindowExecutionTaskResponse -> String # showList :: [GetMaintenanceWindowExecutionTaskResponse] -> ShowS #
NFData GetMaintenanceWindowExecutionTaskResponse Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods rnf :: GetMaintenanceWindowExecutionTaskResponse -> () #
Eq GetMaintenanceWindowExecutionTaskResponse Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask Methods (==) :: GetMaintenanceWindowExecutionTaskResponse -> GetMaintenanceWindowExecutionTaskResponse -> Bool # (/=) :: GetMaintenanceWindowExecutionTaskResponse -> GetMaintenanceWindowExecutionTaskResponse -> Bool #
type Rep GetMaintenanceWindowExecutionTaskResponse Source #
Instance details Defined in Amazonka.SSM.GetMaintenanceWindowExecutionTask type Rep GetMaintenanceWindowExecutionTaskResponse = D1 ('MetaData "GetMaintenanceWindowExecutionTaskResponse" "Amazonka.SSM.GetMaintenanceWindowExecutionTask" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetMaintenanceWindowExecutionTaskResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowExecutionStatus))))) :: (((S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "taskExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive [Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression))]))))) :: ((S1 ('MetaSel ('Just "triggeredAlarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AlarmStateInformation))) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskType))) :: (S1 ('MetaSel ('Just "windowExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetMaintenanceWindowExecutionTaskResponse Source #

Arguments

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

Create a value of GetMaintenanceWindowExecutionTaskResponse 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:

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

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_endTime - The time the task execution completed.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_maxConcurrency - The defined maximum number of task executions that could be run in parallel.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_maxErrors - The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_priority - The priority of the task.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_serviceRole - The role that was assumed when running the task.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_startTime - The time the task execution started.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_status - The status of the task.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_statusDetails - The details explaining the status. Not available for all status values.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task that ran.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_taskExecutionId - The ID of the specific task execution in the maintenance window task that was retrieved.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_taskParameters - The parameters passed to the task when it was run.

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 between 1 and 255 characters

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_triggeredAlarms - The CloudWatch alarms that were invoked by the maintenance window task.

GetMaintenanceWindowExecutionTaskResponse, getMaintenanceWindowExecutionTaskResponse_type - The type of task that was run.

GetMaintenanceWindowExecutionTask, getMaintenanceWindowExecutionTaskResponse_windowExecutionId - The ID of the maintenance window execution that includes the task.

$sel:httpStatus:GetMaintenanceWindowExecutionTaskResponse', getMaintenanceWindowExecutionTaskResponse_httpStatus - The response's http status code.

Response Lenses

getMaintenanceWindowExecutionTaskResponse_alarmConfiguration :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe AlarmConfiguration) Source #

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

getMaintenanceWindowExecutionTaskResponse_endTime :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe UTCTime) Source #

The time the task execution completed.

getMaintenanceWindowExecutionTaskResponse_maxConcurrency :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The defined maximum number of task executions that could be run in parallel.

getMaintenanceWindowExecutionTaskResponse_maxErrors :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

getMaintenanceWindowExecutionTaskResponse_priority :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Natural) Source #

The priority of the task.

getMaintenanceWindowExecutionTaskResponse_serviceRole :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The role that was assumed when running the task.

getMaintenanceWindowExecutionTaskResponse_startTime :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe UTCTime) Source #

The time the task execution started.

getMaintenanceWindowExecutionTaskResponse_status :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe MaintenanceWindowExecutionStatus) Source #

The status of the task.

getMaintenanceWindowExecutionTaskResponse_statusDetails :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The details explaining the status. Not available for all status values.

getMaintenanceWindowExecutionTaskResponse_taskArn :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that ran.

getMaintenanceWindowExecutionTaskResponse_taskExecutionId :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The ID of the specific task execution in the maintenance window task that was retrieved.

getMaintenanceWindowExecutionTaskResponse_taskParameters :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe [HashMap Text MaintenanceWindowTaskParameterValueExpression]) Source #

The parameters passed to the task when it was run.

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 between 1 and 255 characters

getMaintenanceWindowExecutionTaskResponse_triggeredAlarms :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarms that were invoked by the maintenance window task.

getMaintenanceWindowExecutionTaskResponse_type :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe MaintenanceWindowTaskType) Source #

The type of task that was run.

getMaintenanceWindowExecutionTaskResponse_windowExecutionId :: Lens' GetMaintenanceWindowExecutionTaskResponse (Maybe Text) Source #

The ID of the maintenance window execution that includes the task.

getMaintenanceWindowExecutionTaskResponse_httpStatus :: Lens' GetMaintenanceWindowExecutionTaskResponse Int Source #

The response's http status code.