Menu
AWS Step Functions
API Reference (API Version 2016-11-23)

ListExecutions

Lists the executions of a state machine that meet the filtering criteria.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Request Syntax

{
   "maxResults": number,
   "nextToken": "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.

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

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

Type: String

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

Required: No

stateMachineArn

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

Type: String

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

Required: Yes

statusFilter

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

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT | ABORTED

Required: No

Response Syntax

{
   "executions": [ 
      { 
         "executionArn": "string",
         "name": "string",
         "startDate": number,
         "stateMachineArn": "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

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

Type: String

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

Errors

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

InvalidArn

The provided Amazon Resource Name (ARN) is invalid.

HTTP Status Code: 400

InvalidToken

The provided token is invalid.

HTTP Status Code: 400

StateMachineDoesNotExist

The specified state machine does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: