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

# AWS SAM CLI コマンドリファレンス
<a name="serverless-sam-cli-command-reference"></a>

このセクションでは、 AWS SAM CLI コマンドのリファレンス情報を示します。これには、使用についての詳細、各コマンドで使用できるさまざまなオプションの包括的なリスト、および追加情報が含まれています。対応する情報がある場合、追加の情報には引数、環境変数、イベントなどの詳細が含まれます。詳細については、各コマンドを参照してください。のインストール手順については AWS SAM CLI、「」を参照してください[AWS SAM CLI のインストール](install-sam-cli.md)。

**Topics**
+ [sam build](sam-cli-command-reference-sam-build.md)
+ [sam delete](sam-cli-command-reference-sam-delete.md)
+ [sam deploy](sam-cli-command-reference-sam-deploy.md)
+ [sam init](sam-cli-command-reference-sam-init.md)
+ [sam list](sam-cli-command-reference-sam-list.md)
+ [sam local callback](sam-cli-command-reference-sam-local-callback.md)
+ [sam local execution](sam-cli-command-reference-sam-local-execution.md)
+ [sam local generate-event](sam-cli-command-reference-sam-local-generate-event.md)
+ [sam local invoke](sam-cli-command-reference-sam-local-invoke.md)
+ [sam local start-api](sam-cli-command-reference-sam-local-start-api.md)
+ [sam local start-lambda](sam-cli-command-reference-sam-local-start-lambda.md)
+ [sam logs](sam-cli-command-reference-sam-logs.md)
+ [sam package](sam-cli-command-reference-sam-package.md)
+ [sam pipeline bootstrap](sam-cli-command-reference-sam-pipeline-bootstrap.md)
+ [sam pipeline init](sam-cli-command-reference-sam-pipeline-init.md)
+ [sam publish](sam-cli-command-reference-sam-publish.md)
+ [sam remote callback](sam-cli-command-reference-sam-remote-callback.md)
+ [sam remote execution](sam-cli-command-reference-sam-remote-execution.md)
+ [sam remote invoke](sam-cli-command-reference-remote-invoke.md)
+ [sam remote test-event](sam-cli-command-reference-remote-test-event.md)
+ [sam sync](sam-cli-command-reference-sam-sync.md)
+ [sam traces](sam-cli-command-reference-sam-traces.md)
+ [sam validate](sam-cli-command-reference-sam-validate.md)

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam build` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam build` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[を使用した の構築の概要 AWS SAM](using-sam-cli-build.md)。

`sam build` コマンドは、ローカルテストや AWS クラウドへのデプロイなど、開発者ワークフローの後続のステップに備えてアプリケーションを準備します。

## Usage
<a name="ref-sam-cli-build-usage"></a>

```
$ sam build <arguments> <options>
```

## 引数
<a name="ref-sam-cli-build-args"></a>

