翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
sam remote invoke
このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) sam remote invoke
コマンド。
-
の概要 AWS SAM CLI、「」を参照してください。 AWS SAMCLI とは?
-
の使用に関するドキュメントについては、 AWS SAM CLI
sam remote invoke
コマンド、「」を参照してくださいを使用したクラウドでのテストの概要 sam remote invoke。
sam remote invoke
コマンドは、 AWS クラウドでサポートされているリソースを呼び出します。
使用方法
$
sam remote invoke
<arguments> <options>
引数
- リソース ID
-
呼び出すサポート対象リソースの ID です。
この引数には、次の値を使用できます。
-
Amazon リソースネーム (ARN) – リソースARNの 。
ヒント
sam list stack-outputs --stack-name
を使用して、 リソースARNの を取得します。<stack-name>
-
論理 ID – リソースの論理 ID。また、
--stack-name
オプションを使用して AWS CloudFormation スタック名を指定する必要があります。 -
物理 ID — リソースの物理 ID。この ID は、 を使用してリソースをデプロイするときに作成されます AWS CloudFormation。
ヒント
sam list resources --stack-name
を使用してリソースの物理 ID を取得します。<stack-name>
- ARN または物理 ID を指定する場合:
-
ARN または物理 ID を指定する場合は、スタック名を指定しないでください。
--stack-name
オプションを使用してスタック名を指定するか、スタック名が設定ファイルで定義されている場合、 AWS SAM CLI は、 AWS CloudFormation スタックからの論理 ID 値としてリソース ID を自動的に処理します。 - リソース ID を指定しない場合:
-
リソース ID を指定せず、
--stack-name
オプションでスタック名を指定した場合、 AWS SAM CLIは、次のロジックを使用して AWS CloudFormation スタック内のリソースを自動的に呼び出そうとします。-
の AWS SAM CLI は、次の順序でリソースタイプを識別し、スタックでリソースタイプが見つかったら次のステップに移動します。
-
Lambda
-
Step Functions
-
Amazon SQS
-
Kinesis Data Streams
-
-
リソースタイプにスタック内に 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 は、スタックに単一の Lambda リソースが含まれているため、Lambda 関数を見つけて呼び出します。
-
1 つの Amazon SQSキューと 2 つの Kinesis Data Streams アプリケーションを含むスタック – AWS SAM CLI は、スタックに単一の Amazon SQSキューが含まれているため、Amazon SQSキューを見つけて呼び出します。
-
-
オプション
--beta-features | --no-beta-features
-
ベータ機能を許可または拒否します。
--config-env
TEXT
-
から使用する環境を指定する AWS SAM CLI 設定ファイル。
デフォルト:
default
--config-file
FILENAME
-
設定ファイルのパスとファイル名を指定します。
設定ファイルの詳細については、「AWS SAM CLI の設定」を参照してください。
デフォルト: プロジェクトディレクトリのルートにある
samconfig.toml
。 --debug
-
デバッグログの記録をアクティブ化します。これにより、 によって生成されたデバッグメッセージとタイムスタンプが出力されます。 AWS SAM CLI.
--event, -e
TEXT
-
ターゲットリソースに送信するイベントです。
--event-file
FILENAME
-
ターゲットリソースに送信するイベントが含まれるファイルへのパスです。
--help, -h
-
ヘルプメッセージを表示して終了します。
--output
[ text | json ]
-
呼び出しの結果を特定の出力形式で出力します。
json
– リクエストメタデータとリソースレスポンスは JSON構造で返されます。レスポンスにはフルSDK出力が含まれます。text
– リクエストメタデータがテキスト構造で返されます。リソースレスポンスは、呼び出されたリソースの出力形式で返されます。 --parameter
-
追加の Boto3
呼び出されるリソースに渡すことができるパラメータ。 - Amazon Kinesis Data Streams
-
次の追加パラメータは、Kinesis データストリームにレコードを追加するために使用できます。
-
ExplicitHashKey='
string
' -
PartitionKey='
string
' -
SequenceNumberForOrdering='
string
' -
StreamARN='
string
'
各パラメータの説明については、「Kinesis.Client.Put_Record
」を参照してください。 -
- AWS Lambda
-
以下の追加のパラメータは、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
-
レスポンスストリーミングを使用する Lambda – Lambda.Client.Invoke_with_Response_Stream
-
- Amazon Simple Queue Service (Amazon SQS)
-
Amazon SQSキューにメッセージを送信するには、次の追加パラメータを使用できます。
-
DelaySeconds=
integer
-
MessageAttributes='
json string
' -
MessageDeduplicationId='
string
' -
MessageGroupId='
string
' -
MessageSystemAttributes='
json string
'
各パラメータの説明については、SQS「.Client.send_message
」を参照してください。 -
- AWS Step Functions
-
次の追加パラメータは、ステートマシンの実行を開始するために使用できます。
-
name='
string
' -
traceHeader='
string
'
各パラメータの説明については、SFN「.Client.start_execution
」を参照してください。 -
--profile
TEXT
-
認証情報ファイルから AWS 認証情報を取得する特定のプロファイル。
--region
TEXT
-
リソース AWS リージョン の 。例えば、
us-east-1
と指定します。 --stack-name
TEXT
-
リソースが属する AWS CloudFormation スタックの名前。
--test-event-name
NAME
-
Lambda 関数に渡す共有可能なテストイベントの名前。
注記
このオプションは Lambda 関数のみをサポートします。
例
次の例では、 AWS クラウドでサポートされているリソースを呼び出し、デバッグログ記録をアクティブ化します。これにより、 によって生成されたデバッグメッセージとタイムスタンプが出力されます。 AWS SAM CLI:
$
sam remote invoke--debug