Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StepFunctions.ListExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

This operation returns paginated results.

Synopsis

data ListExecutions = ListExecutions' {
- statusFilter :: Maybe ExecutionStatus
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- stateMachineArn :: Text
}
newListExecutions :: Text -> ListExecutions
listExecutions_statusFilter :: Lens' ListExecutions (Maybe ExecutionStatus)
listExecutions_nextToken :: Lens' ListExecutions (Maybe Text)
listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural)
listExecutions_stateMachineArn :: Lens' ListExecutions Text
data ListExecutionsResponse = ListExecutionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- executions :: [ExecutionListItem]
}
newListExecutionsResponse :: Int -> ListExecutionsResponse
listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text)
listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int
listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ExecutionListItem]

Creating a Request

data ListExecutions Source #

See: newListExecutions smart constructor.

Constructors

ListExecutions'

Fields

statusFilter :: Maybe ExecutionStatus
If specified, only list the executions whose current execution status matches the given filter.
nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
maxResults :: Maybe Natural
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
stateMachineArn :: Text
The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Instances

Instances details

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

newListExecutions Source #

Arguments

:: Text	`$sel:stateMachineArn:ListExecutions'`
-> ListExecutions

Create a value of ListExecutions 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:statusFilter:ListExecutions', listExecutions_statusFilter - If specified, only list the executions whose current execution status matches the given filter.

$sel:nextToken:ListExecutions', listExecutions_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:maxResults:ListExecutions', listExecutions_maxResults - The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

$sel:stateMachineArn:ListExecutions', listExecutions_stateMachineArn - The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Request Lenses

listExecutions_statusFilter :: Lens' ListExecutions (Maybe ExecutionStatus) Source #

If specified, only list the executions whose current execution status matches the given filter.

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural) Source #

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

listExecutions_stateMachineArn :: Lens' ListExecutions Text Source #

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Destructuring the Response

data ListExecutionsResponse Source #

See: newListExecutionsResponse smart constructor.

Constructors

ListExecutionsResponse'

Fields

nextToken :: Maybe Text
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
httpStatus :: Int
The response's http status code.
executions :: [ExecutionListItem]
The list of matching executions.

Instances

Instances details

Eq ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods (==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool # (/=) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool #
Read ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods readsPrec :: Int -> ReadS ListExecutionsResponse # readList :: ReadS [ListExecutionsResponse] # readPrec :: ReadPrec ListExecutionsResponse # readListPrec :: ReadPrec [ListExecutionsResponse] #
Show ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods showsPrec :: Int -> ListExecutionsResponse -> ShowS # show :: ListExecutionsResponse -> String # showList :: [ListExecutionsResponse] -> ShowS #
Generic ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Associated Types type Rep ListExecutionsResponse :: Type -> Type # Methods from :: ListExecutionsResponse -> Rep ListExecutionsResponse x # to :: Rep ListExecutionsResponse x -> ListExecutionsResponse #
NFData ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods rnf :: ListExecutionsResponse -> () #
type Rep ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.StepFunctions.ListExecutions" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "ListExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "executions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExecutionListItem]))))

newListExecutionsResponse Source #

Arguments

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

Create a value of ListExecutionsResponse 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:ListExecutions', listExecutionsResponse_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:httpStatus:ListExecutionsResponse', listExecutionsResponse_httpStatus - The response's http status code.

$sel:executions:ListExecutionsResponse', listExecutionsResponse_executions - The list of matching executions.

Response Lenses

listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listExecutionsResponse_httpStatus :: Lens' ListExecutionsResponse Int Source #

The response's http status code.

listExecutionsResponse_executions :: Lens' ListExecutionsResponse [ExecutionListItem] Source #

The list of matching executions.