「翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。」
sam local invoke
ローカル AWS Lambda 関数を一度呼び出し、呼び出しが完了した後に終了します。
これは、Amazon Simple Storage Service (Amazon S3) や Amazon Kinesis イベントなどの非同期イベントを処理するサーバーレス関数を開発する場合に便利です。テストケースのスクリプトを作成する場合にも便利です。パラメータを使用してイベント本文を渡すことができます。--event
ランタイム出力 (ログなど) は stderr
に出力され、Lambda 関数の結果は stdout
に出力されます。
拡張機能を使用するサーバーレスアプリケーションをローカルでテストするには、Lambda 環境変数を「1」に設定します。ENABLE_LAMBDA_EXTENSIONS_PREVIEW
次に例を示します。
ENABLE_LAMBDA_EXTENSIONS_PREVIEW=1 sam local invoke
拡張機能の詳細については、Lambda の「AWS Lambda 拡張機能の使用」を参照してください。AWS Lambda Developer Guide
使用:
sam local invoke [OPTIONS] [FUNCTION_IDENTIFIER]
オプション:
オプション | 説明 |
---|---|
-e, --event PATH |
関数が呼び出されたときに渡されるイベントデータを含む JSON ファイル。Lambdaこのオプションを指定しない場合、イベントは想定されません。から JSON を入力するには、値「-」を渡す必要があります。stdin |
--no-event |
空のイベントを使用して関数を呼び出します。 |
-t, --template PATH |
AWS SAM テンプレートファイル [デフォルト: template.[yaml|yml]]。 |
-n, --env-vars PATH |
関数の環境変数の値を含む JSON ファイル。Lambda環境変数ファイルの詳細については、「環境変数ファイル」を参照してください。 |
--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 がリモートマシンで実行されている場合は、Docker マシン上に AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンと一致するように変更する必要があります。 |
--docker-network TEXT |
Docker コンテナが接続する必要のある既存の Docker ネットワークの名前または ID、およびデフォルトのブリッジネットワークです。Lambdaこれを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。 |
--container-env-vars |
(オプション) ローカルでのデバッグ時に、環境変数を Lambda 関数イメージコンテナに渡します。 |
-l, --log-file TEXT |
ランタイムログを送信するログファイル。 |
--layer-cache-basedir DIRECTORY |
テンプレートが使用するレイヤーがダウンロードされる場所 basedir を指定します。 |
--skip-pull-image |
CLI が AWS SAM ランタイムの最新の Docker イメージのプルダウンをスキップするかどうかを指定します。Lambda |
--force-image-build |
CLI がレイヤーを使用して AWS SAM 関数を呼び出すために使用されるイメージを再構築するかどうかを指定します。Lambda |
--profile TEXT |
認証情報を取得する認証情報ファイルからの特定のプロファイル。AWS |
--region TEXT |
デプロイ先の AWS リージョン。たとえば、us-east-1 です。 |
--config-file PATH |
使用するデフォルトのパラメータ値を含む設定ファイルのパスとファイル名。デフォルト値はプロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルについて詳しくは、AWS SAM CLI 設定ファイル を参照してください。 |
--config-env TEXT |
使用する設定ファイルのデフォルトのパラメータ値を指定する環境名。デフォルト値は "default" です。設定ファイルについて詳しくは、AWS SAM CLI 設定ファイル を参照してください。 |
--debug |
デバッグログをオンにして、AWS SAM CLI によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。 |
--help |
このメッセージを表示して終了します。 |