Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListExecutions

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.

Note

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.

Request Syntax


{
   "mapRunArn": "string",
   "maxResults": number,
   "nextToken": "string",
   "redriveFilter": "string",
   "stateMachineArn": "string",
   "statusFilter": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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 AWS Step Functions Developer Guide.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 3096.

Required: No

redriveFilter

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.

Type: String

Valid Values: REDRIVEN | NOT_REDRIVEN

Required: No

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.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

statusFilter

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

If you provide a PENDING_REDRIVE statusFilter, you must specify mapRunArn. For more information, see Child workflow execution redrive behaviour in the AWS Step Functions Developer Guide.

If you provide a stateMachineArn and a PENDING_REDRIVE statusFilter, the API returns a validation exception.

Type: String

Required: No

Response Syntax


{
   "executions": [ 
      { 
         "executionArn": "string",
         "itemCount": number,
         "mapRunArn": "string",
         "name": "string",
         "redriveCount": number,
         "redriveDate": number,
         "startDate": number,
         "stateMachineAliasArn": "string",
         "stateMachineArn": "string",
         "stateMachineVersionArn": "string",
         "status": "string",
         "stopDate": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

executions

The list of matching executions.

Type: Array of ExecutionListItem objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 3096.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArn

The provided Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

InvalidToken

The provided token is not valid.

HTTP Status Code: 400

ResourceNotFound

Could not find the referenced resource.

HTTP Status Code: 400

StateMachineDoesNotExist

The specified state machine does not exist.

HTTP Status Code: 400

StateMachineTypeNotSupported

State machine type is not supported.

HTTP Status Code: 400

ValidationException

The input does not satisfy the constraints specified by an AWS service.

reason: The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400