AWS Step Functions

List executions

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

List all executions of a state machine by specifying a state machine Amazon Resource Name (ARN).

Inputs

フィールド

種類

説明

region [required]

enum

default: us-east-1

stateMachineArn [required]

string

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

maxResults

number

The maximum number of results that are returned per call. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

default: 100

statusFilter

enum

If specified, only list the executions whose current execution status matches the given filter. Allowed enum values: RUNNING,SUCCEEDED,FAILED,TIMED_OUT,ABORTED

Outputs

Expand All

フィールド

種類

説明

executions [required]

[object]

The list of matching executions.

executionArn [required]

string

The Amazon Resource Name (ARN) that identifies the execution.

stateMachineArn [required]

string

The Amazon Resource Name (ARN) of the state machine that ran the execution.

name [required]

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 [required]

string

The current status of the execution.

startDate [required]

date-time

The date the execution started.

stopDate

date-time

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 the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.

itemCount

number

The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.

stateMachineVersionArn

string

The Amazon Resource Name (ARN) of the state machine version associated with the execution. If the state machine execution was started with an unqualified ARN, it returns null. If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.

stateMachineAliasArn

string

The Amazon Resource Name (ARN) of the state machine alias used to start an execution. If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

redriveCount

number

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.

redriveDate

date-time

The date the execution was last redriven.

amzRequestId [required]

string