本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# sam remote callback
<a name="sam-cli-command-reference-sam-remote-callback"></a>

本页提供 AWS Serverless Application Model 命令行界面 (AWS SAMCLI) `sam remote callback` 命令的参考信息。

有关简介 AWS SAMCLI，请参阅 [那是什么 AWS SAMCLI？](what-is-sam-overview.md#what-is-sam-cli)

该`sam remote callback`命令允许您向在 Lamb AWS da 中运行的远程持久函数执行发送回调。

**注意**  
这些命令需要访问 AWS 凭证。

## 用法
<a name="sam-cli-command-reference-sam-remote-callback-usage"></a>

```
$ sam remote callback <subcommand> <options>
```

## 选项
<a name="sam-cli-command-reference-sam-remote-callback-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-remote-callback-options-help"></a>
显示此消息并退出。

## 子命令
<a name="sam-cli-command-reference-sam-remote-callback-subcommands"></a>

`succeed`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-succeed"></a>
向远程持久函数执行发送成功回调。有关更多信息，请参阅 [sam remote callback succeed](sam-cli-command-reference-sam-remote-callback-succeed.md)。

`fail`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-fail"></a>
向远程持久函数执行发送回调失败。有关更多信息，请参阅 [sam remote callback fail](sam-cli-command-reference-sam-remote-callback-fail.md)。

`heartbeat`  <a name="sam-cli-command-reference-sam-remote-callback-subcommands-heartbeat"></a>
向远程持久函数执行发送回调心跳。有关更多信息，请参阅 [sam remote callback heartbeat](sam-cli-command-reference-sam-remote-callback-heartbeat.md)。

# sam remote callback succeed
<a name="sam-cli-command-reference-sam-remote-callback-succeed"></a>

向远程持久函数执行发送成功回调。

**注意**  
此命令需要访问 AWS 凭证。

## 用法
<a name="ref-sam-cli-remote-callback-succeed-usage"></a>

```
$ sam remote callback succeed CALLBACK_ID [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-remote-callback-succeed-arguments"></a>

`CALLBACK_ID`  
要向其发送成功响应的回调的唯一标识符。

## 选项
<a name="ref-sam-cli-remote-callback-succeed-options"></a>

`-r, --result TEXT`  
成功结果有效载荷为字符串。

`--region TEXT`  
设置服务的 AWS 区域（例如，`us-east-1`）。

`--profile TEXT`  
从您的凭证文件中选择一个特定的个人资料以获取 AWS 凭证。

`--config-env TEXT`  
在配置文件中指定默认参数值的环境名称。默认值：`default`

`--config-file TEXT`  
包含默认参数值的配置文件。默认值：`samconfig.toml`

`--save-params`  
将通过命令行提供的参数保存到配置文件中。

`--beta-features / --no-beta-features`  
启用/禁用测试版功能。

`--debug`  
打开调试日志以打印 AWS SAM CLI 生成的调试消息并显示时间戳。

`-h, --help`  
显示此消息并退出。

## 示例
<a name="ref-sam-cli-remote-callback-succeed-examples"></a>

发送成功回调，但没有结果：

```
$ sam remote callback succeed my-callback-id
```

发送带有结果的成功回调：

```
$ sam remote callback succeed my-callback-id --result 'Task completed successfully'
```

# sam remote callback fail
<a name="sam-cli-command-reference-sam-remote-callback-fail"></a>

向远程持久函数执行发送回调失败。

**注意**  
此命令需要访问 AWS 凭证。

## 用法
<a name="ref-sam-cli-remote-callback-fail-usage"></a>

```
$ sam remote callback fail CALLBACK_ID [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-remote-callback-fail-arguments"></a>

`CALLBACK_ID`  
要向其发送失败响应的回调的唯一标识符。

## 选项
<a name="ref-sam-cli-remote-callback-fail-options"></a>

`--error-data TEXT`  
其他错误数据。

`--stack-trace TEXT`  
堆栈跟踪条目。可以多次指定此选项。

`--error-type TEXT`  
错误类型。

`--error-message TEXT`  
详细的错误消息。

`--region TEXT`  
设置服务的 AWS 区域（例如，`us-east-1`）。

`--profile TEXT`  
从您的凭证文件中选择一个特定的个人资料以获取 AWS 凭证。

`--config-env TEXT`  
在配置文件中指定默认参数值的环境名称。默认值：`default`

`--config-file TEXT`  
包含默认参数值的配置文件。默认值：`samconfig.toml`

`--save-params`  
将通过命令行提供的参数保存到配置文件中。

`--beta-features / --no-beta-features`  
启用/禁用测试版功能。

`--debug`  
打开调试日志以打印 AWS SAM CLI 生成的调试消息并显示时间戳。

`-h, --help`  
显示此消息并退出。

## 示例
<a name="ref-sam-cli-remote-callback-fail-examples"></a>

发送不带参数的失败回调：

```
$ sam remote callback fail my-callback-id
```

发送带有错误消息的失败回调：

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

发送包含所有参数的失败回调：

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

# sam remote callback heartbeat
<a name="sam-cli-command-reference-sam-remote-callback-heartbeat"></a>

向远程持久函数执行发送回调心跳。

**注意**  
此命令需要访问 AWS 凭证。

## 用法
<a name="ref-sam-cli-remote-callback-heartbeat-usage"></a>

```
$ sam remote callback heartbeat CALLBACK_ID [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-remote-callback-heartbeat-arguments"></a>

`CALLBACK_ID`  
要向其发送心跳的回调的唯一标识符。

## 选项
<a name="ref-sam-cli-remote-callback-heartbeat-options"></a>

`--region TEXT`  
设置服务的 AWS 区域（例如，`us-east-1`）。

`--profile TEXT`  
从您的凭证文件中选择一个特定的个人资料以获取 AWS 凭证。

`--config-env TEXT`  
在配置文件中指定默认参数值的环境名称。默认值：`default`

`--config-file TEXT`  
包含默认参数值的配置文件。默认值：`samconfig.toml`

`--save-params`  
将通过命令行提供的参数保存到配置文件中。

`--beta-features / --no-beta-features`  
启用/禁用测试版功能。

`--debug`  
打开调试日志以打印 AWS SAM CLI 生成的调试消息并显示时间戳。

`-h, --help`  
显示此消息并退出。

## 示例
<a name="ref-sam-cli-remote-callback-heartbeat-examples"></a>

发送心跳回调：

```
$ sam remote callback heartbeat my-callback-id
```