SFN / Paginator / ListExecutions
ListExecutions#
- class SFN.Paginator.ListExecutions#
paginator = client.get_paginator('list_executions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SFN.Client.list_executions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( stateMachineArn='string', statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED', mapRunArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
stateMachineArn (string) –
The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a
mapRunArn
or astateMachineArn
, but not both.statusFilter (string) – If specified, only list the executions whose current execution status matches the given filter.
mapRunArn (string) –
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 astateMachineArn
, but not both.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'executions': [ { 'executionArn': 'string', 'stateMachineArn': 'string', 'name': 'string', 'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED', 'startDate': datetime(2015, 1, 1), 'stopDate': datetime(2015, 1, 1), 'mapRunArn': 'string', 'itemCount': 123 }, ], 'NextToken': 'string' }
Response Structure
(dict) –
executions (list) –
The list of matching executions.
(dict) –
Contains details about an execution.
executionArn (string) –
The Amazon Resource Name (ARN) that identifies the execution.
stateMachineArn (string) –
The Amazon Resource Name (ARN) of the executed state machine.
name (string) –
The name of the execution.
A name must not contain:
white space
brackets
< > { } [ ]
wildcard characters
? *
special characters
" # % \ ^ | ~ ` $ & , ; : /
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
status (string) –
The current status of the execution.
startDate (datetime) –
The date the execution started.
stopDate (datetime) –
If the execution already ended, the date the execution stopped.
mapRunArn (string) –
The Amazon Resource Name (ARN) of a Map Run. This field is returned only if
mapRunArn
was specified in theListExecutions
API action. IfstateMachineArn
was specified inListExecutions
, themapRunArn
isn’t returned.itemCount (integer) –
The total number of items processed in a child workflow execution. This field is returned only if
mapRunArn
was specified in theListExecutions
API action. IfstateMachineArn
was specified inListExecutions
, theitemCount
field isn’t returned.
NextToken (string) –
A token to resume pagination.