libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.DescribeAutomationStepExecutions

Description

Information about all active and terminated step executions in an Automation workflow.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeAutomationStepExecutions Source #

See: newDescribeAutomationStepExecutions smart constructor.

Constructors

DescribeAutomationStepExecutions' 

Fields

  • filters :: Maybe (NonEmpty StepExecutionFilter)

    One or more filters to limit the number of step executions returned by the request.

  • reverseOrder :: Maybe Bool

    Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

  • nextToken :: Maybe Text

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

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

  • automationExecutionId :: Text

    The Automation execution ID for which you want step execution descriptions.

Instances

Instances details
Eq DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

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

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

Read DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

readsPrec :: Int -> ReadS DescribeAutomationStepExecutions #

readList :: ReadS [DescribeAutomationStepExecutions] #

readPrec :: ReadPrec DescribeAutomationStepExecutions #

readListPrec :: ReadPrec [DescribeAutomationStepExecutions] #

Show DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

showsPrec :: Int -> DescribeAutomationStepExecutions -> ShowS #

show :: DescribeAutomationStepExecutions -> String #

showList :: [DescribeAutomationStepExecutions] -> ShowS #

Generic DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Associated Types

type Rep DescribeAutomationStepExecutions :: Type -> Type #

Methods

from :: DescribeAutomationStepExecutions -> Rep DescribeAutomationStepExecutions x #

to :: Rep DescribeAutomationStepExecutions x -> DescribeAutomationStepExecutions #

NFData DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

rnf :: DescribeAutomationStepExecutions -> () #

Hashable DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

hashWithSalt :: Int -> DescribeAutomationStepExecutions -> Int #

hash :: DescribeAutomationStepExecutions -> Int #

ToJSON DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

toJSON :: DescribeAutomationStepExecutions -> Value #

toEncoding :: DescribeAutomationStepExecutions -> Encoding #

toJSONList :: [DescribeAutomationStepExecutions] -> Value #

toEncodingList :: [DescribeAutomationStepExecutions] -> Encoding #

AWSPager DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

page :: DescribeAutomationStepExecutions -> AWSResponse DescribeAutomationStepExecutions -> Maybe DescribeAutomationStepExecutions #

AWSRequest DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Associated Types

type AWSResponse DescribeAutomationStepExecutions #

Methods

request :: DescribeAutomationStepExecutions -> Request DescribeAutomationStepExecutions #

response :: MonadResource m => Logger -> Service -> Proxy DescribeAutomationStepExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAutomationStepExecutions))) #

ToHeaders DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

toHeaders :: DescribeAutomationStepExecutions -> [Header] #

ToPath DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

toPath :: DescribeAutomationStepExecutions -> ByteString #

ToQuery DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

toQuery :: DescribeAutomationStepExecutions -> QueryString #

type Rep DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

type Rep DescribeAutomationStepExecutions = D1 ('MetaData "DescribeAutomationStepExecutions" "Amazonka.SSM.DescribeAutomationStepExecutions" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeAutomationStepExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty StepExecutionFilter))) :*: S1 ('MetaSel ('Just "reverseOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "automationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeAutomationStepExecutions Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

type AWSResponse DescribeAutomationStepExecutions = DescribeAutomationStepExecutionsResponse

newDescribeAutomationStepExecutions Source #

Arguments

:: Text

$sel:automationExecutionId:DescribeAutomationStepExecutions'

-> DescribeAutomationStepExecutions 

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

$sel:filters:DescribeAutomationStepExecutions', describeAutomationStepExecutions_filters - One or more filters to limit the number of step executions returned by the request.

$sel:reverseOrder:DescribeAutomationStepExecutions', describeAutomationStepExecutions_reverseOrder - Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

$sel:nextToken:DescribeAutomationStepExecutions', describeAutomationStepExecutions_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:maxResults:DescribeAutomationStepExecutions', describeAutomationStepExecutions_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.

$sel:automationExecutionId:DescribeAutomationStepExecutions', describeAutomationStepExecutions_automationExecutionId - The Automation execution ID for which you want step execution descriptions.

Request Lenses

describeAutomationStepExecutions_filters :: Lens' DescribeAutomationStepExecutions (Maybe (NonEmpty StepExecutionFilter)) Source #

One or more filters to limit the number of step executions returned by the request.

describeAutomationStepExecutions_reverseOrder :: Lens' DescribeAutomationStepExecutions (Maybe Bool) Source #

Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

describeAutomationStepExecutions_nextToken :: Lens' DescribeAutomationStepExecutions (Maybe Text) Source #

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

describeAutomationStepExecutions_maxResults :: Lens' DescribeAutomationStepExecutions (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.

describeAutomationStepExecutions_automationExecutionId :: Lens' DescribeAutomationStepExecutions Text Source #

The Automation execution ID for which you want step execution descriptions.

Destructuring the Response

data DescribeAutomationStepExecutionsResponse Source #

See: newDescribeAutomationStepExecutionsResponse smart constructor.

Constructors

DescribeAutomationStepExecutionsResponse' 

Fields

Instances

Instances details
Eq DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

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

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

Read DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

readsPrec :: Int -> ReadS DescribeAutomationStepExecutionsResponse #

readList :: ReadS [DescribeAutomationStepExecutionsResponse] #

readPrec :: ReadPrec DescribeAutomationStepExecutionsResponse #

readListPrec :: ReadPrec [DescribeAutomationStepExecutionsResponse] #

Show DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

showsPrec :: Int -> DescribeAutomationStepExecutionsResponse -> ShowS #

show :: DescribeAutomationStepExecutionsResponse -> String #

showList :: [DescribeAutomationStepExecutionsResponse] -> ShowS #

Generic DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Associated Types

type Rep DescribeAutomationStepExecutionsResponse :: Type -> Type #

Methods

from :: DescribeAutomationStepExecutionsResponse -> Rep DescribeAutomationStepExecutionsResponse x #

to :: Rep DescribeAutomationStepExecutionsResponse x -> DescribeAutomationStepExecutionsResponse #

NFData DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

Methods

rnf :: DescribeAutomationStepExecutionsResponse -> () #

type Rep DescribeAutomationStepExecutionsResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeAutomationStepExecutions

type Rep DescribeAutomationStepExecutionsResponse = D1 ('MetaData "DescribeAutomationStepExecutionsResponse" "Amazonka.SSM.DescribeAutomationStepExecutions" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeAutomationStepExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stepExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StepExecution])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAutomationStepExecutionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAutomationStepExecutionsResponse'

-> DescribeAutomationStepExecutionsResponse 

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

$sel:nextToken:DescribeAutomationStepExecutions', describeAutomationStepExecutionsResponse_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:stepExecutions:DescribeAutomationStepExecutionsResponse', describeAutomationStepExecutionsResponse_stepExecutions - A list of details about the current state of all steps that make up an execution.

$sel:httpStatus:DescribeAutomationStepExecutionsResponse', describeAutomationStepExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

describeAutomationStepExecutionsResponse_nextToken :: Lens' DescribeAutomationStepExecutionsResponse (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.

describeAutomationStepExecutionsResponse_stepExecutions :: Lens' DescribeAutomationStepExecutionsResponse (Maybe [StepExecution]) Source #

A list of details about the current state of all steps that make up an execution.

describeAutomationStepExecutionsResponse_httpStatus :: Lens' DescribeAutomationStepExecutionsResponse Int Source #

The response's http status code.