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

Description

Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don’t need to call this API directly as the SDK handles state management automatically.

The response contains operations ordered by start sequence number in ascending order. Completed operations with children don’t include child operation details since they don’t need to be replayed.

See also: AWS API Documentation

get-durable-execution-state 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: Operations

Synopsis

  get-durable-execution-state
--durable-execution-arn <value>
--checkpoint-token <value>
[--max-items <value>]
[--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.

--checkpoint-token (string)

A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.

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

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

Operations -> (list)

An array of operations that represent the current state of the durable execution. Operations are ordered by their start sequence number in ascending order and include information needed for replay processing.

(structure)

Information about an operation within a durable execution.

Id -> (string)

The unique identifier for this operation.

ParentId -> (string)

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

Name -> (string)

The customer-provided name for this operation.

Type -> (string)

The type of operation.

SubType -> (string)

The subtype of the operation, providing additional categorization.

StartTimestamp -> (timestamp)

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

EndTimestamp -> (timestamp)

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

Status -> (string)

The current status of the operation.

ExecutionDetails -> (structure)

Details about the execution, if this operation represents an execution.

InputPayload -> (string)

The original input payload provided for the durable execution.

ContextDetails -> (structure)

Details about the context, if this operation represents a context.

ReplayChildren -> (boolean)

Whether the state data of child operations of this completed context should be included in the invoke payload and GetDurableExecutionState response.

Result -> (string)

The response payload from the context.

Error -> (structure)

Details about the context failure.

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)

StepDetails -> (structure)

Details about the step, if this operation represents a step.

Attempt -> (integer)

The current attempt number for this step.

NextAttemptTimestamp -> (timestamp)

The date and time when the next attempt is scheduled, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). Only populated when the step is in a pending state.

Result -> (string)

The JSON response payload from the step operation.

Error -> (structure)

Details about the step failure.

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)

WaitDetails -> (structure)

Details about the wait operation, if this operation represents a wait.

ScheduledEndTimestamp -> (timestamp)

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

CallbackDetails -> (structure)

Contains details about a callback operation in a durable execution, including the callback token and timeout configuration.

CallbackId -> (string)

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

Result -> (string)

The response payload from the callback operation as a string.

Error -> (structure)

An error object that contains details about the failure.

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)

ChainedInvokeDetails -> (structure)

Contains details about a chained function invocation in a durable execution, including the target function and invocation parameters.

Result -> (string)

The response payload from the chained invocation.

Error -> (structure)

Details about the chained invocation failure.

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)

NextMarker -> (string)

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