Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . stepfunctions ]

get-execution-history

Description

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-execution-history is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: events

Synopsis

  get-execution-history
--execution-arn <value>
[--reverse-order | --no-reverse-order]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--execution-arn (string)

The Amazon Resource Name (ARN) of the execution.

--reverse-order | --no-reverse-order (boolean)

Lists events in descending order of their timeStamp .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

events -> (list)

The list of events that occurred in the execution.

(structure)

Contains details about the events of an execution.

timestamp -> (timestamp)

The date the event occurred.

type -> (string)

The type of the event.

id -> (long)

The id of the event. Events are numbered sequentially, starting at one.

previousEventId -> (long)

The id of the previous event.

activityFailedEventDetails -> (structure)

Contains details about an activity which failed during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

activityScheduleFailedEventDetails -> (structure)

Contains details about an activity schedule event which failed during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

activityScheduledEventDetails -> (structure)

Contains details about an activity scheduled during an execution.

resource -> (string)

The Amazon Resource Name (ARN) of the scheduled activity.

input -> (string)

The JSON data input to the activity task.

timeoutInSeconds -> (long)

The maximum allowed duration of the activity task.

heartbeatInSeconds -> (long)

The maximum allowed duration between two heartbeats for the activity task.

activityStartedEventDetails -> (structure)

Contains details about the start of an activity during an execution.

workerName -> (string)

The name of the worker that the task is assigned to. These names are provided by the workers when calling get-activity-task .

activitySucceededEventDetails -> (structure)

Contains details about an activity which successfully terminated during an execution.

output -> (string)

The JSON data output by the activity task.

activityTimedOutEventDetails -> (structure)

Contains details about an activity timeout which occurred during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the timeout.

executionFailedEventDetails -> (structure)

Contains details about an execution failure event.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

executionStartedEventDetails -> (structure)

Contains details about the start of the execution.

input -> (string)

The JSON data input to the execution.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

executionSucceededEventDetails -> (structure)

Contains details about the successful termination of the execution.

output -> (string)

The JSON data output by the execution.

executionAbortedEventDetails -> (structure)

Contains details about an abort of an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

executionTimedOutEventDetails -> (structure)

Contains details about the execution timeout which occurred during the execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the timeout.

lambdaFunctionFailedEventDetails -> (structure)

Contains details about a lambda function which failed during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

lambdaFunctionScheduleFailedEventDetails -> (structure)

Contains details about a failed lambda function schedule event which occurred during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

lambdaFunctionScheduledEventDetails -> (structure)

Contains details about a lambda function scheduled during an execution.

resource -> (string)

The Amazon Resource Name (ARN) of the scheduled lambda function.

input -> (string)

The JSON data input to the lambda function.

timeoutInSeconds -> (long)

The maximum allowed duration of the lambda function.

lambdaFunctionStartFailedEventDetails -> (structure)

Contains details about a lambda function which failed to start during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the failure.

lambdaFunctionSucceededEventDetails -> (structure)

Contains details about a lambda function which terminated successfully during an execution.

output -> (string)

The JSON data output by the lambda function.

lambdaFunctionTimedOutEventDetails -> (structure)

Contains details about a lambda function timeout which occurred during an execution.

error -> (string)

The error code of the failure.

cause -> (string)

A more detailed explanation of the cause of the timeout.

stateEnteredEventDetails -> (structure)

Contains details about a state entered during an execution.

name -> (string)

The name of the state.

input -> (string)

The string that contains the JSON input data for the state.

stateExitedEventDetails -> (structure)

Contains details about an exit from a state during an execution.

name -> (string)

The name of the state.

A name must not contain:

  • whitespace
  • brackets `` { } [ ]``
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ , ; : /
  • control characters (U+0000-001F , U+007F-009F )

output -> (string)

The JSON output data of the state.

nextToken -> (string)

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.