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.StepFunctions.ListExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

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' {
- mapRunArn :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- stateMachineArn :: Maybe Text
- statusFilter :: Maybe ExecutionStatus
}
newListExecutions :: ListExecutions
listExecutions_mapRunArn :: Lens' ListExecutions (Maybe Text)
listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural)
listExecutions_nextToken :: Lens' ListExecutions (Maybe Text)
listExecutions_stateMachineArn :: Lens' ListExecutions (Maybe Text)
listExecutions_statusFilter :: Lens' ListExecutions (Maybe ExecutionStatus)
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

mapRunArn :: Maybe Text
The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
You can specify either a mapRunArn or a stateMachineArn, but not both.
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.
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.
stateMachineArn :: Maybe Text
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn or a stateMachineArn, but not both.
statusFilter :: Maybe ExecutionStatus
If specified, only list the executions whose current execution status matches the given filter.

Instances

Instances details

ToJSON ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods toJSON :: ListExecutions -> Value # toEncoding :: ListExecutions -> Encoding # toJSONList :: [ListExecutions] -> Value # toEncodingList :: [ListExecutions] -> Encoding #
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 #
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 :: (Service -> Service) -> ListExecutions -> Request ListExecutions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListExecutions))) #
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 #
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 #
NFData ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods rnf :: ListExecutions -> () #
Eq ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods (==) :: ListExecutions -> ListExecutions -> Bool # (/=) :: ListExecutions -> ListExecutions -> Bool #
Hashable ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods hashWithSalt :: Int -> ListExecutions -> Int # hash :: ListExecutions -> Int #
type AWSResponse ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions type AWSResponse ListExecutions = ListExecutionsResponse
type Rep ListExecutions Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.StepFunctions.ListExecutions" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mapRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus))))))

newListExecutions :: ListExecutions Source #

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:

ListExecutions, listExecutions_mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

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

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.

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

You can specify either a mapRunArn or a stateMachineArn, but not both.

$sel:statusFilter:ListExecutions', listExecutions_statusFilter - If specified, only list the executions whose current execution status matches the given filter.

Request Lenses

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

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

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_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_stateMachineArn :: Lens' ListExecutions (Maybe Text) Source #

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

You can specify either a mapRunArn or a stateMachineArn, but not both.

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

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

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

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 #
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 #
NFData ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods rnf :: ListExecutionsResponse -> () #
Eq ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions Methods (==) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool # (/=) :: ListExecutionsResponse -> ListExecutionsResponse -> Bool #
type Rep ListExecutionsResponse Source #
Instance details Defined in Amazonka.StepFunctions.ListExecutions type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.StepFunctions.ListExecutions" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" '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:

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.