sam remote execution get - Amazon Serverless Application Model
UsageRequired ArgumentsOptionsExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

sam remote execution get

Retrieve the details of a specific durable function execution from Amazon Lambda.

The execution ARN should be in the format returned by Invoke or found in execution logs.

Note

This command requires access to Amazon credentials.

Usage

$ sam remote execution get DURABLE_EXECUTION_ARN [OPTIONS]

Required Arguments

DURABLE_EXECUTION_ARN

The Amazon Resource Name (ARN) of the durable function execution to retrieve details for.

Options

--format [summary|json]

Output format. Default: summary

--region TEXT

Set the Amazon Region of the service (for example, us-east-1).

--profile TEXT

Select a specific profile from your credential file to get Amazon credentials.

--config-env TEXT

Environment name specifying default parameter values in the configuration file. Default: default

--config-file TEXT

Configuration file containing default parameter values. Default: samconfig.toml

--save-params

Save the parameters provided via the command line to the configuration file.

--beta-features / --no-beta-features

Enable/Disable beta features.

--debug

Turn on debug logging to print debug messages generated by Amazon SAM CLI and display timestamps.

-h, --help

Shows this message and exits.

Examples

Get execution details with default summary format:

$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55'

Get execution details in JSON format:

$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55' --format json
Note

You must ensure that control characters in the execution ARN like $ are escaped properly when using shell commands.