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

# sam local execution
<a name="sam-cli-command-reference-sam-local-execution"></a>

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

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

该`sam local execution`命令允许您在开发和测试期间管理和检查本地持久函数的执行情况。

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

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

```
$ sam local execution <subcommand> <options>
```

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

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

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

`get`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-get"></a>
获取持久函数执行的详细信息。有关更多信息，请参阅 [sam local execution get](sam-cli-command-reference-sam-local-execution-get.md)。

`history`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-history"></a>
获取持久函数执行的执行历史。有关更多信息，请参阅 [sam local execution history](sam-cli-command-reference-sam-local-execution-history.md)。

`stop`  <a name="sam-cli-command-reference-sam-local-execution-subcommands-stop"></a>
停止执行持久的函数。有关更多信息，请参阅 [sam local execution stop](sam-cli-command-reference-sam-local-execution-stop.md)。

# sam local execution get
<a name="sam-cli-command-reference-sam-local-execution-get"></a>

检索特定持久函数执行的详细信息。

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

## 用法
<a name="ref-sam-cli-local-execution-get-usage"></a>

```
$ sam local execution get DURABLE_EXECUTION_ARN [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-local-execution-get-arguments"></a>

`DURABLE_EXECUTION_ARN`  
要检索其详细信息的持久函数执行的 Amazon 资源名称 (ARN)。

## 选项
<a name="ref-sam-cli-local-execution-get-options"></a>

`--format [summary|json]`  
输出格式。默认值：`summary`

`--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-local-execution-get-examples"></a>

使用默认摘要格式获取执行详情：

```
$ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

以 JSON 格式获取执行详情：

```
$ sam local execution get arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --format json
```

# sam local execution history
<a name="sam-cli-command-reference-sam-local-execution-history"></a>

获取持久函数执行的执行历史。

## 用法
<a name="ref-sam-cli-local-execution-history-usage"></a>

```
$ sam local execution history EXECUTION_ID [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-local-execution-history-arguments"></a>

`EXECUTION_ID`  
要检索历史记录的持久函数执行的唯一标识符。

## 选项
<a name="ref-sam-cli-local-execution-history-options"></a>

`--format [table|json]`  
输出格式。默认值：`table`

`--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-local-execution-history-examples"></a>

以表格格式获取执行历史记录：

```
$ sam local execution history my-execution-id
```

获取 JSON 格式的执行历史记录：

```
$ sam local execution history my-execution-id --format json
```

# sam local execution stop
<a name="sam-cli-command-reference-sam-local-execution-stop"></a>

停止正在运行的持久函数执行。

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

## 用法
<a name="ref-sam-cli-local-execution-stop-usage"></a>

```
$ sam local execution stop DURABLE_EXECUTION_ARN [OPTIONS]
```

## 必需的参数
<a name="ref-sam-cli-local-execution-stop-arguments"></a>

`DURABLE_EXECUTION_ARN`  
要停止执行的持久函数的 Amazon 资源名称 (ARN)。

## 选项
<a name="ref-sam-cli-local-execution-stop-options"></a>

`--error-message TEXT`  
与已停止的执行关联的错误消息。

`--error-type TEXT`  
要与已停止的执行关联的错误类型。

`--error-data TEXT`  
要与已停止的执行关联的错误数据。

`--stack-trace 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-local-execution-stop-examples"></a>

在没有错误详情的情况下停止执行：

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id
```

停止执行并显示错误消息，然后键入：

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Execution cancelled" --error-type "UserCancellation"
```

使用完整的错误详细信息和堆栈跟踪停止执行：

```
$ sam local execution stop arn:aws:lambda:us-east-1:123456789012:function:MyFunction:$LATEST/durable-execution/my-execution-name/my-execution-id --error-message "Task failed" --error-type "TaskFailure" --error-data '{"reason":"timeout"}' --stack-trace "at function1()" --stack-trace "at function2()"
```