amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.DescribeMaintenanceWindowExecutions

Description

Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMaintenanceWindowExecutions Source #

See: newDescribeMaintenanceWindowExecutions smart constructor.

Constructors

DescribeMaintenanceWindowExecutions' 

Fields

  • filters :: Maybe [MaintenanceWindowFilter]

    Each entry in the array is a structure containing:

    • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
    • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.
  • 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.)

  • windowId :: Text

    The ID of the maintenance window whose executions should be retrieved.

Instances

Instances details
ToJSON DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

toJSON :: DescribeMaintenanceWindowExecutions -> Value #

toEncoding :: DescribeMaintenanceWindowExecutions -> Encoding #

toJSONList :: [DescribeMaintenanceWindowExecutions] -> Value #

toEncodingList :: [DescribeMaintenanceWindowExecutions] -> Encoding #

ToHeaders DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

toHeaders :: DescribeMaintenanceWindowExecutions -> [Header] #

ToPath DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

toPath :: DescribeMaintenanceWindowExecutions -> ByteString #

ToQuery DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

toQuery :: DescribeMaintenanceWindowExecutions -> QueryString #

AWSPager DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

page :: DescribeMaintenanceWindowExecutions -> AWSResponse DescribeMaintenanceWindowExecutions -> Maybe DescribeMaintenanceWindowExecutions #

AWSRequest DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Associated Types

type AWSResponse DescribeMaintenanceWindowExecutions #

Methods

request :: (Service -> Service) -> DescribeMaintenanceWindowExecutions -> Request DescribeMaintenanceWindowExecutions #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeMaintenanceWindowExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMaintenanceWindowExecutions))) #

Generic DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Associated Types

type Rep DescribeMaintenanceWindowExecutions :: Type -> Type #

Methods

from :: DescribeMaintenanceWindowExecutions -> Rep DescribeMaintenanceWindowExecutions x #

to :: Rep DescribeMaintenanceWindowExecutions x -> DescribeMaintenanceWindowExecutions #

Read DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

readsPrec :: Int -> ReadS DescribeMaintenanceWindowExecutions #

readList :: ReadS [DescribeMaintenanceWindowExecutions] #

readPrec :: ReadPrec DescribeMaintenanceWindowExecutions #

readListPrec :: ReadPrec [DescribeMaintenanceWindowExecutions] #

Show DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

showsPrec :: Int -> DescribeMaintenanceWindowExecutions -> ShowS #

show :: DescribeMaintenanceWindowExecutions -> String #

showList :: [DescribeMaintenanceWindowExecutions] -> ShowS #

NFData DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

rnf :: DescribeMaintenanceWindowExecutions -> () #

Eq DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

(==) :: DescribeMaintenanceWindowExecutions -> DescribeMaintenanceWindowExecutions -> Bool #

(/=) :: DescribeMaintenanceWindowExecutions -> DescribeMaintenanceWindowExecutions -> Bool #

Hashable DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

hashWithSalt :: Int -> DescribeMaintenanceWindowExecutions -> Int #

hash :: DescribeMaintenanceWindowExecutions -> Int #

type AWSResponse DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

type AWSResponse DescribeMaintenanceWindowExecutions = DescribeMaintenanceWindowExecutionsResponse
type Rep DescribeMaintenanceWindowExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

