sam remote callback fail - AWS Serverless Application Model
UsageRequired ArgumentsOptionsExamples

sam remote callback fail

Send a callback failure to a remote durable function execution.

Note

This command requires access to AWS credentials.

Usage

$ sam remote callback fail CALLBACK_ID [OPTIONS]

Required Arguments

CALLBACK_ID

The unique identifier of the callback to send a failure response to.

Options

--error-data TEXT

Additional error data.

--stack-trace TEXT

Stack trace entries. This option can be specified multiple times.

--error-type TEXT

Type of error.

--error-message TEXT

Detailed error message.

--region TEXT

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

--profile TEXT

Select a specific profile from your credential file to get AWS 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 AWS SAM CLI and display timestamps.

-h, --help

Shows this message and exits.

Examples

Send failure callback with no parameters:

$ sam remote callback fail my-callback-id

Send failure callback with error message:

$ sam remote callback fail my-callback-id --error-message 'Task failed'

Send failure callback with all parameters:

$ sam remote callback fail my-callback-id --error-message 'Task failed' --error-type 'ValidationError' --stack-trace 'at line 42' --error-data '{"code": 500}'