sam remote test-event get - AWS Serverless Application Model (original) (raw)

This page provides reference information for the AWS Serverless Application Model Command Line Interface (AWS SAM CLI) sam remote test-event get subcommand.

• For an introduction to the AWS SAM CLI, see What is the AWS SAM CLI?
• For documentation on using the AWS SAM CLI sam remote test-event command, seeIntroduction to cloud testing with sam remote test-event.

The sam remote test-event get subcommand gets a shareable test event from the Amazon EventBridge schema registry.

Usage

$ sam remote test-event get <arguments> <options>

Arguments

Resource ID

The ID of the AWS Lambda function associated with the shareable test event to get.

If you provide a logical ID, you must also provide a value for the AWS CloudFormation stack associated with the Lambda function using the --stack-name option.

Valid values: The resource's logical ID or resource ARN.

Options

--config-env `TEXT`

The environment name specifying the default parameter values in the configuration file to use. The default value is "default". For more information about configuration files, see AWS SAM CLI configuration file.

--config-file `PATH`

The path and file name of the configuration file containing default parameter values to use. The default value is "samconfig.toml" in the root of the project directory. For more information about configuration files, see AWS SAM CLI configuration file.

--help, -h

Show the help message and exit.

--name `TEXT`

The name of the shareable test event to get.

--output-file `FILENAME`

The file path and name to save the event to on your local machine.

If you don’t provide this option, the AWS SAM CLI will output the contents of the shareable test event to your console.

--stack-name `TEXT`

The name of the AWS CloudFormation stack associated with the Lambda function.

This option is required if you are providing the Lambda function logical ID as an argument.

sam remote test-event delete

sam remote test-event list

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.