type Rep DescribeMaintenanceWindowExecutions = D1 ('MetaData "DescribeMaintenanceWindowExecutions" "Amazonka.SSM.DescribeMaintenanceWindowExecutions" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowExecutions'" '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 "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeMaintenanceWindowExecutions Source #

Arguments

:: Text

DescribeMaintenanceWindowExecutions

-> DescribeMaintenanceWindowExecutions 

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

DescribeMaintenanceWindowExecutions, describeMaintenanceWindowExecutions_filters - Each entry in the array is a structure containing:

  • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
  • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.

$sel:maxResults:DescribeMaintenanceWindowExecutions', describeMaintenanceWindowExecutions_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.

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

DescribeMaintenanceWindowExecutions, describeMaintenanceWindowExecutions_windowId - The ID of the maintenance window whose executions should be retrieved.

Request Lenses

describeMaintenanceWindowExecutions_filters :: Lens' DescribeMaintenanceWindowExecutions (Maybe [MaintenanceWindowFilter]) Source #

Each entry in the array is a structure containing:

  • Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter.
  • Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2021-11-04T05:00:00Z.

describeMaintenanceWindowExecutions_maxResults :: Lens' DescribeMaintenanceWindowExecutions (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.

describeMaintenanceWindowExecutions_nextToken :: Lens' DescribeMaintenanceWindowExecutions (Maybe Text) Source #

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

describeMaintenanceWindowExecutions_windowId :: Lens' DescribeMaintenanceWindowExecutions Text Source #

The ID of the maintenance window whose executions should be retrieved.

Destructuring the Response

data DescribeMaintenanceWindowExecutionsResponse Source #

See: newDescribeMaintenanceWindowExecutionsResponse smart constructor.

Constructors

DescribeMaintenanceWindowExecutionsResponse' 

Fields

Instances

Instances details
Generic DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Associated Types

type Rep DescribeMaintenanceWindowExecutionsResponse :: Type -> Type #

Methods

from :: DescribeMaintenanceWindowExecutionsResponse -> Rep DescribeMaintenanceWindowExecutionsResponse x #

to :: Rep DescribeMaintenanceWindowExecutionsResponse x -> DescribeMaintenanceWindowExecutionsResponse #

Read DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

readsPrec :: Int -> ReadS DescribeMaintenanceWindowExecutionsResponse #

readList :: ReadS [DescribeMaintenanceWindowExecutionsResponse] #

readPrec :: ReadPrec DescribeMaintenanceWindowExecutionsResponse #

readListPrec :: ReadPrec [DescribeMaintenanceWindowExecutionsResponse] #

Show DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

showsPrec :: Int -> DescribeMaintenanceWindowExecutionsResponse -> ShowS #

show :: DescribeMaintenanceWindowExecutionsResponse -> String #

showList :: [DescribeMaintenanceWindowExecutionsResponse] -> ShowS #

NFData DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

rnf :: DescribeMaintenanceWindowExecutionsResponse -> () #

Eq DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

Methods

(==) :: DescribeMaintenanceWindowExecutionsResponse -> DescribeMaintenanceWindowExecutionsResponse -> Bool #

(/=) :: DescribeMaintenanceWindowExecutionsResponse -> DescribeMaintenanceWindowExecutionsResponse -> Bool #

type Rep DescribeMaintenanceWindowExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowExecutions

type Rep DescribeMaintenanceWindowExecutionsResponse = D1 ('MetaData "DescribeMaintenanceWindowExecutionsResponse" "Amazonka.SSM.DescribeMaintenanceWindowExecutions" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "windowExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MaintenanceWindowExecution])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeMaintenanceWindowExecutionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeMaintenanceWindowExecutionsResponse'

-> DescribeMaintenanceWindowExecutionsResponse 

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

DescribeMaintenanceWindowExecutions, describeMaintenanceWindowExecutionsResponse_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:windowExecutions:DescribeMaintenanceWindowExecutionsResponse', describeMaintenanceWindowExecutionsResponse_windowExecutions - Information about the maintenance window executions.

$sel:httpStatus:DescribeMaintenanceWindowExecutionsResponse', describeMaintenanceWindowExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

describeMaintenanceWindowExecutionsResponse_nextToken :: Lens' DescribeMaintenanceWindowExecutionsResponse (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.

describeMaintenanceWindowExecutionsResponse_windowExecutions :: Lens' DescribeMaintenanceWindowExecutionsResponse (Maybe [MaintenanceWindowExecution]) Source #

Information about the maintenance window executions.

describeMaintenanceWindowExecutionsResponse_httpStatus :: Lens' DescribeMaintenanceWindowExecutionsResponse Int Source #

The response's http status code.