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. Using this API action, you can also list all redriven executions.
See https://www.paws-r-sdk.com/docs/sfn_list_executions/ for full documentation.
sfn_list_executions(
stateMachineArn = NULL,
statusFilter = NULL,
maxResults = NULL,
nextToken = NULL,
mapRunArn = NULL,
redriveFilter = NULL
)
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.
You can also return a list of executions associated with a specific
alias
or
version,
by specifying an alias ARN or a version ARN in the stateMachineArn
parameter.
If specified, only list the executions whose current execution status matches the given filter.
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.
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.
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.
Sets a filter to list executions based on whether or not they have been redriven.
For a Distributed Map, redriveFilter
sets a filter to list child
workflow executions based on whether or not they have been redriven.
If you do not provide a redriveFilter
, Step Functions returns a list
of both redriven and non-redriven executions.
If you provide a state machine ARN in redriveFilter
, the API returns a
validation exception.