AWS CLI Command Reference

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

Description

Retrieves detailed information about a specific durable execution , including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.

See also: AWS API Documentation

Synopsis

  get-durable-execution
--durable-execution-arn <value>
[--cli-input-json <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.

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

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

DurableExecutionArn -> (string)

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

DurableExecutionName -> (string)

The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

FunctionArn -> (string)

The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

InputPayload -> (string)

The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

Result -> (string)

The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED . The result is limited to 256 KB.

Error -> (structure)

Error information if the durable execution failed. This field is only present when the execution status is FAILED , TIMED_OUT , or STOPPED . The combined size of all error fields is limited to 256 KB.

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)

StartTimestamp -> (timestamp)

The date and time when the durable execution started, in Unix timestamp format.

Status -> (string)

The current status of the durable execution. Valid values are RUNNING , SUCCEEDED , FAILED , TIMED_OUT , and STOPPED .

EndTimestamp -> (timestamp)

The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED , FAILED , TIMED_OUT , or STOPPED ).

Version -> (string)

The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

TraceHeader -> (structure)

The trace headers associated with the durable execution.

XAmznTraceId -> (string)

The X-Ray trace header associated with the durable execution.