**Resource ID (リソース ID)**  <a name="ref-sam-cli-build-args-resource-id"></a>
オプション。[AWS SAM テンプレート](what-is-sam-overview.md#what-is-sam-template)で宣言された単一のリソースを構築する AWS SAM ように に指示します。指定されたリソースのビルドアーティファクトは、ワークフローの後続コマンド (つまり、`sam package` と `sam deploy`) に使用できる唯一のアーティファクトになります。

## オプション
<a name="ref-sam-cli-build-options"></a>

`--base-dir, -s DIRECTORY`  <a name="ref-sam-cli-build-options-base-dir"></a>
関数またはレイヤーのソースコードへの相対パスを、このディレクトリを基準にして解決します。このオプションは、ソースコードフォルダへの相対パスの解決方法を変更したい場合に使用します。デフォルトで、相対パスは AWS SAM テンプレートの場所を基準にして解決されます。  
このオプションは、構築しているルートアプリケーションまたはスタックのリソースに加えて、ネストされたアプリケーションまたはスタックにも適用されます。  
このオプションは、以下のリソースタイプとプロパティに適用されます。  
+ リソースタイプ: `AWS::Serverless::Function` プロパティ: `CodeUri`
+ リソースタイプ: `AWS::Serverless::Function` リソース属性: `Metadata` エントリ: `DockerContext`
+ リソースタイプ: `AWS::Serverless::LayerVersion` プロパティ: `ContentUri`
+ リソースタイプ: `AWS::Lambda::Function` プロパティ: `Code`
+ リソースタイプ: `AWS::Lambda::LayerVersion` プロパティ: `Content`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-build-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--build-dir, -b DIRECTORY`  <a name="ref-sam-cli-build-options-build-dir"></a>
ビルドアーティファクトが保存されているディレクトリへのパスです。このオプションを使用すると、このディレクトリとそのコンテンツのすべてが削除されます。

`--build-image TEXT`  <a name="ref-sam-cli-build-options-build-image"></a>
ビルド用にプルするコンテナイメージの URI です。デフォルトで、 AWS SAM は Amazon ECR Public からコンテナイメージをプルします。このオプションは、別の場所からイメージをプルするために使用します。  
このオプションは複数回指定できます。このオプションの各インスタンスには、文字列またはキーバリューペアを使用できます。文字列を指定する場合は、アプリケーション内のすべてのリソースに使用するコンテナイメージの URI になります。例えば、`sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8`。キーバリューペアを指定する場合、キーはリソース名で、値はそのリソースに使用するコンテナイメージの URI です。例えば、`sam build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8` です。キーバリューペアを使用すると、異なるリソースに異なるコンテナイメージを指定できます。  
このオプションは、`--use-container` オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

`--build-in-source | --no-build-in-source`  <a name="ref-sam-cli-build-options-build-in-source"></a>
ソースフォルダにプロジェクトを直接構築するには `--build-in-source` を指定します。  
`--build-in-source` オプションは、次のランタイムとビルドメソッドをサポートします:  
+ **ランタイム** – `sam init --runtime` オプションでサポートされている Node.js ランタイム。
+ **ビルドメソッド** – `Makefile`、`esbuild`。
`--build-in-source` オプションは、次のオプションとは互換性がありません:  
+ `--hook-name`
+ `--use-container `
*デフォルト*: `--no-build-in-source`

`--cached | --no-cached`  <a name="ref-sam-cli-build-options-cached"></a>
キャッシュされたビルドを有効または無効にします。このオプションを使用して、以前の builds から変更されていないビルドアーティファクトを再利用します。 AWS SAM は、プロジェクトディレクトリ内のファイルを変更したかどうかを評価します。デフォルトでは、ビルドはキャッシュされません。`--no-cached` オプションが呼び出されると、samconfig.toml の `cached = true` 設定が上書きされます。  
AWS SAM は、特定のバージョンが提供されていない場合、プロジェクトが依存するサードパーティーモジュールが変更されたかどうかを評価しません。たとえば、Python 関数にエントリ を持つ`requirements.txt`ファイルが含まれており`requests=1.x`、最新のリクエストモジュールのバージョンが から `1.1`に変わった場合`1.2`、 AWS SAM はキャッシュされていないビルドを実行するまで最新バージョンをプルしません。

`--cache-dir`  <a name="ref-sam-cli-build-options-cached-dir"></a>
`--cached` が指定されている場合にキャッシュアーティファクトが保存されるディレクトリです。デフォルトのキャッシュディレクトリは `.aws-sam/cache` です。

`--config-env TEXT`  <a name="ref-sam-cli-build-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-build-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--container-env-var, -e TEXT`  <a name="ref-sam-cli-build-options-container-env-var"></a>
ビルドコンテナに渡す環境変数です。このオプションは複数回指定できます。このオプションの各インスタンスは、キーバリューペアを使用します。このペアのキーはリソースと環境変数で、値は環境変数の値です。例: `--container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2`。  
このオプションは、`--use-container` オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

`--container-env-var-file, -ef PATH`  <a name="ref-sam-cli-build-options-container-env-var-file"></a>
コンテナの環境変数の値が含まれる JSON ファイルのパスとファイル名です。コンテナ環境変数ファイルの詳細については、「[コンテナ環境変数ファイル](serverless-sam-cli-using-build.md#serverless-sam-cli-using-container-environment-file)」を参照してください。  
このオプションは、`--use-container` オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

`--debug`  <a name="ref-sam-cli-build-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

`--docker-network TEXT`  <a name="ref-sam-cli-build-options-docker-network"></a>
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続する必要がある既存の Docker ネットワークの名前または ID を指定します。指定されていない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークのみに接続します。

`--exclude, -x`  <a name="ref-sam-cli-build-options-exclude"></a>
`sam build` から除外するリソースの名前。例えば、テンプレートに `Function1`、`Function2`、`Function3` が含まれていて、`sam build --exclude Function2` を実行する場合、`Function1` および `Function3` だけが構築されます。

`--help`  <a name="ref-sam-cli-build-options-help"></a>
このメッセージを表示して終了します。

`--hook-name TEXT`  <a name="ref-sam-cli-build-options-hook-name"></a>
 AWS SAM CLI 機能の拡張に使用されるフックの名前。  
許容値: `terraform`。

`--manifest , -m PATH`  <a name="ref-sam-cli-build-options-manifest"></a>
デフォルトの代わりに使用する、カスタム依存関係のマニフェストファイル (package.json など) へのパスです。

`--mount-symlinks`  <a name="ref-sam-cli-build-options-mount-symlinks"></a>
 AWS SAM CLI が常にファイル内のシンボリックリンクをマウントして構築または呼び出しを行うようにします。これは、最上位ディレクトリのシンボリックリンク (つまり、関数のルートに直接あるシンボリックリンク) にのみ適用されます。デフォルトで、NodeJS で `node_modules` に `build-in-source` を使用するために必要なシンボリックリンク以外はマウントされません。

`--no-use-container`  <a name="ref-sam-cli-build-options-no-use-container"></a>
デフォルトの動作の設定に IDE ツールキットを使用できるようにするオプションです。`sam build --no-use-container` を使用して、Docker コンテナの代わりにローカルマシンでビルドを実行することもできます。

`--parallel`  <a name="ref-sam-cli-build-options-parallel"></a>
並列ビルドを有効にします。このオプションを使用して、 AWS SAM テンプレートの関数とレイヤーを並行して構築します。デフォルトで、関数とレイヤーは順番に構築されます。

`--parameter-overrides`  <a name="ref-sam-cli-build-options-parameter-overrides"></a>
(オプション) キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。例えば、「`ParameterKey`=`KeyPairName`, `ParameterValue`=`MyKey` `ParameterKey`=`InstanceType`, `ParameterValue`=`t1.micro`」などです。このオプションは `--hook-name` と互換性がありません。

`--profile TEXT`  <a name="ref-sam-cli-build-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-build-options-region"></a>
 AWS リージョン デプロイ先の 。例えば、us-east-1 などです。

`--save-params`  <a name="ref-sam-cli-build-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--skip-prepare-infra`  <a name="ref-sam-cli-build-options-skip-prepare-infra"></a>
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。`--hook-name` オプションと合わせて使用します。

`--skip-pull-image`  <a name="ref-sam-cli-build-options-skip-pull-image"></a>
コマンドが Lambda ランタイム用の最新 Docker イメージのプルダウンをスキップするべきかどうかを指定します。

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-build-options-template-file"></a>
 AWS SAM テンプレートファイル のパスとファイル名`[default: template.[yaml|yml]]`。このオプションは `--hook-name` と互換性がありません。

`--terraform-project-root-path`  <a name="ref-sam-cli-build-options-terraform-project-root-path"></a>
Terraform設定ファイルまたは関数ソースコードを含む最上位ディレクトリへの相対パスまたは絶対パス。Terraformこれらのファイルがルートモジュールを含むディレクトリの外部にある場合は、このオプションを使用して絶対パスまたは相対パスを指定します。このオプションは `--hook-name` を `terraform` に設定する必要があります。

`--use-container`, `-u`  <a name="ref-sam-cli-build-options-use-container"></a>
関数がネイティブにコンパイルされた依存関係を持つパッケージに依存する場合は、このオプションを使用して、Lambda に似た Docker コンテナ内で関数を構築します。

## 例
<a name="sam-cli-command-reference-sam-build-examples"></a>

`sam build` サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「[を使用した の構築の概要 AWS SAM](using-sam-cli-build.md)」を参照してください。

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

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

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

`sam delete` コマンドは、 CloudFormation スタック、パッケージ化されて Amazon S3 と Amazon ECR にデプロイされたアーティファクト、および AWS SAM テンプレートファイルを削除することで、 AWS SAM アプリケーションを削除します。

このコマンドは、Amazon ECR コンパニオンスタックがデプロイされているかどうかをチェックし、デプロイされている場合は、そのスタックと Amazon ECR リポジトリの削除についてユーザーに表示します。`--no-prompts` が指定されている場合、コンパニオンスタックと Amazon ECR リポジトリはデフォルトで削除されます。

## Usage
<a name="sam-cli-command-reference-sam-delete-usage"></a>

```
$ sam delete <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-delete-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は `default` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-delete-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-delete-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

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

`--no-prompts`  <a name="sam-cli-command-reference-sam-delete-options-no-prompts"></a>
を非インタラクティブモードで AWS SAM 動作させるには、このオプションを指定します。スタック名は、`--stack-name` オプションとともに、または設定 `toml` ファイルで指定する必要があります。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-delete-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-delete-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--s3-bucket`  <a name="sam-cli-command-reference-sam-delete-options-s3-bucket"></a>
削除する Amazon S3 バケットのパス。

`--s3-prefix`  <a name="sam-cli-command-reference-sam-delete-options-s3-prefix"></a>
削除する Amazon S3 バケットのプレフィックス。

`--save-params`  <a name="sam-cli-command-reference-sam-delete-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-delete-options-stack-name"></a>
削除する CloudFormation スタックの名前。

## 例
<a name="sam-cli-command-reference-sam-delete-examples"></a>

次のコマンドは、スタック `MY-STACK` を削除します。

```
$ sam delete --stack-name MY-STACK
```

次のコマンドは、スタック `MY-STACK` と S3 バケット `sam-s3-demo-bucket` を削除します。

```
$ sam delete \
    --stack-name MyStack \
    --s3-bucket MySAMBucket
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam deploy` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam deploy` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[を使用したデプロイの概要 AWS SAM](using-sam-cli-deploy.md)。

`sam deploy` コマンドは、 AWS クラウド を使用してアプリケーションを にデプロイします AWS CloudFormation。

## Usage
<a name="ref-sam-cli-deploy-usage"></a>

```
$ <environment variables> sam deploy <options>
```

## 環境変数
<a name="ref-sam-cli-deploy-env"></a>

`SAM_CLI_POLL_DELAY`  <a name="ref-sam-cli-deploy-env-sam-cli-poll-delay"></a>
シェルに 秒の値を持つ`SAM_CLI_POLL_DELAY`環境変数を設定して、SAM AWS CLI が CloudFormation スタックの状態をチェックする頻度を設定します。これはスロットリングを表示するときに便利です CloudFormation。この環境変数は、`sam deploy` の実行中に行われる `describe_stack` API コールのポーリングに使用されます。  
この変数の例を次に示します。  

```
$ SAM_CLI_POLL_DELAY=5 sam deploy
```

## オプション
<a name="ref-sam-cli-deploy-options"></a>

`--capabilities LIST`  <a name="ref-sam-cli-deploy-options-capabilities"></a>
が特定のスタックを作成 CloudFormation できるように指定する必要がある機能のリスト。一部のスタックテンプレートには AWS アカウント、新しい AWS Identity and Access Management (IAM) ユーザーを作成するなど、 のアクセス許可に影響するリソースが含まれている場合があります。このようなスタックについては、このパラメータを指定することによって、それらの機能を明示的に承認する必要があります。有効な値は、`CAPABILITY_IAM` と `CAPABILITY_NAMED_IAM` のみです。IAM リソースがある場合、どちらの機能でも指定できます。カスタム名を持つ IAM リソースがある場合は、`CAPABILITY_NAMED_IAM` を指定する必要があります。このオプションを指定しない場合は、オペレーションが `InsufficientCapabilities` エラーを返します。  
ネストされたアプリケーションを含むアプリケーションをデプロイする場合は、アプリケーションにネストされたアプリケーションが含まれることを承認するために `CAPABILITY_AUTO_EXPAND` を使用する必要があります。詳細については、「[ネストされたアプリケーションのデプロイ](serverless-sam-template-nested-applications.md#serverless-sam-templates-nested-applications-deploying)」を参照してください。

`--config-env TEXT`  <a name="ref-sam-cli-deploy-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は `default` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-deploy-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--confirm-changeset | --no-confirm-changeset`  <a name="ref-sam-cli-deploy-options-confirm-changeset"></a>
 AWS SAM CLI が計算された変更セットをデプロイするかどうかの確認を求めます。

`--debug`  <a name="ref-sam-cli-deploy-options-debug"></a>
デバッグロギングを有効にして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--disable-rollback | --no-disable-rollback`  <a name="ref-sam-cli-deploy-options-disable-rollback"></a>
デプロイ中にエラーが発生した場合に CloudFormation スタックをロールバックするかどうかを指定します。デフォルトでは、デプロイ中にエラーが発生した場合、 CloudFormation スタックは最後の安定状態に戻ります。`--disable-rollback` を指定した状態でデプロイ中にエラーが発生した場合、エラーが発生する前に作成または更新されたリソースはロールバックされません。

`--fail-on-empty-changeset | --no-fail-on-empty-changeset`  <a name="ref-sam-cli-deploy-options-fail-on-empty-changeset"></a>
スタックに対して行う変更がない場合に 0 以外の終了コードを返すかどうかを指定します。デフォルトの動作では、ゼロ以外の終了コードが返されます。

`--force-upload`  <a name="ref-sam-cli-deploy-options-force-upload"></a>
このオプションを指定して、アーティファクトが Amazon S3 バケット内の既存のアーティファクトと一致する場合でも、それらをアップロードします。一致するアーティファクトは上書きされます。

`--guided, -g`  <a name="ref-sam-cli-deploy-options-guided"></a>
このオプションを指定して、デプロイ全体で AWS SAM CLI によるプロンプトを用いたガイドを有効にします。

`--help`  <a name="ref-sam-cli-deploy-options-help"></a>
このメッセージを表示して終了します。

`--image-repositories TEXT`  <a name="ref-sam-cli-deploy-options-image-repositories"></a>
関数の Amazon ECR リポジトリ URI へのマッピングです。論理 ID で関数を参照します。以下に例を示します。  

```
$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
このオプションは 1 つのコマンドで複数回指定できます。

`--image-repository TEXT`  <a name="ref-sam-cli-deploy-options-image-repository"></a>
このコマンドが関数のイメージをアップロードする Amazon ECR リポジトリの名前です。このオプションは、`Image` パッケージタイプで宣言された関数に必要です。

`--kms-key-id TEXT`  <a name="ref-sam-cli-deploy-options-kms-key-id"></a>
Amazon S3 バケットに保管されているアーティファクトを暗号化するために使用される AWS Key Management Service (AWS KMS) キーの ID。このオプションを指定しない場合、 は Amazon S3-managed暗号化キー AWS SAM を使用します。

`--metadata`  <a name="ref-sam-cli-deploy-options-metadata"></a>
テンプレートで参照されるすべてのアーティファクトにアタッチするメタデータのマップです。

`--no-execute-changeset`  <a name="ref-sam-cli-deploy-options-no-execute-changeset"></a>
変更セットを適用するかどうかを示します。このオプションは、変更セットを適用する前にスタックの変更を表示したい場合に指定します。このコマンドは、 CloudFormation 変更セットを作成してから、その変更セットを適用せずに終了します。変更セットを適用するには、このオプションを指定せずに同じコマンドを実行します。

`--no-progressbar`  <a name="ref-sam-cli-deploy-options-no-progressbar"></a>
Amazon S3 へのアーティファクトのアップロード時に、進行状況バーを表示しません。

`--notification-arns LIST`  <a name="ref-sam-cli-deploy-options-notification-arns"></a>
スタック CloudFormation に関連付ける Amazon Simple Notification Service (Amazon SNS) トピック ARNs のリスト。

`--on-failure [ROLLBACK | DELETE | DO_NOTHING]`  <a name="ref-sam-cli-deploy-options-on-failure"></a>
スタックの作成が失敗されたときに実行するアクションを指定します。  
以下のオプションが利用できます。  
+ `ROLLBACK` — スタックを以前の既知の正常な状態にロールバックします。
+ `DELETE` — 以前の既知の正常な状態が存在する場合、スタックを以前の既知の状態にロールバックします。以前の既知の正常な状態が存在しない場合は、スタックを削除します。
+ `DO_NOTHING` — スタックのロールバックおよび削除を行いません。この結果は `--disable-rollback` の結果と同じです。
デフォルトの動作は `ROLLBACK` です。  
`--disable-rollback` オプションまたは `--on-failure` オプションを指定できますが、両方を指定することはできません。

`--parameter-overrides LIST`  <a name="ref-sam-cli-deploy-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。上書きはそれぞれ `ParameterKey=name,ParameterValue=value` 形式を使用します。複数の上書きはスペースで区切られます。ここでは、以下の 2 つの例を示します。  

```
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2
```

```
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana
```

`--profile TEXT`  <a name="ref-sam-cli-deploy-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-deploy-options-region"></a>
 AWS リージョン デプロイ先の 。例えば、us-east-1 などです。

`--resolve-image-repos`  <a name="ref-sam-cli-deploy-options-resolve-image-repos"></a>
ガイドなしデプロイのパッケージ化およびデプロイに使用する Amazon ECR リポジトリを自動的に作成します。このオプションは、`PackageType: Image` が指定された関数とレイヤーにのみ適用されます。`--guided` オプションを指定すると、 AWS SAM CLI は `--resolve-image-repos` を無視します。  
がこのオプションを使用して関数またはレイヤーの Amazon ECR リポジトリ AWS SAM を自動的に作成し、後で AWS SAM テンプレートからそれらの関数またはレイヤーを削除すると、対応する Amazon ECR リポジトリは自動的に削除されます。

`--resolve-s3`  <a name="ref-sam-cli-deploy-options-resolve-s3"></a>
ガイドなしデプロイのパッケージ化とデプロイに使用する Amazon S3 バケットを自動的に作成します。`--guided` オプションを指定すると、 AWS SAM CLI は `--resolve-s3` を無視します。`--s3-bucket` と `--resolve-s3` の両方のオプションを指定するとエラーが発生します。

`--role-arn TEXT`  <a name="ref-sam-cli-deploy-options-role-arn"></a>
変更セットを適用するときに が CloudFormation 引き受ける IAM ロールの Amazon リソースネーム (ARN)。

`--s3-bucket TEXT`  <a name="ref-sam-cli-deploy-options-s3-bucket"></a>
このコマンドが CloudFormation テンプレートをアップロードする Amazon S3 バケットの名前。テンプレートが 51,200 バイトより大きい場合は、`--s3-bucket` オプションまたは `--resolve-s3` オプションは必須です。`--s3-bucket` と `--resolve-s3` の両方のオプションを指定するとエラーが発生します。

`--s3-prefix TEXT`  <a name="ref-sam-cli-deploy-options-s3-prefix"></a>
Amazon S3 バケットにアップロードされるアーティファクト名に追加されたプレフィックスです。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。

`--save-params`  <a name="ref-sam-cli-deploy-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--signing-profiles LIST`  <a name="ref-sam-cli-deploy-options-signing-profiles"></a>
デプロイパッケージに署名するための署名プロファイルのリストです。このオプションはキーバリューペアのリストを使用します。このペアのキーは署名する関数またはレイヤーの名前、値は署名プロファイルで、オプションのプロファイル所有者は `:` で区切られます。例えば、`FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`。

`--stack-name TEXT`  <a name="ref-sam-cli-deploy-options-stack-name"></a>
(必須) デプロイ先の CloudFormation スタックの名前。既存のスタックを指定すると、コマンドはスタックを更新します。新しいスタックを指定すると、コマンドはスタックを作成します。

`--tags LIST`  <a name="ref-sam-cli-deploy-options-tags"></a>
作成または更新されたスタックに関連付けるタグのリスト。 は、これらのタグをサポートしているスタック内のリソース CloudFormation にも伝播します。

`--template-file, --template, -t PATH`  <a name="ref-sam-cli-deploy-options-template-file"></a>
 AWS SAM テンプレートがあるパスとファイル名。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM デプロイします。

`--use-json`  <a name="ref-sam-cli-deploy-options-use-json"></a>
 CloudFormation テンプレートの JSON を出力します。デフォルトの出力は YAML です。

## 例
<a name="sam-cli-command-reference-sam-deploy-examples"></a>

`sam deploy` サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「[を使用したデプロイの概要 AWS SAM](using-sam-cli-deploy.md)」を参照してください。

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam init` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam init` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[でアプリケーションを作成する AWS SAM](using-sam-cli-init.md)。

`sam init` コマンドには、新しいサーバーレス アプリケーションを初期化するためのオプションがあります。

## Usage
<a name="sam-cli-command-reference-sam-init-usage"></a>

```
$ sam init <options>
```

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

`--app-template TEXT`  <a name="sam-cli-command-reference-sam-init-options-app-template"></a>
使用するマネージドアプリケーションテンプレートの識別子です。よくわからない場合は、インタラクティブなワークフローのオプションを指定せずに `sam init` を呼び出します。  
このパラメータは、`--no-interactive` が指定され、`--location` が指定されていない場合に必要です。  
このパラメータは、0.30.0 以降の AWS SAM CLI バージョンのみで利用できます。それより前のバージョンでこのパラメータを指定すると、エラーが発生します。

`--application-insights | --no-application-insights`  <a name="sam-cli-command-reference-sam-init-options-application-insights"></a>
 アプリケーションでの Amazon CloudWatch Application Insights のモニタリングを有効にします。詳細については[CloudWatch Application Insights を使用して AWS SAM サーバーレスアプリケーションをモニタリングする](monitor-app-insights.md)を参照してください。  
 デフォルトのオプションは `--no-application-insights` です。

`--architecture, -a [ x86_64 | arm64 ]`  <a name="sam-cli-command-reference-sam-init-options-architecture"></a>
アプリケーションの Lambda 関数の命令セットアーキテクチャ。`x86_64` または `arm64` のいずれかを指定します。

`--base-image [ amazon/dotnet8-base | amazon/dotnet6-base | amazon/java25-base | amazon/java21-base | amazon/java17-base | amazon/java11-base | amazon/nodejs24.x-base | amazon/nodejs22.x-base | amazon/nodejs20.x-base | amazon/nodejs18.x-base | amazon/nodejs16.x-base | amazon/python3.14-base | amazon/python3.13-base | amazon/python3.12-base | amazon/python3.11-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/ruby3.4-base | amazon/ruby3.3-base | amazon/ruby3.2-base ]`  <a name="sam-cli-command-reference-sam-init-options-base-image"></a>
アプリケーションのベースイメージです。このオプションは、パッケージタイプが `Image` の場合のみに適用されます。  
このパラメータは、`--no-interactive` が指定されている、`--package-type` が `Image` として指定されている、および `--location` が指定されていない場合に必要です。

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-init-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-init-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-init-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

`--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]`  <a name="sam-cli-command-reference-sam-init-options-dependency-manager"></a>
Lambda ランタイムの依存関係マネージャーです。

`--extra-content`  <a name="sam-cli-command-reference-sam-init-options-extra-content"></a>
テンプレートの `cookiecutter.json` 設定にあるカスタムパラメータ (`{"customParam1": "customValue1", "customParam2":"customValue2"}` など) を上書きします。

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

`--location, -l TEXT`  <a name="sam-cli-command-reference-sam-init-options-location"></a>
テンプレートまたはアプリケーションの場所 (Git、Mercurial、HTTP/HTTPS、zip ファイル、パス) です。  
このパラメータは、`--no-interactive` が指定されていて、`--runtime`、`--name`、および `--app-template` が提供されていない場合に必要です。  
Git リポジトリの場合は、リポジトリのルートの場所を使用する必要があります。  
ローカルパスの場合、テンプレートは.zip ファイルまたは [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html) 形式にする必要があります。

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-init-options-name"></a>
ディレクトリとして生成されるプロジェクトの名前です。  
このパラメータは、`--no-interactive` が指定され、`--location` が指定されていない場合に必要です。

`--no-input`  <a name="sam-cli-command-reference-sam-init-options-no-input"></a>
Cookiecutter プロンプトを無効にし、テンプレート設定で定義されている vcfdefault 値を受け入れます。

`--no-interactive`  <a name="sam-cli-command-reference-sam-init-options-no-interactive"></a>
init パラメータのインタラクティブなプロンプトを無効にし、必要な値が欠落している場合は失敗します。

`--output-dir, -o PATH`  <a name="sam-cli-command-reference-sam-init-options-output-dir"></a>
初期化されたアプリケーションが出力される場所です。

`--package-type [ Zip | Image ]`  <a name="sam-cli-command-reference-sam-init-options-package-type"></a>
サンプルアプリケーションのパッケージタイプです。`Zip` は .zip ファイルアーカイブを作成し、`Image` はコンテナイメージを作成します。

`--runtime, -r [ dotnet8 | dotnet6 | java25 | java21 | java17 | java11 | nodejs24.x | nodejs22.x | nodejs20.x | nodejs18.x | nodejs16.x | python3.14 | python3.13 | python3.12 | python3.11 | python3.10 | python3.9 | python3.8 | ruby3.4 | ruby3.3 | ruby3.2 ]`  <a name="sam-cli-command-reference-sam-init-options-runtime"></a>
アプリケーションの Lambda ランタイムです。このオプションは、パッケージタイプが `Zip` の場合のみに適用されます。  
このパラメータは、`--no-interactive` が指定されている、`--package-type` が `Zip` として指定されている、および `--location` が指定されていない場合に必要です。

`--save-params`  <a name="sam-cli-command-reference-sam-init-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--tracing | --no-tracing`  <a name="sam-cli-command-reference-sam-init-options-tracing"></a>
Lambda 関数の AWS X-Ray トレースを有効にします。

## 例
<a name="sam-cli-command-reference-sam-init-examples"></a>

`sam init` サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「[でアプリケーションを作成する AWS SAM](using-sam-cli-init.md)」を参照してください。

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

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

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

`sam list` コマンドは、サーバーレスアプリケーションのリソースとサーバーレスアプリケーションの状態に関する重要な情報を出力します。デプロイの前後に **sam list** を使用して、ローカルおよびクラウドの開発をサポートします。

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

```
$ sam list <options> <subcommand>
```

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

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

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

`endpoints`  <a name="sam-cli-command-reference-sam-list-subcommands-endpoints"></a>
 CloudFormation スタックのクラウドエンドポイントとローカルエンドポイントのリストを表示します。詳細については、「[sam list endpoints](sam-cli-command-reference-sam-list-endpoints.md)」を参照してください。

`resources`  <a name="sam-cli-command-reference-sam-list-subcommands-resources"></a>
デプロイ AWS CloudFormation 時に で作成されたリソースを AWS Serverless Application Model (AWS SAM) テンプレートに表示します。詳細については、「[sam list resources](sam-cli-command-reference-sam-list-resources.md)」を参照してください。

`stack-outputs`  <a name="sam-cli-command-reference-sam-list-subcommands-stack-outputs"></a>
 AWS SAM または CloudFormation テンプレートからの CloudFormation スタックの出力を表示します。詳細については、「[sam list stack-outputs](sam-cli-command-reference-sam-list-stack-outputs.md)」を参照してください。

# sam list endpoints
<a name="sam-cli-command-reference-sam-list-endpoints"></a>

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

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

`sam list endpoints` サブコマンドには、 CloudFormation スタックのクラウドエンドポイントとローカルエンドポイントのリストが表示されます。**sam local** および **sam sync** コマンドを使用して、これらのリソースを操作できます。

AWS Lambda および Amazon API Gateway リソースタイプは、このコマンドでサポートされています。

**注記**  
カスタムドメインは、Amazon API Gateway リソース用に設定されている場合にサポートされます。このコマンドは、デフォルトのエンドポイントの代わりにカスタムドメインを出力します。

## Usage
<a name="sam-cli-command-reference-sam-list-endpoints-usage"></a>

```
$ sam list endpoints <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。  
*デフォルト値*: `default`  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。  
*デフォルト値*: 現在の作業ディレクトリ内の `samconfig.toml`。  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-list-endpoints-options-debug"></a>
デバッグログ記録をオンにして、 AWS SAM CLI によって生成されたデバッグメッセージをタイムスタンプ付きで出力します。

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

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-endpoints-options-output"></a>
結果を出力する形式を指定します。  
*デフォルト値*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-profile"></a>
認証情報ファイルから特定のプロファイルを選択して、 AWS 認証情報を取得します。

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-region"></a>
サービスの AWS リージョンを設定します。例えば、`us-east-1`。

`--save-params`  <a name="sam-cli-command-reference-sam-list-endpoints-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-endpoints-options-stack-name"></a>
デプロイされた CloudFormation スタックの名前。スタック名は、アプリケーションの `samconfig.toml` ファイルまたは指定された設定ファイルで見つけることができます。  
このオプションが指定されていない場合、テンプレートで定義されているローカルリソースが表示されます。

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-list-endpoints-options-template"></a>
AWS SAM テンプレートファイル。  
*デフォルト値*: `template.[yaml|yml|json]`

## 例
<a name="sam-cli-command-reference-sam-list-endpoints-examples"></a>

という名前の CloudFormation スタックからデプロイされたリソースエンドポイントの出力を JSON 形式で表示します`test-stack`。

```
$ sam list endpoints --stack-name test-stack --output json
			
[
  {
    "LogicalResourceId": "HelloWorldFunction",
    "PhysicalResourceId": "sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq",
    "CloudEndpoint": "https://zt55oi7kbljxjmcoahsj3cknwu0rposq.lambda-url.us-east-1.on.aws/",
    "Methods": "-"
  },
  {
    "LogicalResourceId": "ServerlessRestApi",
    "PhysicalResourceId": "uj80uoe2o2",
    "CloudEndpoint": [
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Prod",
      "https://uj80uoe2o2.execute-api.us-east-1.amazonaws.com/Stage"
    ],
    "Methods": [
      "/hello['get']"
    ]
  }
]
```

# sam list resources
<a name="sam-cli-command-reference-sam-list-resources"></a>

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

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

`sam list resources` サブコマンドは、デプロイ時に変換 AWS CloudFormation によって で作成された AWS Serverless Application Model (AWS SAM) テンプレート内の AWS SAM リソースを表示します。

デプロイ前に AWS SAM テンプレート**sam list resources**で を使用して、作成されるリソースを確認します。 CloudFormation スタック名を指定して、デプロイされたリソースを含む統合リストを表示します。

**注記**  
 AWS SAM テンプレートからリソースのリストを生成するには、テンプレートのローカル変換が実行されます。このリストには、特定のリージョン内など、条件付きでデプロイされるリソースが含まれます。

## Usage
<a name="sam-cli-command-reference-sam-list-resources-usage"></a>

```
$ sam list resources <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。  
*デフォルト値*: `default`  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。  
*デフォルト値*: 現在の作業ディレクトリ内の `samconfig.toml`。  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-list-resources-options-debug"></a>
デバッグログ記録をオンにして、 AWS SAM CLI によって生成されたデバッグメッセージをタイムスタンプ付きで出力します。

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

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-resources-options-output"></a>
結果を出力する形式を指定します。  
*デフォルト値*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-profile"></a>
認証情報ファイルから特定のプロファイルを選択して、 AWS 認証情報を取得します。

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-region"></a>
サービスの AWS リージョンを設定します。例えば、`us-east-1`。

`--save-params`  <a name="sam-cli-command-reference-sam-list-resources-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-resources-options-stack-name"></a>
デプロイされた CloudFormation スタックの名前。スタック名は、アプリケーションの `samconfig.toml` ファイルまたは指定された設定ファイルで見つけることができます。  
指定されると、テンプレートのリソース論理 ID が CloudFormationの対応する物理 ID にマッピングされます。物理 ID の詳細については、「AWS CloudFormation ユーザーガイド」の「[リソースフィールド](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-resource-fields)」を参照してください。  
このオプションが指定されていない場合、テンプレートで定義されているローカルリソースが表示されます。

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-list-resources-options-"></a>
AWS SAM テンプレートファイル。  
*デフォルト値*: `template.[yaml|yml|json]`

## 例
<a name="sam-cli-command-reference-sam-list-resources-examples"></a>

テンプレートのローカルリソース AWS SAM と、 という名前の CloudFormation スタックからデプロイされたリソースの出力をテーブル形式で表示します`test-stack`。ローカルテンプレートと同じディレクトリから実行します。

```
$ sam list resources --stack-name test-stack --output table
			
-------------------------------------------------------------------------------------------------------------------------
Logical ID                                                   Physical ID
-------------------------------------------------------------------------------------------------------------------------
HelloWorldFunction                                           sam-app-test-list-HelloWorldFunction-H85Y7yIV7ZLq
HelloWorldFunctionHelloWorldPermissionProd                   sam-app-test-list-
                                                             HelloWorldFunctionHelloWorldPermissionProd-1QH7CPOCBL2IK
HelloWorldFunctionRole                                       sam-app-test-list-HelloWorldFunctionRole-SRJDMJ6F7F41
ServerlessRestApi                                            uj80uoe2o2
ServerlessRestApiDeployment47fc2d5f9d                        pncw5f
ServerlessRestApiProdStage                                   Prod
ServerlessRestApiDeploymentf5716dc08b                        -
-------------------------------------------------------------------------------------------------------------------------
```

# sam list stack-outputs
<a name="sam-cli-command-reference-sam-list-stack-outputs"></a>

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

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

`sam list stack-outputs` サブコマンドは、 AWS Serverless Application Model (AWS SAM) または CloudFormation テンプレートからの AWS CloudFormation スタックの出力を表示します。`Outputs` の詳細については、「*AWS CloudFormation ユーザーガイド*」の「[出力](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html)」を参照してください。

## Usage
<a name="sam-cli-command-reference-sam-list-stack-outputs-usage"></a>

```
$ sam list stack-outputs <options>
```

## オプション
<a name="sam-cli-command-reference-sam-list-stack-outputs-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。  
*デフォルト値*: `default`  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。  
*デフォルト値*: 現在の作業ディレクトリ内の `samconfig.toml`。  
設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-debug"></a>
デバッグログ記録をオンにして、 AWS SAM CLI によって生成されたデバッグメッセージをタイムスタンプ付きで出力します。

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

`--output [json|table]`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-output"></a>
結果を出力する形式を指定します。  
*デフォルト値*: `table`

`--profile TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-profile"></a>
認証情報ファイルから特定のプロファイルを選択して、 AWS 認証情報を取得します。

`--region TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-region"></a>
サービスの AWS リージョンを設定します。例えば、`us-east-1`。

`--save-params`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-list-stack-outputs-options-"></a>
デプロイされた CloudFormation スタックの名前。スタック名は、アプリケーションの `samconfig.toml` ファイルまたは指定された設定ファイルで見つけることができます。  
このオプションは必須です。

## 例
<a name="sam-cli-command-reference-sam-list-stack-outputs-examples"></a>

という名前の CloudFormation スタック内のリソースの出力をテーブル形式で表示します`test-stack`。

```
$ sam list stack-outputs --stack-name test-stack --output table
			
------------------------------------------------------------------------------------------------------------------------
OutputKey                                OutputValue                              Description
------------------------------------------------------------------------------------------------------------------------
HelloWorldFunctionIamRole                arn:aws:iam::account-number:role/sam-      Implicit IAM Role created for Hello
                                         app-test-list-HelloWorldFunctionRole-    World function
                                         SRJDMJ6F7F41
HelloWorldApi                            https://uj80uoe2o2.execute-api.us-       API Gateway endpoint URL for Prod
                                         east-1.amazonaws.com/Prod/hello/         stage for Hello World function
HelloWorldFunction                       arn:aws:lambda:us-                       Hello World Lambda Function ARN
                                         east-1:account-number:function:sam-app-
                                         test-list-
                                         HelloWorldFunction-H85Y7yIV7ZLq
------------------------------------------------------------------------------------------------------------------------
```

# 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
```

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

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

の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](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 認証情報へのアクセスを必要としない場合があります。

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

`-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>

永続的な関数実行の実行履歴を取得します。

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

`-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 認証情報へのアクセスを必要としない場合があります。

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

`-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()"
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local generate-event`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam local generate-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam local generate-event を使用したテストの概要](using-sam-cli-local-generate-event.md)。

`sam local generate-event` サブコマンドは、サポートされている AWS のサービスのイベントペイロードサンプルを生成します。

## Usage
<a name="ref-sam-cli-local-generate-event-usage"></a>

```
$ sam local generate-event <options> <service> <event> <event-options>
```

## オプション
<a name="ref-sam-cli-local-generate-event-options"></a>

`--config-env TEXT`  <a name="ref-sam-cli-local-generate-event-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-local-generate-event-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--help`  <a name="ref-sam-cli-local-generate-event-options-help"></a>
このメッセージを表示して終了します。

## サービス
<a name="ref-sam-cli-local-generate-event-service"></a>

サポートされているサービスのリストを表示するには、次を実行します。

```
$ sam local generate-event
```

## [Event] (イベント)
<a name="ref-sam-cli-local-generate-event-event"></a>

各サービスについて生成できるサポート対象のイベントのリストを表示するには、次を実行します。

```
$ sam local generate-event <service>
```

## イベントオプション
<a name="ref-sam-cli-local-generate-event-event-options"></a>

変更できるサポート対象のイベントオプションのリストを表示するには、次を実行します。

```
$ sam local generate-event <service> <event> --help
```

## 例
<a name="sam-cli-command-reference-sam-local-generate-event-examples"></a>

`sam local generate-event` サブコマンドの使用例については、「[サンプルイベントを生成する](using-sam-cli-local-generate-event.md#using-sam-cli-local-generate-event-generate)」を参照してください。

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local invoke`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam local invoke` サブコマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam local invoke を使用したテストの概要](using-sam-cli-local-invoke.md)。

`sam local invoke` サブコマンドは、 AWS Lambda 関数の 1 回限りの呼び出しをローカルで開始します。

**注記**  
信頼できないコードで SAM CLI のローカル呼び出し機能を使用することはお勧めしません。ローカル環境から完全に分離するには、Lambda サービスでコードを直接実行します。

**注記**  
耐久性のある関数の場合、 は自動チェックポイントとリプレイによるステートフル実行`sam local invoke`をサポートします。コンテナは、永続的な関数の実行中に実行され続け、状態の永続化と再開を処理します。

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

```
$ sam local invoke <arguments> <options>
```

**注記**  
 AWS SAM テンプレートに複数の関数が定義されている場合は、呼び出す関数の論理 ID を指定します。

## 引数
<a name="ref-sam-cli-local-invoke-args"></a>

**Resource ID (リソース ID)**  <a name="ref-sam-cli-local-invoke-args-resource-id"></a>
呼び出す Lambda 関数の ID。  
この引数はオプションです。アプリケーションに 1 つの Lambda 関数が含まれている場合、CLI AWS SAM はその関数を呼び出します。アプリケーションに複数の関数が含まれている場合は、呼び出す関数の ID を指定します。  
有効な値: リソースの論理 ID またはリソース ARN。

## オプション
<a name="ref-sam-cli-local-invoke-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-invoke-options-add-host"></a>
Docker コンテナのホストファイルへの IP アドレスマッピングに、ホスト名を渡します。このパラメータは、複数回渡すことができます。  

**Example**  
例: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-invoke-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--config-env TEXT`  <a name="ref-sam-cli-local-invoke-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-local-invoke-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--container-env-vars`  <a name="ref-sam-cli-local-invoke-options-container-env-vars"></a>
(オプション) ローカルでデバッグするときに、環境変数を Lambda 関数イメージコンテナに渡します。

`--container-host TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host"></a>
ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は `localhost` です。macOS 上の Docker コンテナで AWS SAM CLI を実行する場合は、`host.docker.internal` を指定できます。コンテナを とは異なるホストで実行する場合は AWS SAM CLI、リモートホストの IP アドレスを指定できます。

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-invoke-options-container-host-interface"></a>
コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は `127.0.0.1` です。`0.0.0.0` を使用して、すべてのインターフェイスにバインドします。

`--debug`  <a name="ref-sam-cli-local-invoke-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

`--debug-args TEXT`  <a name="ref-sam-cli-local-invoke-options-debug-args"></a>
デバッガーに渡す追加の引数です。

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-invoke-options-debug-port"></a>
これを指定すると、Lambda 関数コンテナがデバッグモードで起動され、このポートがローカルホストに公開されます。

`--debugger-path TEXT`  <a name="ref-sam-cli-local-invoke-options-debugger-path"></a>
Lambda コンテナにマウントされたデバッガーへのホストパスです。

`--docker-network TEXT`  <a name="ref-sam-cli-local-invoke-options-docker-network"></a>
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークだけに接続します。

`--docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-invoke-options-docker-volume-basedir"></a>
 AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシンに AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。

`--durable-execution-name TEXT`  <a name="ref-sam-cli-local-invoke-options-durable-execution-name"></a>
永続的な実行の名前 (永続的な関数のみ)

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-invoke-options-env-vars"></a>
Lambda 関数の環境変数の値を含む JSON または `.env` ファイル。ファイル形式が自動的に検出されます。環境変数ファイルの詳細については、「[環境変数ファイル](serverless-sam-cli-using-invoke.md#serverless-sam-cli-using-invoke-environment-file)」を参照してください。

`--event, -e PATH`  <a name="ref-sam-cli-local-invoke-options-event"></a>
呼び出されたときに Lambda 関数に渡されるイベントデータが含まれる JSON ファイルです。このオプションを指定しない場合、イベントは想定されません。`stdin` からの JSON を入力するには、値「-」を渡す必要があります。さまざまな AWS サービスのイベントメッセージ形式の詳細については、「 *AWS Lambda デベロッパーガイド*」の[「他の のサービスの使用](https://docs.aws.amazon.com/lambda/latest/dg/lambda-services.html)」を参照してください。

`--force-image-build`  <a name="ref-sam-cli-local-invoke-options-force-image-build"></a>
レイヤーがある Lambda 関数を呼び出すために使用されるイメージを AWS SAM CLI が再構築すべきかどうかを指定します。

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

`--hook-name TEXT`  <a name="ref-sam-cli-local-invoke-options-hook-name"></a>
 AWS SAM CLI 機能の拡張に使用されるフックの名前。  
許容値: `terraform`。

`--invoke-image TEXT`  <a name="ref-sam-cli-local-invoke-options-invoke-image"></a>
ローカル関数の呼び出しに使用するコンテナーイメージの URI。デフォルトで、 AWS SAM は Amazon ECR Public ([のイメージリポジトリ AWS SAM](serverless-image-repositories.md) に一覧を記載) からコンテナイメージをプルします。このオプションは、別の場所からイメージをプルするために使用します。  
例えば、`sam local invoke MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`。

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-invoke-options-layer-cache-basedir"></a>
テンプレートで使用するレイヤーがダウンロードされるベースディレクトリの場所を指定します。

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-invoke-options-log-file"></a>
ランタイムログを送信するログファイルです。

`--mount-symlinks`  <a name="ref-sam-cli-local-invoke-options-mount-symlinks"></a>
 AWS SAMCLI は、ビルドまたは呼び出すファイルに存在するシンボリックリンクを常にマウントします。これは、最上位ディレクトリのシンボリックリンク (つまり、関数のルートに直接あるシンボリックリンク) にのみ適用されます。デフォルトでは、シンボリックリンクは、NodeJS で `node_modules` の `build-in-source` を使用するために必要なものを除いてマウントされません。

`--no-event`  <a name="ref-sam-cli-local-invoke-options-no-event"></a>
空のイベントを使用して関数を呼び出します。

`--no-memory-limit`  <a name="ref-sam-cli-local-invoke-options-no-memory-limit"></a>
 AWS SAM テンプレートでメモリが設定されている場合でも、ローカル呼び出し中にコンテナのメモリ制限を削除します。

`--parameter-overrides`  <a name="ref-sam-cli-local-invoke-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。 AWS SAM CLI 形式は明示的なキーと値のキーワードで構成され、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--profile TEXT`  <a name="ref-sam-cli-local-invoke-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-local-invoke-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--runtime TEXT`  <a name="ref-sam-cli-local-invoke-options-runtime"></a>
指定されたランタイムを使用して、Lambda 関数をローカルで呼び出します。これにより、`template.yml` ファイルで定義されているランタイムが上書きされます。また、元の関数設定を変更することなく、異なるランタイムで Lambda 関数をテストすることも可能になります。

`--save-params`  <a name="ref-sam-cli-local-invoke-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--shutdown`  <a name="ref-sam-cli-local-invoke-options-shutdown"></a>
シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。

`--skip-prepare-infra`  <a name="ref-sam-cli-local-invoke-options-skip-prepare-infra"></a>
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。`--hook-name` オプションと合わせて使用します。

`--skip-pull-image`  <a name="ref-sam-cli-local-invoke-options-skip-pull-image"></a>
デフォルトでは、 AWS SAM CLI は Lambda の最新のリモートランタイム環境を確認し、ローカルイメージを自動的に更新して同期を維持します。  
このオプションを指定して、Lambda ランタイム環境の最新の Docker イメージのプルダウンをスキップします。

`--template, -t PATH`  <a name="ref-sam-cli-local-invoke-options-template"></a>
 AWS SAM テンプレートファイル。  
このオプションは `--hook-name` と互換性がありません。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM ロードします。

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
マルチテナント Lambda 関数のテナント ID。異なるテナント間のコンピューティング分離を確保するために使用されます。テナント分離モードで設定された関数を呼び出すときに必要です。

`--terraform-plan-file`  <a name="ref-sam-cli-local-invoke-options-terraform-plan-file"></a>
Terraform Cloud で AWS SAMCLI を使用する場合のローカル Terraform プランファイルへの相対パスまたは絶対パス。このオプションは `--hook-name` を `terraform` に設定する必要があります。

## 例
<a name="sam-cli-command-reference-sam-local-invoke-examples"></a>

次の例では、`s3.json` イベントを使用して Lambda 関数をローカルで呼び出すことで、生成されたイベントをローカルテストに使用します。

```
$ sam local invoke --event events/s3.json S3JsonLoggerFunction
```

次の例では、Python 3.11 ランタイムを使用して ` HelloWorldFunction` 関数をテストします。

```
$ sam local invoke --runtime python3.11 HelloWorldFunction
```

次の例では、耐久性のある実行名` HelloWorldFunction`で関数をテストします。

```
$ sam local invoke HelloWorldFunction --durable-execution-name my-execution
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local start-api`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam local start-api` サブコマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam local start-api を使用したテストの概要](using-sam-cli-local-start-api.md)。

`sam local start-api` サブコマンドは AWS Lambda 、関数をローカルで実行して、ローカル HTTP サーバーホストを介してテストします。

## Usage
<a name="ref-sam-cli-local-start-api-usage"></a>

```
$ sam local start-api <options>
```

## オプション
<a name="ref-sam-cli-local-start-api-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-api-options-add-host"></a>
Docker コンテナのホストファイルへの IP アドレスマッピングに、ホスト名を渡します。このパラメータは、複数回渡すことができます。  

**Example**  
例: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-api-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--config-env TEXT`  <a name="ref-sam-cli-local-start-api-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-local-start-api-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--container-env-vars`  <a name="ref-sam-cli-local-start-api-options-container-env-vars"></a>
オプション。ローカルでデバッグする時に、環境変数をイメージコンテナに渡します。

`--container-host TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host"></a>
ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は `localhost` です。macOS 上の Docker コンテナで AWS SAM CLI を実行する場合は、`host.docker.internal` を指定できます。コンテナを とは異なるホストで実行する場合は AWS SAM CLI、リモートホストの IP アドレスを指定できます。

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-api-options-container-host-interface"></a>
コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は `127.0.0.1` です。`0.0.0.0` を使用して、すべてのインターフェイスにバインドします。

`--debug`  <a name="ref-sam-cli-local-start-api-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-args"></a>
デバッガーに渡される追加の引数です。

`--debug-function`  <a name="ref-sam-cli-local-start-api-options-debug-function"></a>
オプション。`--warm-containers` が指定されているときにデバッグオプションを適用する Lambda 関数を指定します。このパラメータは、`--debug-port`、`--debugger-path`、および `--debug-args` に適用されます。

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-api-options-debug-port"></a>
これを指定すると、Lambda 関数コンテナがデバッグモードで起動され、このポートがローカルホストに公開されます。

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-api-options-debugger-path"></a>
Lambda コンテナにマウントされるデバッガーへのホストパスです。

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-network"></a>
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークのみに接続します。

` --docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-api-options-docker-volume-basedir"></a>
 AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシンに AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-api-options-env-vars"></a>
Lambda 関数の環境変数の値を含む JSON または `.env` ファイル。ファイル形式が自動的に検出されます。

`--force-image-build`  <a name="ref-sam-cli-local-start-api-options-force-image-build"></a>
がレイヤーで関数を呼び出すために使用されるイメージを再構築するかどうか AWS SAM CLIを指定します。

`--help`  <a name="ref-sam-cli-local-start-api-options-help"></a>
このメッセージを表示して終了します。

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-api-options-hook-name"></a>
 AWS SAM CLI 機能の拡張に使用されるフックの名前。  
許容値: `terraform`。

`--host TEXT`  <a name="ref-sam-cli-local-start-api-options-host"></a>
バインド先のローカルホスト名または IP アドレス (デフォルト:「127.0.0.1」)。

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-api-options-invoke-image"></a>
Lambda 関数に使用するコンテナイメージの URI。デフォルトでは、 は Amazon ECR Public からコンテナイメージ AWS SAM をプルします。このオプションは、別の場所からイメージをプルするために使用します。  
このオプションは複数回指定できます。このオプションの各インスタンスには、文字列またはキーバリューペアを使用できます。文字列を指定する場合は、アプリケーション内のすべての関数に使用するコンテナイメージの URI になります。例えば、`sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8`。キーバリューペアを指定する場合、キーはリソース名で、値はそのリソースに使用するコンテナイメージの URI です。例えば、`sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 ` です。キーバリューペアを使用すると、異なるリソースに異なるコンテナイメージを指定できます。

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-api-options-layer-cache-basedir"></a>
テンプレートで使用されるレイヤーがダウンロードされる場所である basedir を指定します。

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-api-options-log-file"></a>
ランタイムログを送信するログファイルです。

`--no-memory-limit`  <a name="ref-sam-cli-local-start-api-options-no-memory-limit"></a>
 AWS SAM テンプレートでメモリが設定されている場合でも、ローカル呼び出し中にコンテナのメモリ制限を削除します。

`--parameter-overrides`  <a name="ref-sam-cli-local-start-api-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。 AWS SAM CLI 形式は明示的なキーと値のキーワードで構成され、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-api-options-port"></a>
リッスンするローカルポート番号 (デフォルト:「3000」)。

`--profile TEXT`  <a name="ref-sam-cli-local-start-api-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-local-start-api-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="ref-sam-cli-local-start-api-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--shutdown`  <a name="ref-sam-cli-local-start-api-options-shutdown"></a>
シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-api-options-skip-prepare-infra"></a>
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。`--hook-name` オプションと合わせて使用します。

`--skip-pull-image`  <a name="ref-sam-cli-local-start-api-options-skip-pull-image"></a>
Lambda ランタイムの最新 Docker イメージのプルダウンを CLI がスキップすべきかどうかを指定します。

`--ssl-cert-file PATH`  <a name="ref-sam-cli-local-start-api-options-ssl-cert-file"></a>
SSL 証明書ファイルへのパス (デフォルト: なし）。このオプションを使用する場合は、`--ssl-key-file` オプションも使用する必要があります。

`--ssl-key-file PATH`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
SSL キーファイルへのパス (デフォルト: なし）。このオプションを使用する場合は、`--ssl-cert-file` オプションも使用する必要があります。

`--static-dir, -s TEXT`  <a name="ref-sam-cli-local-start-api-options-static-dir"></a>
このディレクトリにある静的アセット (CSS/JavaScript/HTML など) ファイルは、`/` に表示されます。

`--template, -t PATH`  <a name="ref-sam-cli-local-start-api-options-template"></a>
 AWS SAM テンプレートファイル。  
このオプションを指定すると、 は、テンプレートとそれが指すローカルリソースのみを AWS SAM ロードします。

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-api-options-terraform-plan-file"></a>
Terraform Cloud で AWS SAMCLI を使用する場合のローカル Terraform プランファイルへの相対パスまたは絶対パス。このオプションは `--hook-name` を `terraform` に設定する必要があります。

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-api-options-warm-containers"></a>
オプション。 AWS SAM CLI が各関数のコンテナを管理する方法を指定します。  
以下の 2 つのオプションを使用できます。  
   `EAGER`: 起動時にすべての関数のコンテナがロードされ、呼び出し間で保持されます。  
   `LAZY`: 各関数が初めて呼び出される場合に限り、コンテナがロードされます。これらのコンテナは、追加の呼び出し用に保持されます。

## 例
<a name="sam-cli-command-reference-sam-local-start-api-examples"></a>

次の例では、ローカルサーバーを起動して、API 経由でアプリケーションをテストできるようにします。このコマンドを機能させるには、アプリケーションがインストール済みで、Docker が実行中である必要があります。

```
$ sam local start-api --port 3000
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local start-lambda`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam local start-lambda` サブコマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam local start-lambda を使用したテストの概要](using-sam-cli-local-start-lambda.md)。

`sam local start-lambda` サブコマンドは、 AWS Lambdaをエミュレートするローカルエンドポイントを起動します。

## 使用方法
<a name="ref-sam-cli-local-start-lambda-usage"></a>

```
$ sam local start-lambda <options>
```

## オプション
<a name="ref-sam-cli-local-start-lambda-options"></a>

`--add-host LIST`  <a name="ref-sam-cli-local-start-lambda-options-add-host"></a>
Docker コンテナのホストファイルへの IP アドレスマッピングに、ホスト名を渡します。このパラメータは、複数回渡すことができます。  

**Example**  
例: `--add-host example.com:127.0.0.1`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-lambda-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--config-env TEXT`  <a name="ref-sam-cli-local-start-lambda-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="ref-sam-cli-local-start-lambda-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--container-env-vars`  <a name="ref-sam-cli-local-start-lambda-options-container-env-vars"></a>
オプション。ローカルでデバッグする時に、環境変数をイメージコンテナに渡します。

`--container-host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host"></a>
ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は `localhost` です。macOS 上の Docker コンテナで AWS SAM CLI を実行する場合は、`host.docker.internal` を指定できます。コンテナを とは異なるホストで実行する場合は AWS SAM CLI、リモートホストの IP アドレスを指定できます。

`--container-host-interface TEXT`  <a name="ref-sam-cli-local-start-lambda-options-container-host-interface"></a>
コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は `127.0.0.1` です。`0.0.0.0` を使用して、すべてのインターフェイスにバインドします。

`--debug`  <a name="ref-sam-cli-local-start-lambda-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--debug-args TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-args"></a>
デバッガーに渡される追加の引数です。

`--debug-function`  <a name="ref-sam-cli-local-start-lambda-options-debug-function"></a>
オプション。`--warm-containers` が指定されているときにデバッグオプションを適用する Lambda 関数を指定します。このパラメータは、`--debug-port`、`--debugger-path`、および `--debug-args` に適用されます。

`--debug-port, -d TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debug-port"></a>
指定すると、Lambda 関数コンテナをデバッグモードで起動し、このポートをローカルホストに公開します。

`--debugger-path TEXT`  <a name="ref-sam-cli-local-start-lambda-options-debugger-path"></a>
Lambda コンテナにマウントされるデバッガーへのホストパス。

`--docker-network TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-network"></a>
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定すると、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。

`--docker-volume-basedir, -v TEXT`  <a name="ref-sam-cli-local-start-lambda-options-docker-volume-basedir"></a>
 AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシンに AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。

`--env-vars, -n PATH`  <a name="ref-sam-cli-local-start-lambda-options-env-vars"></a>
Lambda 関数の環境変数の値を含む JSON または `.env` ファイル。ファイル形式が自動的に検出されます。

`--force-image-build`  <a name="ref-sam-cli-local-start-lambda-options-force-image-build"></a>
レイヤーを使用して関数を呼び出すために使用されるイメージを CLI が再構築すべきかどうかを指定します。

`--help`  <a name="ref-sam-cli-local-start-lambda-options-help"></a>
このメッセージを表示して終了します。

`--hook-name TEXT`  <a name="ref-sam-cli-local-start-lambda-options-hook-name"></a>
 AWS SAM CLI 機能の拡張に使用されるフックの名前。  
許容値: `terraform`。

`--host TEXT`  <a name="ref-sam-cli-local-start-lambda-options-host"></a>
バインド先のローカルホスト名または IP アドレス (デフォルト:「127.0.0.1」)。

`--invoke-image TEXT`  <a name="ref-sam-cli-local-start-lambda-options-invoke-image"></a>
ローカル関数の呼び出しに使用するコンテナーイメージの URI。デフォルトでは、 は Amazon ECR Public からコンテナイメージ AWS SAM をプルします。このオプションは、別の場所からイメージをプルするために使用します。  
例えば、`sam local start-lambda MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8`。

`--layer-cache-basedir DIRECTORY`  <a name="ref-sam-cli-local-start-lambda-options-layer-cache-basedir"></a>
テンプレートで使用されるレイヤーがダウンロードされる場所である basedir を指定します。

`--log-file, -l TEXT`  <a name="ref-sam-cli-local-start-lambda-options-log-file"></a>
ランタイムログを送信するログファイルです。

`--no-memory-limit`  <a name="ref-sam-cli-local-start-lambda-options-no-memory-limit"></a>
 AWS SAM テンプレートでメモリが設定されている場合でも、ローカル呼び出し中にコンテナのメモリ制限を削除します。

`--parameter-overrides`  <a name="ref-sam-cli-local-start-lambda-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。 AWS SAM CLI 形式は明示的なキーと値のキーワードで構成され、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--port, -p INTEGER`  <a name="ref-sam-cli-local-start-lambda-options-port"></a>
リッスンするローカルポート番号 (デフォルト: 「3001」)。

`--profile TEXT`  <a name="ref-sam-cli-local-start-lambda-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="ref-sam-cli-local-start-lambda-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="ref-sam-cli-local-start-lambda-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--shutdown`  <a name="ref-sam-cli-local-start-lambda-options-shutdown"></a>
シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-lambda-options-skip-prepare-infra"></a>
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。`--hook-name` オプションと合わせて使用します。

`--skip-pull-image`  <a name="ref-sam-cli-local-start-lambda-options-skip-pull-image"></a>
Lambda ランタイムの最新 Docker イメージのプルダウンを CLI がスキップすべきかどうかを指定します。

`--template, -t PATH`  <a name="ref-sam-cli-local-start-lambda-options-template"></a>
 AWS SAM テンプレートファイル。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM ロードします。このオプションは `--hook-name` と互換性がありません。

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-lambda-options-terraform-plan-file"></a>
Terraform Cloud で AWS SAMCLI を使用する場合のローカル Terraform プランファイルへの相対パスまたは絶対パス。このオプションは `--hook-name` を `terraform` に設定する必要があります。

`--warm-containers [EAGER | LAZY]`  <a name="ref-sam-cli-local-start-lambda-options-warm-containers"></a>
オプション。 AWS SAM CLI が各関数のコンテナを管理する方法を指定します。  
以下の 2 つのオプションを使用できます。  
+ `EAGER`: 起動時にすべての関数のコンテナがロードされ、呼び出し間で保持されます。
+ `LAZY`: 各関数が初めて呼び出される場合に限り、コンテナがロードされます。これらのコンテナは、追加の呼び出し用に保持されます。

## 例
<a name="sam-cli-command-reference-sam-local-start-lambda-examples"></a>

`sam local start-lambda` サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「[sam local start-lambda を使用したテストの概要](using-sam-cli-local-start-lambda.md)」を参照してください。

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

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

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

`sam logs` コマンドは、 AWS Lambda 関数によって生成されたログを取得します。

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

```
$ sam logs <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-logs-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-logs-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--cw-log-group LIST`  <a name="sam-cli-command-reference-sam-logs-options-cw-log-group"></a>
指定した CloudWatch Logs ロググループからのログを含めます。このオプションを とともに指定すると`name`、 は指定されたリソースからのログに加えて、指定されたロググループのログ AWS SAM を含めます。

`--debug`  <a name="sam-cli-command-reference-sam-logs-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`---end-time, e TEXT`  <a name="sam-cli-command-reference-sam-logs-options-end-time"></a>
この時刻までのログを取得します。時刻には、「5mins ago」、「tomorrow」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。

`--filter TEXT`  <a name="sam-cli-command-reference-sam-logs-options-filter"></a>
式を指定して、ログイベントの用語、フレーズ、または値に一致するログをすばやく検索できるようにします。これは、シンプルなキーワード (「error」など)、または Amazon CloudWatch Logs でサポートされるパターンにすることができます。構文については、[Amazon CloudWatch Logs ドキュメント](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)を参照してください。

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

`--include-traces`  <a name="sam-cli-command-reference-sam-logs-options-include-traces"></a>
ログ出力に X-Ray トレースを含めます。

`--name, -n TEXT`  <a name="sam-cli-command-reference-sam-logs-options-name"></a>
ログを取得するリソースの名前。このリソースが CloudFormation スタックの一部である場合、これは CloudFormation/AWS SAM テンプレート内の関数リソースの論理 ID になります。パラメータを再度繰り返すことで、複数の名前を指定できます。リソースがネストされたスタックにある場合、そのリソースからログをプルするために、ネストされたスタック名の前に名前を付加できます (NestedStackLogicalId/ResourceLogicalId)。リソース名が指定されていない場合、指定されたスタックがスキャンされ、サポートされているすべてのリソースのログ情報が取得されます。このオプションを指定しない場合、 は指定したスタック内のすべてのリソースのログ AWS SAM を取得します。以下のリソースタイプがサポートされています。  
+ `AWS::Serverless::Function`
+ `AWS::Lambda::Function`
+ `AWS::Serverless::Api`
+ `AWS::ApiGateway::RestApi`
+ `AWS::Serverless::HttpApi`
+ `AWS::ApiGatewayV2::Api`
+ `AWS::Serverless::StateMachine`
+ `AWS::StepFunctions::StateMachine`

`--output TEXT`  <a name="sam-cli-command-reference-sam-logs-options-output"></a>
ログの出力形式を指定します。フォーマットされたログを印刷するには、`text` を指定します。ログを JSON として印刷するには、`json` を指定します。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-logs-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-logs-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="sam-cli-command-reference-sam-logs-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-logs-options-stack-name"></a>
リソースが属する CloudFormation スタックの名前。

`--start-time, -s TEXT`  <a name="sam-cli-command-reference-sam-logs-options-start-time"></a>
この時刻以降のログを取得します。時刻には、「5mins ago」、「yesterday」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。デフォルトは「10mins ago」です。

` --tail, -t`  <a name="sam-cli-command-reference-sam-logs-options-tail"></a>
ログ出力を tail します。これにより、終了時間引数は無視され、ログが使用可能になった時点で引き続き取得されます。

## 例
<a name="sam-cli-command-reference-sam-logs-examples"></a>

関数が CloudFormation スタックの一部である場合は、スタック名を指定するときに関数の論理 ID を使用してログを取得できます。

```
$ sam logs -n HelloWorldFunction --stack-name myStack
```

-s (--start-time) と-e (--end-time) オプションを使用して、特定の時間範囲のログを表示します。

```
$ sam logs -n HelloWorldFunction --stack-name myStack -s '10min ago' -e '2min ago'
```

`--tail` オプションを追加して、新しいログを待機し、到着するたびにそれらを表示することもできます。

```
$ sam logs -n HelloWorldFunction --stack-name myStack --tail
```

`--filter` オプションを使用して、ログイベントの語句、フレーズ、または値が一致するログをすばやく検索します。

```
$ sam logs -n HelloWorldFunction --stack-name myStack --filter "error"
```

子スタック内のリソースのログを表示します。

```
$ sam logs --stack-name myStack -n childStack/HelloWorldFunction
```

アプリケーションでサポートされているすべてのリソースのログを追跡します。

```
$ sam logs --stack-name sam-app --tail
```

アプリケーション内の特定の Lambda 関数および API Gateway API のログを取得します。

```
$ sam logs --stack-name sam-app --name HelloWorldFunction --name HelloWorldRestApi
```

アプリケーション内のサポートされているすべてのリソースのログを取得し、さらに指定したロググループからログを取得します。

```
$ sam logs --cw-log-group /aws/lambda/myfunction-123 --cw-log-group /aws/lambda/myfunction-456
```

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

コマンドラインインターフェイス (AWS SAM CLI) AWS Serverless Application Model は AWS SAM アプリケーションをパッケージ化します。

このコマンドは、コードと依存関係の`.zip`ファイルを作成し、そのファイルを Amazon Simple Storage Service (Amazon S3) にアップロードします。 は、Amazon S3 に保存されているすべてのファイルの暗号化 AWS SAM を有効にします。次に、 AWS SAM テンプレートのコピーが返され、ローカルアーティファクトへの参照は、コマンドがアーティファクトをアップロードした Amazon S3 の場所に置き換えられます。

このコマンドを使用する場合、 AWS SAM CLI はデフォルトで、現在の作業ディレクトリがプロジェクトのルートディレクトリであると想定します。は、 AWS SAM CLI`.aws-sam`サブフォルダにあり、 という名前の [sam build](sam-cli-command-reference-sam-build.md) コマンドを使用して構築されたテンプレートファイルを見つけようとします`template.yaml`。 AWS SAM CLI は次に、現在の作業ディレクトリで、`template.yaml` または `template.yml` と命名されているテンプレートファイルを見つけようとします。`--template` オプションを指定すると、 AWS SAM CLIのデフォルトの動作が上書きされ、 はその AWS SAM テンプレートとそれが指すローカルリソースのみをパッケージ化します。

**注記**  
[sam deploy](sam-cli-command-reference-sam-deploy.md) が `sam package` の機能を暗黙的に実行するようになりました。[sam deploy](sam-cli-command-reference-sam-deploy.md) コマンドを直接使用して、アプリケーションをパッケージ化およびデプロイできます。

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

```
$ sam package <arguments> <options>
```

## 引数
<a name="sam-cli-command-reference-sam-package-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-sam-package-args-resource-id"></a>
パッケージ化する Lambda 関数の ID です。  
この引数はオプションです。アプリケーションに 1 つの Lambda 関数が含まれている場合、CLI AWS SAM はその関数をパッケージ化します。アプリケーションに複数の関数が含まれている場合は、関数の ID を 1 つ指定してパッケージ化します。  
有効な値: リソースの論理 ID またはリソース ARN。

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-package-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-package-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-package-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--force-upload`  <a name="sam-cli-command-reference-sam-package-options-force-upload"></a>
Amazon S3 バケット内の既存のファイルを上書きします。このフラグを指定して、アーティファクトが Amazon S3 バケット内の既存のアーティファクトと一致する場合でも、それらをアップロードします。

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

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-package-options-image-repository"></a>
このコマンドが関数のイメージをアップロードする Amazon Elastic Container Registry (Amazon ECR) リポジトリの URI です。`Image` パッケージタイプで宣言された関数に必要です。

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-package-options-kms-key-id"></a>
Amazon S3 バケットに保管されているアーティファクトを暗号化するために使用される AWS Key Management Service (AWS KMS) キーの ID。このオプションを指定しない場合、 は Amazon S3-managed暗号化キー AWS SAM を使用します。

`--metadata`  <a name="sam-cli-command-reference-sam-package-options-metadata"></a>
(オプション) テンプレートで参照されるすべてのアーティファクトにアタッチするメタデータのマップです。

`--no-progressbar`  <a name="sam-cli-command-reference-sam-package-options-no-progressbar"></a>
Amazon S3 へのアーティファクトのアップロード時に、進行状況バーを表示しません。

`--output-template-file PATH`  <a name="sam-cli-command-reference-sam-package-options-output-template-file"></a>
コマンドがパッケージ化されたテンプレートを書き込むファイルへのパス。パスを指定しない場合、コマンドはテンプレートを標準出力に書き込みます。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-package-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-package-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--resolve-s3`  <a name="sam-cli-command-reference-sam-package-options-resolve-s3"></a>
パッケージ化に使用する Amazon S3 バケットを自動的に作成します。`--s3-bucket` および `--resolve-s3` オプションの両方を指定すると、エラーが発生します。

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-bucket"></a>
このコマンドがアーティファクトをアップロードする Amazon S3 バケットの名前です。アーティファクトが 51,200 バイトより大きい場合には、`--s3-bucket` または `--resolve-s3` オプションは必須です。`--s3-bucket` および `--resolve-s3` オプションの両方を指定すると、エラーが発生します。

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-package-options-s3-prefix"></a>
Amazon S3 バケットにアップロードされるアーティファクト名に追加されたプレフィックスです。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。これは、`Zip` パッケージタイプで宣言された関数のみに適用されます。

`--save-params`  <a name="sam-cli-command-reference-sam-package-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--signing-profiles LIST`  <a name="sam-cli-command-reference-sam-package-options-signing-profiles"></a>
(オプション) デプロイパッケージに署名するための署名プロファイルのリストです。このパラメータはキーバリューペアのリストを使用します。このペアのキーは署名する関数またはレイヤーの名前、値は署名プロファイルで、オプションのプロファイル所有者は `:` で区切られます。例えば、`FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner`。

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-package-options-template-file"></a>
 AWS SAM テンプレートがあるパスとファイル名。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM パッケージ化します。

`--use-json`  <a name="sam-cli-command-reference-sam-package-options-use-json"></a>
 CloudFormation テンプレートの JSON を出力します。デフォルトでは、YAML が使用されます。

## 例
<a name="sam-cli-command-reference-sam-package-examples"></a>

次の例では、Lambda 関数と CodeDeploy アプリケーションのために、アーティファクトを作成しパッケージ化します。アーティファクトは Amazon S3 バケットにアップロードされます。コマンドの出力は、`package.yml` という新しいファイルです。

```
$ sam package \
  --template-file template.yml \
  --output-template-file package.yml \
  --s3-bucket amzn-s3-demo-bucket
```

# sam pipeline bootstrap
<a name="sam-cli-command-reference-sam-pipeline-bootstrap"></a>

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

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

`sam pipeline bootstrap` サブコマンドは、CI/CD システムに接続するために必要な AWS インフラストラクチャリソースを生成します。このステップは、**sam pipeline init** コマンドを実行する前に、パイプラインのデプロイステージごとに実行する必要があります。

このサブコマンドは、次の AWS インフラストラクチャリソースを設定します。
+ パイプラインのアクセス許可を設定するオプション:
  + CI/CD システムと共有されるアクセスキー ID とシークレットキーのアクセス認証情報を持つパイプライン IAM ユーザー。
**注記**  
アクセスキーを定期的にローテーションすることをお勧めします。詳細については、IAM ユーザーガイドの「[長期的な認証情報を必要とするユースケースのためにアクセスキーを定期的にローテーションする](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#rotate-credentials)」を参照してください。
  + OIDC を通じてサポートされている CI/CD プラットフォーム。 AWS SAM パイプラインで OIDC を使用する方法の概要については、「[AWS SAM パイプラインで OIDC 認証を使用する方法](deploying-with-oidc.md)」を参照してください。
+  AWS SAM アプリケーションをデプロイ CloudFormation するために が引き受ける CloudFormation 実行 IAM ロール。
+  AWS SAM アーティファクトを保持する Amazon S3 バケット。
+ オプションで、コンテナイメージの Lambda デプロイパッケージを保持するための Amazon ECR イメージリポジトリ (パッケージタイプが `Image` のリソースがある場合)。

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

```
$ sam pipeline bootstrap <options>
```

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

`--bitbucket-repo-uuid TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bitbucket-repo-uuid"></a>
 Bitbucket リポジトリの UUID です。このオプションは、アクセス許可に Bitbucket OIDC を使用する場合に固有です。  
この値は https://bitbucket.org/*workspace*/*repository*/admin/addon/admin/pipelines/openid-connect にあります。

`--bucket TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-bucket"></a>
 AWS SAM アーティファクトを保持する Amazon S3 バケットの ARN。

`--cicd-provider TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cicd-provider"></a>
 AWS SAM パイプラインの CI/CD プラットフォーム。

`--cloudformation-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-cloudformation-execution-role"></a>
アプリケーションのスタックのデプロイ CloudFormation 中に が引き受ける IAM ロールの ARN。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-env"></a>
使用する設定ファイル内のデフォルトのパラメータ値を指定する環境名です。デフォルト値は **default** です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--confirm-changeset | --no-confirm-changeset`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-confirm-changeset"></a>
リソースのデプロイを確認するプロンプトが表示されます。

`--create-image-repository | --no-create-image-repository`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-create-image-repository"></a>
Amazon ECR イメージリポジトリが提供されていない場合に、それを作成するかどうかを指定します。Amazon ECR リポジトリは、パッケージタイプが `Image` の Lambda 関数またはレイヤーのコンテナイメージを保持します。デフォルトは `--no-create-image-repository` です。

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力し、タイムスタンプを表示します。

`--deployment-branch TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-deployment-branch"></a>
デプロイ元のブランチの名前です。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--github-org TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-org"></a>
リポジトリが属する GitHub 組織です。組織が存在しない場合は、リポジトリ所有者のユーザー名を入力します。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--github-repo TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-github-repo"></a>
デプロイ元の GitHub リポジトリの名前です。このオプションは、アクセス許可に GitHub Actions OIDC を使用する場合に固有です。

`--gitlab-group TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-group"></a>
リポジトリが属する GitLab グループです。このオプションは、アクセス許可に GitLab OIDC を使用する場合に固有です。

`--gitlab-project TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-gitlab-project"></a>
GitLab のプロジェクトの名前です。このオプションは、アクセス許可に GitLab OIDC を使用する場合に固有です。

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

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-image-repository"></a>
パッケージタイプが `Image` の Lambda 関数またはレイヤーのコンテナイメージを保持する Amazon ECR イメージリポジトリの ARN です。提供されている場合は、`--create-image-repository` オプションが無視されます。提供されておらず、`--create-image-repository` が指定されている場合は、コマンドによって作成されます。

`--interactive | --no-interactive`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-interactive"></a>
bootstrap パラメータのインタラクティブなプロンプトを無効にし、必要なパラメータが欠落している場合は失敗します。デフォルト値は `--interactive` です。このコマンドの必須パラメータは `--stage` のみです。  
`--no-interactive` が `--use-oidc-provider` と一緒に指定される場合は、OIDC プロバイダーの必須パラメータをすべて含める必要があります。

`--oidc-client-id TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-client-id"></a>
OIDC プロバイダーで使用するように設定されたクライアント ID です。

`--oidc-provider [github-actions | gitlab | bitbucket-pipelines]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider"></a>
OIDC アクセス許可に使用される CI/CD プロバイダーの名前です。GitLab、GitHub、および Bitbucket がサポートされています。

`--oidc-provider-url TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-oidc-provider-url"></a>
OIDC プロバイダーの URL です。値は **https://** で始める必要があります。

`--permissions-provider [oidc | iam]`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-permissions-provider"></a>
パイプラインの実行ロールを取得するアクセス許可プロバイダーを選択します。デフォルト値は **iam** です。

`--pipeline-execution-role TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-execution-role"></a>
このステージでの動作のためにパイプラインユーザーが引き受ける IAM ロールの ARN です。独自のロールを使用したい場合にのみ提供します。提供されない場合は、このコマンドによって新しいロールが作成されます。

`--pipeline-user TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-pipeline-user"></a>
アクセスキー ID とシークレットアクセスキーが CI/CD システムと共有されている IAM ユーザーの Amazon リソースネーム (ARN) です。これは、対応する AWS アカウントにアクセスするためのアクセス許可をこの IAM ユーザーに付与するために使用されます。提供されていない場合、コマンドによってアクセスキー ID とシークレットアクセスキーの認証情報と共に IAM ユーザーロールが作成されます。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-region"></a>
デプロイ先の AWS リージョン。例えば、`us-east-1`。

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--stage TEXT`  <a name="sam-cli-command-reference-sam-pipeline-bootstrap-options-stage"></a>
対応するデプロイメントステージの名前です。これは、作成された AWS インフラストラクチャリソースのサフィックスとして使用されます。

## トラブルシューティング
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting"></a>

### エラー: 必須パラメータがありません
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-troubleshooting-example1"></a>

`--no-interactive` が `--use-oidc-provider` と一緒に指定され、必須パラメータのいずれかが指定されていない場合、欠落しているパラメータの説明とともにこのエラーメッセージが表示されます。

## 例
<a name="sam-cli-command-reference-sam-pipeline-bootstrap-examples"></a>

次の例では、CI/CD システムの作成に必要な AWS リソースを作成し、デバッグログを有効にして、 によって生成されたデバッグメッセージを出力します AWS SAM CLI。 は、イベントを使用して Lambda 関数をローカルで呼び出すことで、生成された`s3.json`イベントをローカルテストに使用します。

```
$ sam pipeline bootstrap --debug
```

# sam pipeline init
<a name="sam-cli-command-reference-sam-pipeline-init"></a>

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

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

`sam pipeline init` サブコマンドは、CI/CD システムが を使用してサーバーレスアプリケーションをデプロイするために使用できるパイプライン設定ファイルを生成します AWS SAM。

**sam pipeline init** を使用する前に、パイプラインの各ステージに必要なリソースをブートストラップする必要があります。これは、セットアップと設定ファイルの生成プロセス全体でガイドされるように **sam pipeline init --bootstrap** を実行することで可能になります。または、**sam pipeline bootstrap** コマンド使用して以前作成したリソースを参照します。

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

```
$ sam pipeline init <options>
```

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

`--bootstrap`  <a name="sam-cli-command-reference-sam-pipeline-init-options-bootstrap"></a>
必要な AWS インフラストラクチャリソースの作成をユーザーに説明するインタラクティブモードを有効にします。

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は `default` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file TEXT`  <a name="sam-cli-command-reference-sam-pipeline-init-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトのルートディレクトリにある `samconfig.toml` です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-pipeline-init-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

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

`--save-params`  <a name="sam-cli-command-reference-sam-pipeline-init-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

## 例
<a name="sam-cli-command-reference-sam-pipeline-init-examples"></a>

次の例は、 `--bootstrap`オプションを使用して、必要な AWS インフラストラクチャリソースの作成を順を追って説明するインタラクティブモードをウォークスルーできるようにする方法を示しています。

```
$ sam pipeline init --bootstrap
```

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

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

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

`sam publish` コマンドは、 に AWS SAM アプリケーションを公開します AWS Serverless Application Repository。このコマンドはパッケージ化された AWS SAM テンプレートを受け取り、指定された AWS リージョンにアプリケーションを公開します。

`sam publish` コマンドは、 AWS SAM テンプレートに公開に必要なアプリケーションメタデータを含む`Metadata`セクションが含まれていることを想定しています。`Metadata` セクションでは、`LicenseUrl` および `ReadmeUrl` プロパティがローカルファイルではなく、Amazon Simple Storage Service (Amazon S3) バケットを参照する必要があります。 AWS SAM テンプレートの `Metadata`セクションの詳細については、「」を参照してください[AWS SAM CLI を使用してアプリケーションを公開する](serverless-sam-template-publishing-applications.md)。

デフォルトで、`sam publish` はアプリケーションをプライベートとして作成します。他の AWS アカウントによるアプリケーションの表示とデプロイを許可する前に、アプリケーションを共有する必要があります。アプリケーションの共有については、*AWS Serverless Application Repository デベロッパーガイド*の「[AWS Serverless Application Repository Resource-Based Policy Examples](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/security_iam_resource-based-policy-examples.html)」を参照してください。

**注記**  
`sam publish` は現在、ローカルに指定されているネストされたアプリケーションの公開をサポートしていません。アプリケーションにネストされたアプリケーションが含まれている場合は、親アプリケーションを発行 AWS Serverless Application Repository する前に、それらを個別に に発行する必要があります。

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

```
$ sam publish <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-publish-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-publish-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-publish-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

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

`--profile TEXT`  <a name="sam-cli-command-reference-sam-publish-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-publish-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="sam-cli-command-reference-sam-publish-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--semantic-version TEXT`  <a name="sam-cli-command-reference-sam-publish-options-semantic-version"></a>
(オプション) このオプションを使用して、テンプレートファイルの `Metadata` セクションにある `SemanticVersion` プロパティを上書きするアプリケーションのセマンティックバージョンを提供します。セマンティックバージョニングの詳細については、「[Semantic Versioning specification](https://semver.org/) を参照してください。

`--template, -t PATH`  <a name="sam-cli-command-reference-sam-publish-options-template"></a>
 AWS SAM テンプレートファイル のパス`[default: template.[yaml|yml]]`。

## 例
<a name="sam-cli-command-reference-sam-publish-examples"></a>

アプリケーションを発行するには

```
$ sam publish --template packaged.yaml --region us-east-1
```

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

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

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

`sam remote callback` コマンドを使用すると、 AWS Lambda で実行されているリモートの永続的な関数実行にコールバックを送信できます。

**注記**  
これらのコマンドには、 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 認証情報にアクセスする必要があります。

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

`-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 認証情報にアクセスする必要があります。

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

`-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 認証情報にアクセスする必要があります。

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

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

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

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

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

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

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

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

`sam remote execution` コマンドを使用すると、 AWS Lambda で実行されているリモートの永続的な関数の実行を管理および検査できます。

**注記**  
これらのコマンドには、 AWS 認証情報へのアクセスが必要です。

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

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

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

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

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

`get`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-get"></a>
永続的な実行の詳細を取得します。詳細については、「[sam remote execution get](sam-cli-command-reference-sam-remote-execution-get.md)」を参照してください。

`history`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-history"></a>
永続的な関数実行の実行履歴を取得します。詳細については、「[sam remote execution history](sam-cli-command-reference-sam-remote-execution-history.md)」を参照してください。

`stop`  <a name="sam-cli-command-reference-sam-remote-execution-subcommands-stop"></a>
永続的な関数の実行を停止します。詳細については、「[sam remote execution stop](sam-cli-command-reference-sam-remote-execution-stop.md)」を参照してください。

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

 AWS Lambda から特定の永続的な関数実行の詳細を取得します。

実行 ARN は、呼び出しによって返されるか、実行ログで見つかった形式である必要があります。

**注記**  
このコマンドでは、 AWS 認証情報にアクセスする必要があります。

## Usage
<a name="ref-sam-cli-remote-execution-get-usage"></a>

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

## 必要な引数
<a name="ref-sam-cli-remote-execution-get-arguments"></a>

`DURABLE_EXECUTION_ARN`  
詳細を取得する永続的な関数実行の Amazon リソースネーム (ARN)。

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

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

## 例
<a name="ref-sam-cli-remote-execution-get-examples"></a>

デフォルトのサマリー形式で実行の詳細を取得します。

```
$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55'
```

JSON 形式で実行の詳細を取得します。

```
$ sam remote execution get 'arn:aws:lambda:us-east-1:123456789012:function:my-function:$LATEST/durable-execution/c63eec67-3415-4eb4-a495-116aa3a86278/1d454231-a3ad-3694-aa03-c917c175db55' --format json
```

**注記**  
シェルコマンドを使用するときは`$`、 のような実行 ARN のコントロール文字が適切にエスケープされていることを確認する必要があります。

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

 AWS Lambda から特定の永続的な関数実行の実行履歴を取得します。

実行 ARN は、StartDurableExecution によって返されるか、実行ログで見つかった形式である必要があります。

**注記**  
このコマンドでは、 AWS 認証情報にアクセスする必要があります。

## Usage
<a name="ref-sam-cli-remote-execution-history-usage"></a>

```
$ sam remote execution history DURABLE_EXECUTION_ARN [OPTIONS]
```

## 必要な引数
<a name="ref-sam-cli-remote-execution-history-arguments"></a>

`DURABLE_EXECUTION_ARN`  
履歴を取得する永続的な関数実行の Amazon リソースネーム (ARN)。

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

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

## 例
<a name="ref-sam-cli-remote-execution-history-examples"></a>

デフォルトのテーブル形式で実行履歴を取得します。

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

JSON 形式で実行履歴を取得します。

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

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

 AWS Lambda で実行中の永続的な関数の実行を停止します。

実行 ARN は、StartDurableExecution によって返されるか、実行ログで見つかった形式である必要があります。

**注記**  
このコマンドでは、 AWS 認証情報にアクセスする必要があります。

## Usage
<a name="ref-sam-cli-remote-execution-stop-usage"></a>

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

## 必要な引数
<a name="ref-sam-cli-remote-execution-stop-arguments"></a>

`DURABLE_EXECUTION_ARN`  
停止する永続的な関数実行の Amazon リソースネーム (ARN)。

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

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

## 例
<a name="ref-sam-cli-remote-execution-stop-examples"></a>

エラーの詳細なしで実行を停止します。

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

エラーメッセージとタイプを使用して実行を停止します。

```
$ sam remote 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 remote 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()"
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote invoke` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote invoke` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote invoke を使用したクラウドでのテストの概要](using-sam-cli-remote-invoke.md)。

`sam remote invoke` コマンドは、 AWS クラウドでサポートされているリソースを呼び出します。

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

```
$ sam remote invoke <arguments> <options>
```

## 引数
<a name="sam-cli-command-reference-remote-invoke-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-remote-invoke-args-resource-id"></a>
呼び出すサポート対象リソースの ID です。  
この引数には、次の値を使用できます。  
+ **Amazon リソースネーム (ARN)** – リソースの ARN。
**ヒント**  
`sam list stack-outputs --stack-name <stack-name>` を使用してリソースの ARN を取得します。
+ **論理 ID** – リソースの論理 ID。また、 `--stack-name`オプションを使用して AWS CloudFormation スタック名を指定する必要があります。
+ **物理 ID** — リソースの物理 ID。この ID は、 を使用してリソースをデプロイするときに作成されます CloudFormation。
**ヒント**  
`sam list resources --stack-name <stack-name>` を使用してリソースの物理 ID を取得します。  
**ARN または物理 ID を指定する場合:**  
ARN ID または物理 ID の指定で、スタック名を指定しないでください。`--stack-name` オプションを使用してスタック名を指定する場合、またはスタック名が設定ファイルで定義されている場合、 AWS SAM CLIはリソース ID を CloudFormation スタックの論理 ID 値として自動的に処理します。  
**リソース ID を指定しない場合:**  
リソース ID を指定せず、 `--stack-name`オプションでスタック名を指定した場合、CLI AWS SAM は次のロジックを使用して CloudFormation スタック内のリソースを自動的に呼び出しようとします。  

1.  AWS SAM CLI は、次の順序でリソースタイプを識別し、リソースタイプがスタックで見つかったら次のステップに進みます。

   1. Lambda

   1. ステップ関数

   1. Amazon SQS

   1. Kinesis Data Streams

1. リソースタイプにスタックに 1 つのリソースがある場合、 AWS SAM CLIはそれを呼び出します。リソースタイプのリソースがスタックに複数存在する場合、 AWS SAM CLIはエラーを返します。
以下は、 AWS SAM CLIの動作の例です。  
+ 2 **つの Lambda 関数と Amazon SQS キューを含むスタック** – AWS SAM CLIは Lambda リソースタイプを見つけ、スタックに複数の Lambda 関数が含まれているため、 と エラーを返します。
+ **Lambda 関数と 2 つの Amazon Kinesis Data Streams アプリケーションを含むスタック** – AWS SAM CLIスタックに 1 つの Lambda リソースが含まれているため、 は Lambda 関数を見つけて呼び出します。
+ **1 つの Amazon SQS キューと 2 つの Kinesis Data Streams アプリケーションを含むスタック** – AWS SAM CLIスタックに 1 つの Amazon SQS キューが含まれているため、 は Amazon SQS キューを見つけて呼び出します。

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

`--beta-features | --no-beta-features`  <a name="sam-cli-command-reference-remote-invoke-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-config-env"></a>
 AWS SAM CLI 設定ファイルから、使用する環境を指定します。  
デフォルト: `default`

`--config-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-config-file"></a>
設定ファイルのパスとファイル名を指定します。  
設定ファイルの詳細については、「[AWS SAM CLI の設定](using-sam-cli-configure.md)」を参照してください。  
*デフォルト*: プロジェクトディレクトリのルートにある `samconfig.toml`。

`--debug`  <a name="sam-cli-command-reference-remote-invoke-options-debug"></a>
デバッグログの記録をアクティブ化します。そうすることで、 AWS SAM CLI が生成したデバッグメッセージとタイムスタンプを出力します。

`--event, -e TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-event"></a>
ターゲットリソースに送信するイベントです。

`--event-file FILENAME`  <a name="sam-cli-command-reference-remote-invoke-options-event-file"></a>
ターゲットリソースに送信するイベントが含まれるファイルへのパスです。

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
ヘルプメッセージを表示して終了します。

`--output [ text | json ]`  <a name="sam-cli-command-reference-remote-invoke-options-output"></a>
呼び出しの結果を特定の出力形式で出力します。  
`json` – リクエストメタデータとリソースのレスポンスが JSON 構造で返されます。レスポンスには完全な SDK 出力が含まれます。  
`text` – リクエストメタデータがテキスト構造で返されます。リソースレスポンスは、呼び出されたリソースの出力形式で返されます。

`--parameter`  <a name="sam-cli-command-reference-remote-invoke-options-parameter"></a>
呼び出されているリソースに渡すことができる追加の [https://boto3.amazonaws.com/v1/documentation/api/latest/index.html](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) パラメータです。    
**Amazon Kinesis Data Streams**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-kinesis"></a>
次の追加パラメータは、Kinesis データストリームにレコードを追加するために使用できます。  
+ `ExplicitHashKey='string'`
+ `PartitionKey='string'`
+ `SequenceNumberForOrdering='string'`
+ `StreamARN='string'`
各パラメータの説明については、「[Kinesis.Client.Put\$1Record](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_record.html)」を参照してください。  
**AWS Lambda**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-lambda"></a>
以下の追加のパラメータは、Lambda リソースを呼び出して、バッファされたレスポンスを受け取るために使用できます。  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | Event | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
以下の追加パラメータは、レスポンスストリーミングで Lambda リソースを呼び出すために使用できます。  
+ `ClientContext='base64-encoded string'`
+ `InvocationType='[ DryRun | RequestResponse ]'`
+ `LogType='[ None | Tail ]'`
+ `Qualifier='string'`
各パラメータの説明については、以下を参照してください。  
+ バッファされたレスポンスを使用する Lambda – [Lambda.Client.Invoke](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html)
+ レスポンスストリーミングを使用する Lambda – [Lambda.Client.Invoke\$1with\$1Response\$1Stream](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke_with_response_stream.html)  
**Amazon Simple Queue Service (Amazon SQS)**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-sqs"></a>
次の追加パラメータは Amazon SQS キューにメッセージを送信するために使用できます。  
+ `DelaySeconds=integer`
+ `MessageAttributes='json string'`
+ `MessageDeduplicationId='string'`
+ `MessageGroupId='string'`
+ `MessageSystemAttributes='json string'`
各パラメータの説明については、「[SQS.Client.Send\$1Message](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html)」を参照してください。  
**AWS Step Functions**  <a name="sam-cli-command-reference-remote-invoke-options-parameter-sf"></a>
次の追加パラメータは、ステートマシンの実行を開始するために使用できます。  
+ `name='string'`
+ `traceHeader='string'`
各パラメータの説明については、「[SFN.Client.Start\$1Execution](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions/client/start_execution.html)」を参照してください。

`--profile TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-profile"></a>
認証情報を取得するための AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-region"></a>
リソース AWS リージョン の 。例えば、`us-east-1`。

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-invoke-options-stack-name"></a>
リソースが属する CloudFormation スタックの名前。

`--tenant-id TEXT`  <a name="ref-sam-cli-local-invoke-options-tenancyconfig"></a>
マルチテナント Lambda 関数のテナント ID。異なるテナント間のコンピューティング分離を確保するために使用されます。テナント分離モードで設定された関数を呼び出すときに必要です。

`--test-event-name NAME`  <a name="sam-cli-command-reference-remote-invoke-options-test-event-name"></a>
Lambda 関数に渡す共有可能なテストイベントの名前。  
このオプションは Lambda 関数のみをサポートします。

## 例
<a name="sam-cli-command-reference-remote-invoke-examples"></a>

次の例では、 AWS クラウドでサポートされているリソースを呼び出し、デバッグログ記録をアクティブ化します。これにより、 によって生成されたデバッグメッセージとタイムスタンプが出力されます AWS SAM CLI。

```
$ sam remote invoke--debug
```

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote test-event` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote test-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote test-event を使用したクラウドテストの概要](using-sam-cli-remote-test-event.md)。

`sam remote test-event` コマンドは、Amazon EventBridge スキーマレジストリ内の共有可能なテストイベントを操作します。

## 使用方法
<a name="sam-cli-command-reference-remote-test-event-usage"></a>

```
$ sam remote test-event <options> <subcommand>
```

## オプション
<a name="sam-cli-command-reference-remote-test-event-options"></a>

`--help, -h`  <a name="sam-cli-command-reference-remote-invoke-options-help"></a>
ヘルプメッセージを表示して終了します。

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

`delete`  
EventBridge スキーマレジストリから、共有可能なテストイベントを削除します。詳細については、「[sam remote test-event delete](sam-cli-command-reference-remote-test-event-delete.md)」を参照してください。

`get`  
EventBridge スキーマレジストリから、共有可能なテストイベントを取得します。詳細については、「[sam remote test-event get](sam-cli-command-reference-remote-test-event-get.md)」を参照してください。

`list`  
 AWS Lambda 関数の既存の共有可能なテストイベントを一覧表示します。詳細については、「[sam remote test-event list](sam-cli-command-reference-remote-test-event-list.md)」を参照してください。

`put`  
ローカルファイルのイベント EventBridge スキーマレジストリに保存します。詳細については、「[sam remote test-event put](sam-cli-command-reference-remote-test-event-put.md)」を参照してください。

# sam remote test-event delete
<a name="sam-cli-command-reference-remote-test-event-delete"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote test-event delete`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote test-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote test-event を使用したクラウドテストの概要](using-sam-cli-remote-test-event.md)。

`sam remote test-event delete` サブコマンドは、Amazon EventBridge スキーマレジストリから共有可能なテストイベントを削除します。

## 使用方法
<a name="sam-cli-command-reference-remote-test-event-delete-usage"></a>

```
$ sam remote test-event delete <arguments> <options>
```

## 引数
<a name="sam-cli-command-reference-remote-test-event-delete-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-remote-test-event-delete-args-resource-id"></a>
共有可能なテストイベントに関連付けられた AWS Lambda 関数の ID。  
論理 ID を指定する場合は、 `--stack-name`オプションを使用して Lambda 関数に関連付けられた AWS CloudFormation スタックの値も指定する必要があります。  
有効な値: リソースの論理 ID またはリソース ARN。

## オプション
<a name="sam-cli-command-reference-remote-test-event-delete-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-delete-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-delete-options-help"></a>
ヘルプメッセージを表示して終了します。

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-name"></a>
削除する共有可能なテストイベントの名前。

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-delete-options-stack-name"></a>
Lambda 関数に関連付けられた CloudFormation スタックの名前。  
このオプションは、Lambda 関数の論理 ID を引数として指定する場合に必要です。

# sam remote test-event get
<a name="sam-cli-command-reference-remote-test-event-get"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote test-event get`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote test-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote test-event を使用したクラウドテストの概要](using-sam-cli-remote-test-event.md)。

`sam remote test-event get` サブコマンドで、Amazon EventBridge スキーマレジストリから共有可能なテストイベントを取得します。

## 使用方法
<a name="sam-cli-command-reference-remote-test-event-get-usage"></a>

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

## 引数
<a name="sam-cli-command-reference-remote-test-event-get-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-remote-test-event-get-args-resource-id"></a>
取得する共有可能なテストイベントに関連付けられた AWS Lambda 関数の ID。  
論理 ID を指定する場合は、 `--stack-name`オプションを使用して Lambda 関数に関連付けられた AWS CloudFormation スタックの値も指定する必要があります。  
有効な値: リソースの論理 ID またはリソース ARN。

## オプション
<a name="sam-cli-command-reference-remote-test-event-get-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-get-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-get-options-help"></a>
ヘルプメッセージを表示して終了します。

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-name"></a>
取得する共有可能なテストイベントの名前。

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-get-options-output-file"></a>
イベントをローカルマシンに保存する際に指定するファイルパスと名前。  
このオプションを指定しない場合、 AWS SAM CLI は共有可能なテストイベントの内容をコンソールに出力します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-get-options-stack-name"></a>
Lambda 関数に関連付けられた CloudFormation スタックの名前。  
このオプションは、Lambda 関数の論理 ID を引数として指定する場合に必要です。

# sam remote test-event list
<a name="sam-cli-command-reference-remote-test-event-list"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote test-event list`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote test-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote test-event を使用したクラウドテストの概要](using-sam-cli-remote-test-event.md)。

`sam remote test-event list` サブコマンドは、Amazon EventBridge スキーマレジストリから特定の AWS Lambda 関数の既存の共有可能なテストイベントを一覧表示します。

## 使用方法
<a name="sam-cli-command-reference-remote-test-event-list-usage"></a>

```
$ sam remote test-event list <arguments> <options>
```

## 引数
<a name="sam-cli-command-reference-remote-test-event-list-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-remote-test-event-list-args-resource-id"></a>
共有可能なテストイベントに関連付けられた Lambda 関数の ID。  
論理 ID を指定する場合は、 `--stack-name`オプションを使用して Lambda 関数に関連付けられた AWS CloudFormation スタックの値も指定する必要があります。  
有効な値: リソースの論理 ID またはリソース ARN。

## オプション
<a name="sam-cli-command-reference-remote-test-event-list-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-list-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-list-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-list-options-help"></a>
ヘルプメッセージを表示して終了します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-list-options-stack-name"></a>
Lambda 関数に関連付けられた CloudFormation スタックの名前。  
このオプションは、Lambda 関数の論理 ID を引数として指定する場合に必要です。

## 例
<a name="sam-cli-command-reference-remote-test-event-list-examples"></a>

このコマンドの使用例については、「[共有可能なテストイベントを一覧表示する](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-list)」を参照してください。

# sam remote test-event put
<a name="sam-cli-command-reference-remote-test-event-put"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam remote test-event put`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam remote test-event` コマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam remote test-event を使用したクラウドテストの概要](using-sam-cli-remote-test-event.md)。

`sam remote test-event put` サブコマンドで、ローカルマシンの共有可能なテストイベントを Amazon EventBridge スキーマレジストリに保存します。

## 使用方法
<a name="sam-cli-command-reference-remote-test-event-put-usage"></a>

```
$ sam remote test-event put <arguments> <options>
```

## 引数
<a name="sam-cli-command-reference-remote-test-event-put-args"></a>

**Resource ID (リソース ID)**  <a name="sam-cli-command-reference-remote-test-event-put-args-resource-id"></a>
共有可能なテストイベントに関連付けられた AWS Lambda 関数の ID。  
論理 ID を指定する場合は、 `--stack-name`オプションを使用して Lambda 関数に関連付けられた AWS CloudFormation スタックの値も指定する必要があります。  
有効な値: リソースの論理 ID またはリソース ARN。

## オプション
<a name="sam-cli-command-reference-remote-test-event-put-options"></a>

`--config-env TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-remote-test-event-put-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-file"></a>
ローカルマシン上のイベントのファイルパスと名前。  
`stdin` から読み取るファイル名の値として `-` を指定します。  
このオプションは必須です。

`--force`, `-f`  <a name="sam-cli-command-reference-remote-test-event-put-options-force"></a>
共有可能なテストイベントを同じ名前で上書きします。

`--help, -h`  <a name="sam-cli-command-reference-remote-test-event-put-options-help"></a>
ヘルプメッセージを表示して終了します。

`--name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-name"></a>
共有可能なテストイベントを保存する際に指定する名前。  
EventBridge スキーマレジストリに同じ名前の共有可能なテストイベントが存在する場合、 AWS SAM CLIはそれを上書きしません。上書きするには、`--force` オプションを追加します。

`--output-file FILENAME`  <a name="sam-cli-command-reference-remote-test-event-put-options-output-file"></a>
イベントをローカルマシンに保存する際に指定するファイルパスと名前。  
このオプションを指定しない場合、 AWS SAM CLI は共有可能なテストイベントの内容をコンソールに出力します。

`--stack-name TEXT`  <a name="sam-cli-command-reference-remote-test-event-put-options-stack-name"></a>
Lambda 関数に関連付けられた CloudFormation スタックの名前。  
このオプションは、Lambda 関数の論理 ID を引数として指定する場合に必要です。

## 例
<a name="sam-cli-command-reference-remote-test-event-put-examples"></a>

このコマンドの使用例については、「[共有可能なテストイベントを保存する](using-sam-cli-remote-test-event.md#using-sam-cli-remote-test-event-use-put)」を参照してください。

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

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam sync` コマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ の使用に関するドキュメントについては AWS SAM CLI、「」を参照してください[AWS SAM CLI](using-sam-cli.md)。

`sam sync` コマンドは、ローカル アプリケーションの変更を AWS クラウドに同期します。

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

```
$ sam sync <options>
```

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

`--base-dir, -s DIRECTORY`  <a name="sam-cli-command-reference-sam-sync-options-base-dir"></a>
関数またはレイヤーのソースコードへの相対パスを、このディレクトリを基準にして解決します。このオプションは、ソースコードフォルダの相対パスの解決方法を変更する場合に使用します。デフォルトでは、相対パスは AWS SAM テンプレートの場所に関して解決されます。  
このオプションは、構築しているルートアプリケーションまたはスタックのリソースに加えて、ネストされたアプリケーションまたはスタックにも適用されます。このオプションは、以下のリソースタイプとプロパティにも適用されます。  
+ リソースタイプ: `AWS::Serverless::Function` プロパティ: `CodeUri`
+ リソースタイプ: `AWS::Serverless::Function` リソース属性: `Metadata` エントリ: `DockerContext`
+ リソースタイプ: `AWS::Serverless::LayerVersion` プロパティ: `ContentUri`
+ リソースタイプ: `AWS::Lambda::Function` プロパティ: `Code`
+ リソースタイプ: `AWS::Lambda::LayerVersion` プロパティ: `Content`

`--build-image TEXT`  <a name="sam-cli-command-reference-sam-sync-options-build-image"></a>
アプリケーションの構築時に使用する[コンテナイメージ](serverless-image-repositories.md#serverless-image-repository-uris)の URI です。デフォルトでは、 は [Amazon Elastic Container Registry (Amazon ECR) Public ](https://docs.aws.amazon.com/AmazonECR/latest/public/what-is-ecr.html)のコンテナイメージリポジトリ URI AWS SAM を使用します。別の画像を使用するには、このオプションを指定します。  
このオプションは、1 つのコマンドで複数回使用できます。各オプションには、文字列またはキーと値のペアを指定できます。  
+ **文字列** – アプリケーション内のすべてのリソースに使用するコンテナイメージ URI を指定します。以下に例を示します。

  ```
  $ sam sync --build-image amazon/aws-sam-cli-build-image-python3.8
  ```
+ **キーと値のペア** — リソース名をキーとして、そのリソースで使用するコンテナイメージ URI を値として指定します。この形式を使用して、アプリケーション内のリソースごとに異なるコンテナイメージ URI を指定します。以下に例を示します。

  ```
  $ sam sync --build-image Function1=amazon/aws-sam-cli-build-image-python3.8
  ```
このオプションは、`--use-container` オプションが指定されている場合のみに適用され、指定されていない場合はエラーが発生します。

`--build-in-source | --no-build-in-source`  <a name="sam-cli-command-reference-sam-sync-options-build-in-source"></a>
ソースフォルダにプロジェクトを直接構築するには `--build-in-source` を指定します。  
`--build-in-source` オプションは、次のランタイムとビルドメソッドをサポートします:  
+ **ランタイム** – `sam init --runtime` オプションでサポートされている Node.js ランタイム。
+ **ビルドメソッド** – `Makefile`、`esbuild`。
`--build-in-source` オプションは、次のオプションとは互換性がありません:  
+ `--use-container `
*デフォルト*: `--no-build-in-source`

`--capabilities LIST`  <a name="sam-cli-command-reference-sam-sync-options-capabilities"></a>
が特定のスタック CloudFormation を作成できるように指定する機能のリスト。一部のスタックテンプレートには、 のアクセス許可に影響を与える可能性のあるリソースが含まれている場合があります AWS アカウント。たとえば、新しい AWS Identity and Access Management (IAM) ユーザーを作成します。デフォルト値を上書きするには、このオプションを指定します。有効な値は次のとおりです。  
+ CAPABILITY\$1IAM
+ CAPABILITY\$1NAMED\$1IAM
+ CAPABILITY\$1RESOURCE\$1POLICY
+ CAPABILITY\$1AUTO\$1EXPAND
*デフォル*ト: `CAPABILITY_NAMED_IAM` および `CAPABILITY_AUTO_EXPAND`

`--code`  <a name="sam-cli-command-reference-sam-sync-options-code"></a>
デフォルトでは、 はアプリケーション内のすべてのリソースを AWS SAM 同期します。以下を含むコードリソースのみを同期するには、このオプションを指定します。  
+ `AWS::Serverless::Function`
+ `AWS::Lambda::Function`
+ `AWS::Serverless::LayerVersion`
+ `AWS::Lambda::LayerVersion`
+ `AWS::Serverless::Api`
+ `AWS::ApiGateway::RestApi`
+ `AWS::Serverless::HttpApi`
+ `AWS::ApiGatewayV2::Api`
+ `AWS::Serverless::StateMachine`
+ `AWS::StepFunctions::StateMachine`
コードリソースを同期するために、 はデプロイスルーではなくサービス AWS APIs を直接 AWS SAM 使用します AWS CloudFormation。 CloudFormation スタックを更新するには、 **sam sync --watch**または を実行します**sam deploy**。

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-sync-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-sync-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--dependency-layer | --no-dependency-layer`  <a name="sam-cli-command-reference-sam-sync-options-dependency-layer"></a>
同期処理を高速化するために個々の関数の依存関係を別のレイヤーに分離するかどうかを指定します。  
*デフォルト*: `--dependency-layer`

`--image-repository TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repository"></a>
このコマンドが関数のイメージをアップロードする Amazon Elastic Container Registry (Amazon ECR) リポジトリの名前です。`Image` パッケージタイプで宣言された関数に必要です。

`--image-repositories TEXT`  <a name="sam-cli-command-reference-sam-sync-options-image-repositories"></a>
関数の Amazon ECR リポジトリ URI へのマッピングです。論理 ID で関数を参照します。以下に例を示します。  

```
$ sam sync --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo
```
このオプションは 1 つのコマンドで複数回指定できます。

`--kms-key-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-kms-key-id"></a>
Amazon S3 バケットに保管されているアーティファクトを暗号化するために使用される AWS Key Management Service (AWS KMS) キーの ID。 Amazon S3 このオプションを指定しない場合、 は Amazon S3-managed暗号化キー AWS SAM を使用します。

`--metadata`  <a name="sam-cli-command-reference-sam-sync-options-metadata"></a>
テンプレートで参照するすべてのアーティファクトにアタッチするメタデータのマップです。

`--notification-arns LIST`  <a name="sam-cli-command-reference-sam-sync-options-notification-arns"></a>
スタック CloudFormation に関連付ける Amazon Simple Notification Service (Amazon SNS) トピック ARNs のリスト。

`--no-use-container`  <a name="ref-sam-cli-sync-options-no-use-container"></a>
IDE ツールキットを使用してデフォルトの動作を設定できるオプション。

`--parameter-overrides`  <a name="sam-cli-command-reference-sam-sync-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。 AWS SAM CLI 形式は明示的なキーと値のキーワードで構成され、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。  
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world`
+ `--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana`

`--resource TEXT`  <a name="sam-cli-command-reference-sam-sync-options-resource"></a>
同期するリソースタイプを指定します。複数のリソースを同期する場合、このオプションを複数回指定できます。このオプションは、`--code` でサポートされています。値は、`--code` にリストされたリソースの 1 つである必要があります。例えば、`--resource AWS::Serverless::Function --resource AWS::Serverless::LayerVersion`。

`--resource-id TEXT`  <a name="sam-cli-command-reference-sam-sync-options-resource-id"></a>
同期するリソース ID を指定します。複数のリソースを同期する場合、このオプションを複数回指定できます。このオプションは、`--code` でサポートされています。例えば、`--resource-id Function1 --resource-id Function2`。

`--role-arn TEXT`  <a name="sam-cli-command-reference-sam-sync-options-role-arn"></a>
変更セットを適用するときに が CloudFormation 引き受ける IAM ロールの Amazon リソースネーム (ARN)。

`--s3-bucket TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-bucket"></a>
このコマンドが CloudFormation テンプレートをアップロードする Amazon Simple Storage Service (Amazon S3) バケットの名前。テンプレートが 51,200 バイトより大きい場合は、`--s3-bucket` または `--resolve-s3` オプションは必須です。`--s3-bucket` と `--resolve-s3` の両方のオプションを指定するとエラーが発生します。

`--s3-prefix TEXT`  <a name="sam-cli-command-reference-sam-sync-options-s3-prefix"></a>
Amazon S3 バケットにアップロードするアーティファクト名に追加されたプレフィックスです。プレフィックス名は、Amazon S3 バケットのパス名 (フォルダ名) です。これは、`Zip` パッケージタイプで宣言された関数にのみ適用されます。

`--save-params`  <a name="sam-cli-command-reference-sam-sync-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--skip-deploy-sync | --no-skip-deploy-sync`  <a name="sam-cli-command-reference-sam-sync-options-skip-deploy-sync"></a>
必要がない場合は、初期インフラストラクチャ同期をスキップするように `--skip-deploy-sync` を指定します。 AWS SAM CLI は、ローカル AWS SAM テンプレートをデプロイされた CloudFormation テンプレートと比較し、変更が検出された場合にのみデプロイを実行します。  
が実行されるたびに CloudFormation デプロイを実行する`--no-skip-deploy-sync`ように指定`sam sync`します。  
詳細については[初期 CloudFormation デプロイをスキップする](using-sam-cli-sync.md#using-sam-cli-sync-options-skip-deploy-sync)を参照してください。  
*デフォルト*: `--skip-deploy-sync`

`--stack-name TEXT`  <a name="sam-cli-command-reference-sam-sync-options-stack-name"></a>
アプリケーションの CloudFormation スタックの名前。  
このオプションは必須です。

`--tags LIST`  <a name="sam-cli-command-reference-sam-sync-options-tags"></a>
作成または更新されたスタックに関連付けるタグのリスト。 は、これらのタグをサポートしているスタック内のリソース CloudFormation にも伝播します。

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-sync-options-template-file"></a>
 AWS SAM テンプレートがあるパスとファイル名。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM デプロイします。

`--use-container, -u`  <a name="sam-cli-command-reference-sam-sync-options-use-container"></a>
関数がネイティブにコンパイルされた依存関係を持つパッケージに依存している場合は、このオプションを使用して AWS LambdaのようなDockerコンテナ内に関数を構築します。  
現在、このオプションには `--dependency-layer` との互換性がありません。`--use-container` を `--dependency-layer` と共に使用すると AWS SAMCLI にメッセージが表示され、`--no-dependency-layer` で処理が続行されます。

`--watch`  <a name="sam-cli-command-reference-sam-sync-options-watch"></a>
ローカルアプリケーションの変更を監視し、 に自動的に同期するプロセスを開始します AWS クラウド。デフォルトでは、このオプションを指定すると、 は更新時にアプリケーション内のすべてのリソースを AWS SAM 同期します。このオプションでは、 は初期 CloudFormation デプロイ AWS SAM を実行します。次に、 は AWS サービス APIs AWS SAM を使用してコードリソースを更新します。 AWS SAM テンプレートを更新すると、 AWS SAM は CloudFormation を使用してインフラストラクチャリソースを更新します。

`--watch-exclude TEXT`  <a name="sam-cli-command-reference-sam-sync-options-watch-exclude"></a>
ファイルに変更がないかどうかを確認するための監視対象からファイルまたはフォルダを除外します。このオプションを使用するには、`--watch` も指定する必要があります。  
このオプションは key-value ペアを受け取ります。  
+ **キー** – アプリケーション内の Lambda 関数の論理 ID。
+ **値** – 除外する関連付けられたファイル名またはフォルダ。
`--watch-exclude` オプションで指定されたファイルまたはフォルダを更新すると、 AWS SAM CLIは同期を開始しません。ただし、他のファイルまたはフォルダの更新によって同期が開始されると、これらのファイルまたはフォルダはその同期に含まれます。  
このオプションは、1 つのコマンドで複数回指定できます。

## 例
<a name="sam-cli-command-reference-sam-sync-examples"></a>

このコマンドの使用例については、「[sam sync コマンドのオプション](using-sam-cli-sync.md#using-sam-cli-sync-options)」を参照してください。

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

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

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

`sam traces` コマンドは、 の で AWS X-Ray トレースを取得します AWS アカウント AWS リージョン。

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

```
$ sam traces <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-traces-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-traces-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「`samconfig.toml`」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--end-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-end-time"></a>
この時刻までのトレースを取得します。時刻には、「5mins ago」、「tomorrow」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。

`--output TEXT`  <a name="sam-cli-command-reference-sam-traces-options-output"></a>
ログの出力形式を指定します。フォーマットされたログを印刷するには、`text` を指定します。ログを JSON として印刷するには、`json` を指定します。

`--save-params`  <a name="sam-cli-command-reference-sam-traces-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--start-time TEXT`  <a name="sam-cli-command-reference-sam-traces-options-start-time"></a>
この時刻以降のトレースを取得します。時刻には、「5mins ago」、「yesterday」などの相対的な値、または「2018-01-01 10:10:10」のような形式化されたタイムスタンプにすることができます。デフォルトは「10mins ago」です。

`--tail`  <a name="sam-cli-command-reference-sam-traces-options-tail"></a>
トレース出力の末尾を表示します。これにより、終了時間引数は無視され、トレースが使用可能になった時点で引き続き取得されます。

`--trace-id TEXT`  <a name="sam-cli-command-reference-sam-traces-options-trace-id"></a>
X-Ray トレースの固有の識別子。

## 例
<a name="sam-cli-command-reference-sam-traces-examples"></a>

次のコマンドを実行して、X-Ray トレースを ID で取得します。

```
$ sam traces --trace-id tracing-id-1 --trace-id tracing-id-2
```

次のコマンドを実行して、X-Ray トレースが使用可能になったら末尾を表示します。

```
$ sam traces --tail
```

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

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

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

`sam validate` コマンドは、 AWS SAM テンプレートファイルが有効かどうかを確認します。

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

```
$ sam validate <options>
```

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

`--config-env TEXT`  <a name="sam-cli-command-reference-sam-validate-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file PATH`  <a name="sam-cli-command-reference-sam-validate-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--debug`  <a name="sam-cli-command-reference-sam-validate-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--lint`  <a name="sam-cli-command-reference-sam-validate-options-lint"></a>
 **cfn-lint** を通じてテンプレートのリンティング検証を実行します。`cfnlintrc` 設定ファイルを作成して、追加のパラメータを指定します。詳細については、「*CloudFormation GitHub リポジトリ*」の「[cfn-lint](https://github.com/aws-cloudformation/cfn-lint)」を参照してください。

`--profile TEXT`  <a name="sam-cli-command-reference-sam-validate-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region TEXT`  <a name="sam-cli-command-reference-sam-validate-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="sam-cli-command-reference-sam-validate-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--template-file, --template, -t PATH`  <a name="sam-cli-command-reference-sam-validate-options-template-file"></a>
 AWS SAM テンプレートファイル。デフォルト値は `template.[yaml|yml]` です。  
 テンプレートが現在の作業ディレクトリにあり、`template.[yaml|yml|json]` という名前が付けられている場合、このオプションは必須ではありません。  
 **sam build** を実行したばかりの場合は、このオプションは不要です。

## 例
<a name="sam-cli-command-reference-sam-validate-examples"></a>

テンプレート検証のための、このコマンドの使用例については「[AWS SAM テンプレートファイルを検証する](serverless-sam-cli-using-validate.md)」を参照してください。

cfn-lint でこのコマンドを使用する例については、「[Linter CloudFormation で AWS SAM アプリケーションを検証する](validate-cfn-lint.md)」を参照してください。