AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the ListExecutions operation. 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.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
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.
Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public class ListExecutionsRequest : AmazonStepFunctionsRequest IAmazonWebServiceRequest
The ListExecutionsRequest type exposes the following members
Name | Description | |
---|---|---|
ListExecutionsRequest() |
Name | Type | Description | |
---|---|---|---|
MapRunArn | System.String |
Gets and sets the property MapRunArn.
The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.
If the
You can specify either a |
|
MaxResults | System.Int32 |
Gets and sets the property MaxResults.
The maximum number of results that are returned per call. You can use This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
|
NextToken | System.String |
Gets and sets the property NextToken.
If |
|
RedriveFilter | Amazon.StepFunctions.ExecutionRedriveFilter |
Gets and sets the property RedriveFilter. Sets a filter to list executions based on whether or not they have been redriven.
For a Distributed Map,
If you do not provide a
If you provide a state machine ARN in |
|
StateMachineArn | System.String |
Gets and sets the property StateMachineArn. The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a
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 |
|
StatusFilter | Amazon.StepFunctions.ExecutionStatus |
Gets and sets the property StatusFilter. If specified, only list the executions whose current execution status matches the given filter. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5