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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMaintenanceWindowExecutionTaskInvocations Source #

See: newDescribeMaintenanceWindowExecutionTaskInvocations smart constructor.

Constructors

DescribeMaintenanceWindowExecutionTaskInvocations'

Fields

filters :: Maybe [MaintenanceWindowFilter]
Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
maxResults :: Maybe Natural
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
windowExecutionId :: Text
The ID of the maintenance window execution the task is part of.
taskId :: Text
The ID of the specific task in the maintenance window task that should be retrieved.

Instances

Instances details

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

newDescribeMaintenanceWindowExecutionTaskInvocations Source #

Arguments

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

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

DescribeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTaskInvocations_filters - Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

$sel:maxResults:DescribeMaintenanceWindowExecutionTaskInvocations', describeMaintenanceWindowExecutionTaskInvocations_maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

DescribeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTaskInvocations_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

DescribeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTaskInvocations_windowExecutionId - The ID of the maintenance window execution the task is part of.

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

Request Lenses

describeMaintenanceWindowExecutionTaskInvocations_filters :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe [MaintenanceWindowFilter]) Source #

Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

describeMaintenanceWindowExecutionTaskInvocations_maxResults :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe Natural) Source #

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

describeMaintenanceWindowExecutionTaskInvocations_nextToken :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

describeMaintenanceWindowExecutionTaskInvocations_windowExecutionId :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations Text Source #

The ID of the maintenance window execution the task is part of.

describeMaintenanceWindowExecutionTaskInvocations_taskId :: Lens' DescribeMaintenanceWindowExecutionTaskInvocations Text Source #

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

Destructuring the Response

data DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #

See: newDescribeMaintenanceWindowExecutionTaskInvocationsResponse smart constructor.

Constructors

DescribeMaintenanceWindowExecutionTaskInvocationsResponse'
Fields nextToken :: Maybe Text The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. windowExecutionTaskInvocationIdentities :: Maybe [MaintenanceWindowExecutionTaskInvocationIdentity] Information about the task invocation results per invocation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations Associated Types type Rep DescribeMaintenanceWindowExecutionTaskInvocationsResponse :: Type -> Type # Methods from :: DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> Rep DescribeMaintenanceWindowExecutionTaskInvocationsResponse x # to :: Rep DescribeMaintenanceWindowExecutionTaskInvocationsResponse x -> DescribeMaintenanceWindowExecutionTaskInvocationsResponse #
Show DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations Methods showsPrec :: Int -> DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> ShowS # show :: DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> String # showList :: [DescribeMaintenanceWindowExecutionTaskInvocationsResponse] -> ShowS #
NFData DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations Methods rnf :: DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> () #
Eq DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations Methods (==) :: DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> Bool # (/=) :: DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> DescribeMaintenanceWindowExecutionTaskInvocationsResponse -> Bool #
type Rep DescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations type Rep DescribeMaintenanceWindowExecutionTaskInvocationsResponse = D1 ('MetaData "DescribeMaintenanceWindowExecutionTaskInvocationsResponse" "Amazonka.SSM.DescribeMaintenanceWindowExecutionTaskInvocations" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowExecutionTaskInvocationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "windowExecutionTaskInvocationIdentities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MaintenanceWindowExecutionTaskInvocationIdentity])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeMaintenanceWindowExecutionTaskInvocationsResponse Source #

Arguments

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

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

DescribeMaintenanceWindowExecutionTaskInvocations, describeMaintenanceWindowExecutionTaskInvocationsResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:windowExecutionTaskInvocationIdentities:DescribeMaintenanceWindowExecutionTaskInvocationsResponse', describeMaintenanceWindowExecutionTaskInvocationsResponse_windowExecutionTaskInvocationIdentities - Information about the task invocation results per invocation.

$sel:httpStatus:DescribeMaintenanceWindowExecutionTaskInvocationsResponse', describeMaintenanceWindowExecutionTaskInvocationsResponse_httpStatus - The response's http status code.

Response Lenses

describeMaintenanceWindowExecutionTaskInvocationsResponse_nextToken :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

describeMaintenanceWindowExecutionTaskInvocationsResponse_windowExecutionTaskInvocationIdentities :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse (Maybe [MaintenanceWindowExecutionTaskInvocationIdentity]) Source #

Information about the task invocation results per invocation.

describeMaintenanceWindowExecutionTaskInvocationsResponse_httpStatus :: Lens' DescribeMaintenanceWindowExecutionTaskInvocationsResponse Int Source #

The response's http status code.