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

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