翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local callback` コマンドのリファレンス情報を提供します。

の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)

`sam local callback` コマンドを使用すると、開発およびテスト中にローカルで耐久性の高い関数実行にコールバックを送信できます。

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

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

## オプション
<a name="sam-cli-command-reference-sam-local-callback-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-sam-local-callback-options-help"></a>
このメッセージを表示して終了します。

## サブコマンド
<a name="sam-cli-command-reference-sam-local-callback-subcommands"></a>

`succeed`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-succeed"></a>
永続的な関数実行に成功コールバックを送信します。詳細については、「[sam local callback succeed](sam-cli-command-reference-sam-local-callback-succeed.md)」を参照してください。

`fail`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-fail"></a>
永続的な関数実行に障害コールバックを送信します。詳細については、「[sam local callback fail](sam-cli-command-reference-sam-local-callback-fail.md)」を参照してください。

`heartbeat`  <a name="sam-cli-command-reference-sam-local-callback-subcommands-heartbeat"></a>
ハートビートコールバックを永続的な関数実行に送信します。詳細については、「[sam local callback heartbeat](sam-cli-command-reference-sam-local-callback-heartbeat.md)」を参照してください。

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

永続的な関数実行に成功コールバックを送信します。

## Usage
<a name="ref-sam-cli-local-callback-succeed-usage"></a>

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

## 必要な引数
<a name="ref-sam-cli-local-callback-succeed-arguments"></a>

`CALLBACK_ID`  
成功レスポンスを送信するコールバックの一意の識別子。

## オプション
<a name="ref-sam-cli-local-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`  
デバッグログを有効にして、CLI AWS SAM によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。

`-h, --help`  
このメッセージを表示して終了します。

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

結果なしで成功コールバックを送信します。

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

結果を含む成功コールバックを送信します。

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

短いオプションで成功コールバックを送信します。

```
$ sam local callback succeed my-callback-id -r 'Success result'
```

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

永続的な関数実行に障害コールバックを送信します。

## Usage
<a name="ref-sam-cli-local-callback-fail-usage"></a>

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

## 必要な引数
<a name="ref-sam-cli-local-callback-fail-arguments"></a>

`CALLBACK_ID`  
失敗レスポンスを送信するコールバックの一意の識別子。

## オプション
<a name="ref-sam-cli-local-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`  
デバッグログを有効にして、CLI AWS SAM によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。

`-h, --help`  
このメッセージを表示して終了します。

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

パラメータなしで失敗コールバックを送信します。

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

エラーメッセージを使用して失敗コールバックを送信します。

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

すべてのパラメータを使用して失敗コールバックを送信します。

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

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

ハートビートコールバックを永続的な関数実行に送信します。

## Usage
<a name="ref-sam-cli-local-callback-heartbeat-usage"></a>

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

## 必要な引数
<a name="ref-sam-cli-local-callback-heartbeat-arguments"></a>

`CALLBACK_ID`  
ハートビートを送信するコールバックの一意の識別子。

## オプション
<a name="ref-sam-cli-local-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`  
デバッグログを有効にして、CLI AWS SAM によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。

`-h, --help`  
このメッセージを表示して終了します。

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

ハートビートコールバックを送信する:

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