sam local invoke - AWS Serverless Application Model

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

sam local invoke

ローカルの AWS Lambda 関数を 1 回呼び出し、呼び出しが完了した後に終了します。

デフォルトでは、このコマンドを使用すると、AWS SAM CLI は現在の作業ディレクトリがプロジェクトのルートディレクトリであると見なされます。AWS SAM CLI は、最初にsam buildコマンドで、.aws-samサブフォルダ、および名前付きtemplate.yamlまたはtemplate.yml。次に、AWS SAM CLI は、template.yamlまたはtemplate.yml現在の作業ディレクトリで。指定すると、--templateオプションを使用すると、AWS SAM CLI のデフォルトの動作が上書きされ、その AWS SAM テンプレートとそれが指すローカルリソースのみがロードされます。

ネストされたアプリケーションまたはスタックの関数を呼び出すには、アプリケーションまたはスタックの論理 ID と、関数論理 ID をStackLogicalId/FunctionLogicalId

-sam local invokeコマンドは、Amazon Simple Storage Service (Amazon S3) や Amazon Kinesis イベントなどの非同期イベントを処理するサーバーレス関数を開発する場合に便利です。テストケースのスクリプトを作成する場合にも便利です。イベント本体を渡すには、--eventパラメータ。イベントの詳細については、以下を参照してください。イベント()AWS Lambda デベロッパーガイド。さまざまな AWS サービスからのイベントメッセージ形式の詳細については、他のサービスでの使用()AWS Lambda デベロッパーガイド

ランタイム出力(ログなど)はstderrLambda 関数の結果はstdout

注記

AWS SAM テンプレートに複数の関数が定義されている場合は、FUNCTION_LOGICAL_ID呼び出す関数の 1 つです。

使用:

sam local invoke [OPTIONS] [FUNCTION_LOGICAL_ID]

オプション:

オプション 説明
-e, --event PATH 呼び出されたときに Lambda 関数に渡されるイベントデータを含む JSON ファイル。このオプションを指定しない場合、イベントは想定されません。から JSON を入力するにはstdinそのためには、値 '-' を渡す必要があります。さまざまな AWS サービスからのイベントメッセージ形式の詳細については、他のサービスでの使用()AWS Lambda デベロッパーガイド
--no-event 空のイベントを使用して関数を呼び出します。
-t, --template PATH AWS SAM テンプレートファイル。

注意: このオプションを指定すると、AWS SAM はテンプレートとそれが指すローカルリソースのみを読み込みます。

-n, --env-vars PATH Lambda 関数の環境変数の値を含む JSON ファイル。環境変数ファイルの詳細については、「」を参照してください。環境変数ファイル
--parameter-overrides (オプション) キーと値のペアとしてエンコードされた AWS CloudFormation パラメータオーバーライドを含む文字列。AWS Command Line Interface (AWS CLI) と同じ形式を使用します。たとえば、、などです。ParameterKey=KeyPairName,ParameterValue=MyKey ParameterKey=InstanceType,ParameterValue=t1.micro'。
-d, --debug-port TEXT 指定すると、Lambda 関数コンテナをデバッグモードで起動し、このポートをローカルホストに公開します。
--debugger-path TEXT Lambda コンテナにマウントされたデバッガーへのホストパス。
--debug-args TEXT デバッガーに渡す追加の引数。
-v, --docker-volume-basedir TEXT AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、AWS SAM ファイルが Docker マシンに存在するパスをマウントし、この値をリモートマシンと一致するように変更する必要があります。
--docker-network TEXT Lambda Docker コンテナが接続する必要のある既存の Docker ネットワークの名前または ID、およびデフォルトのブリッジネットワークです。これを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。
--container-env-vars (オプション)ローカルでデバッグするときに、環境変数を Lambda 関数イメージコンテナに渡します。
-l, --log-file TEXT ランタイムログを送信するログファイル。
--layer-cache-basedir DIRECTORY テンプレートで使用するレイヤーがダウンロードされるベースディレクトリの場所を指定します。
--skip-pull-image AWS SAM CLI が Lambda ランタイムの最新の Docker イメージのプルダウンをスキップするかどうかを指定します。
--force-image-build AWS SAM CLI が Layer を使用して Lambda 関数を呼び出すために使用されるイメージを再構築するかどうかを指定します。
--profile TEXT 認証情報ファイルから特定のプロファイル。AWS 認証情報を取得します。
--region TEXT デプロイ先の AWS リージョン。たとえば、us-east-1 です。
--config-file PATH 使用するデフォルトのパラメータ値を含む設定ファイルのファイル名。デフォルト値はです。samconfig.tomlプロジェクトディレクトリのルートに「。設定ファイルについて詳しくは、AWS SAM CLI 設定ファイル を参照してください。
--config-env TEXT 使用する設定ファイル内のデフォルトのパラメータ値を指定する環境名。デフォルト値はです。設定ファイルについて詳しくは、AWS SAM CLI 設定ファイル を参照してください。
--shutdown シャットダウン動作の拡張処理をテストするために、呼び出しが完了した後にシャットダウンイベントをエミュレートします。
--container-host TEXT ローカルでエミュレートされた Lambda コンテナのホスト。デフォルト値は localhost です。macOS の Docker コンテナで AWS SAM CLI を実行する場合は、host.docker.internal。AWS SAM CLI とは異なるホストでコンテナを実行する場合は、リモートホストの IP アドレスを指定できます。
--container-host-interface TEXT コンテナポートがバインドするホストネットワークインターフェースの IP アドレス。デフォルト値は 127.0.0.1 です。を使用する0.0.0.0を使用してすべてのインターフェイスにバインドします。
--debug デバッグログをオンにして、AWS SAM CLI によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。
--help このメッセージを表示して終了します。