Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lambda ]

get-durable-execution-history

Description

Retrieves the execution history for a durable execution , showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution’s progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

See also: AWS API Documentation

get-durable-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-durable-execution-history
--durable-execution-arn <value>
[--include-execution-data | --no-include-execution-data]
[--max-items <value>]
[--reverse-order | --no-reverse-order]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--durable-execution-arn (string)

The Amazon Resource Name (ARN) of the durable execution.

--include-execution-data | --no-include-execution-data (boolean)

Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true .

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

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

When set to true , returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Events -> (list)

An array of execution history events, ordered chronologically unless ReverseOrder is set to true . Each event represents a significant occurrence during the execution, such as step completion or callback resolution.

(structure)

An event that occurred during the execution of a durable function.

EventType -> (string)

The type of event that occurred.

SubType -> (string)

The subtype of the event, providing additional categorization.

EventId -> (integer)

The unique identifier for this event. Event IDs increment sequentially.

Id -> (string)

The unique identifier for this operation.

Name -> (string)

The customer-provided name for this operation.

EventTimestamp -> (timestamp)

The date and time when this event occurred, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

ParentId -> (string)

The unique identifier of the parent operation, if this operation is running within a child context.

ExecutionStartedDetails -> (structure)

Details about an execution that started.

Input -> (structure)

The input payload provided for the durable execution.

Payload -> (string)

The input payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ExecutionTimeout -> (integer)

The maximum amount of time that the durable execution is allowed to run, in seconds.

ExecutionSucceededDetails -> (structure)

Details about an execution that succeeded.

Result -> (structure)

The response payload from the successful operation.

Payload -> (string)

The result payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ExecutionFailedDetails -> (structure)

Details about an execution that failed.

Error -> (structure)

Details about the execution failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ExecutionTimedOutDetails -> (structure)

Details about an execution that timed out.

Error -> (structure)

Details about the execution timeout.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ExecutionStoppedDetails -> (structure)

Details about an execution that was stopped.

Error -> (structure)

Details about why the execution stopped.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ContextStartedDetails -> (structure)

Details about a context that started.

ContextSucceededDetails -> (structure)

Details about a context that succeeded.

Result -> (structure)

The JSON response payload from the successful context.

Payload -> (string)

The result payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ContextFailedDetails -> (structure)

Details about a context that failed.

Error -> (structure)

Details about the context failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

WaitStartedDetails -> (structure)

Details about a wait operation that started.

Duration -> (integer)

The duration to wait, in seconds.

ScheduledEndTimestamp -> (timestamp)

The date and time when the wait operation is scheduled to complete, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

WaitSucceededDetails -> (structure)

Details about a wait operation that succeeded.

Duration -> (integer)

The wait duration, in seconds.

WaitCancelledDetails -> (structure)

Details about a wait operation that was cancelled.

Error -> (structure)

Details about why the wait operation was cancelled.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

StepStartedDetails -> (structure)

Details about a step that started.

StepSucceededDetails -> (structure)

Details about a step that succeeded.

Result -> (structure)

The response payload from the successful operation.

Payload -> (string)

The result payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

RetryDetails -> (structure)

Information about retry attempts for this step operation.

CurrentAttempt -> (integer)

The current attempt number for this operation.

NextAttemptDelaySeconds -> (integer)

The delay before the next retry attempt, in seconds.

StepFailedDetails -> (structure)

Details about a step that failed.

Error -> (structure)

Details about the step failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

RetryDetails -> (structure)

Information about retry attempts for this step operation.

CurrentAttempt -> (integer)

The current attempt number for this operation.

NextAttemptDelaySeconds -> (integer)

The delay before the next retry attempt, in seconds.

ChainedInvokeStartedDetails -> (structure)

Contains details about a chained function invocation that has started execution, including start time and execution context.

FunctionName -> (string)

The name or ARN of the Lambda function being invoked.

TenantId -> (string)

The tenant identifier for the chained invocation.

Input -> (structure)

The JSON input payload provided to the chained invocation.

Payload -> (string)

The input payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ExecutedVersion -> (string)

The version of the function that was executed.

DurableExecutionArn -> (string)

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

ChainedInvokeSucceededDetails -> (structure)

Details about a chained invocation that succeeded.

Result -> (structure)

The response payload from the successful operation.

Payload -> (string)

The result payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ChainedInvokeFailedDetails -> (structure)

Contains details about a failed chained function invocation, including error information and failure reason.

Error -> (structure)

Details about the chained invocation failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ChainedInvokeTimedOutDetails -> (structure)

Details about a chained invocation that timed out.

Error -> (structure)

Details about the chained invocation timeout.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

ChainedInvokeStoppedDetails -> (structure)

Details about a chained invocation that was stopped.

Error -> (structure)

Details about why the chained invocation stopped.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

CallbackStartedDetails -> (structure)

Contains details about a callback operation that has started, including timing information and callback metadata.

CallbackId -> (string)

The callback ID. Callback IDs are generated by the DurableContext when a durable function calls ctx.waitForCallback .

HeartbeatTimeout -> (integer)

The heartbeat timeout value, in seconds.

Timeout -> (integer)

The timeout value, in seconds.

CallbackSucceededDetails -> (structure)

Contains details about a successfully completed callback operation, including the result data and completion timestamp.

Result -> (structure)

The response payload from the successful operation.

Payload -> (string)

The result payload.

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

CallbackFailedDetails -> (structure)

Contains details about a failed callback operation, including error information and the reason for failure.

Error -> (structure)

An error object that contains details about the failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

CallbackTimedOutDetails -> (structure)

Contains details about a callback operation that timed out, including timeout duration and any partial results.

Error -> (structure)

Details about the callback timeout.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

InvocationCompletedDetails -> (structure)

Details about a function invocation that completed.

StartTimestamp -> (timestamp)

The date and time when the invocation started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

EndTimestamp -> (timestamp)

The date and time when the invocation ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

RequestId -> (string)

The request ID for the invocation.

Error -> (structure)

Details about the invocation failure.

Payload -> (structure)

The error payload.

ErrorMessage -> (string)

A human-readable error message.

ErrorType -> (string)

The error type.

ErrorData -> (string)

Machine-readable error data.

StackTrace -> (list)

Stack trace information for the error.

(string)

Truncated -> (boolean)

Indicates if the error payload was truncated due to size limits.

NextMarker -> (string)

If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.