メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

Amazon API Gateway のメソッドの統合 IntegrationResponse

IntegrationResponseAmazon API Gateway のメソッドの統合 IntegrationResponse プロパティのプロパティであり、メソッドがバックエンドでリクエストの処理を完了した後に Amazon API Gateway (API Gateway) が送信するレスポンスを指定します。

構文

JSON

{ "ContentHandling" : String, "ResponseParameters" : { 文字列: 文字列, ... }, "ResponseTemplates" : { 文字列: 文字列, ... }, "SelectionPattern" : String, "StatusCode" : String }

YAML

ContentHandling: String ResponseParameters: 文字列: 文字列 ResponseTemplates: 文字列: 文字列 SelectionPattern: String StatusCode: String

プロパティ

ContentHandling

リクエストペイロードのコンテンツタイプの変換を処理する方法を指定します。有効な値は次のとおりです。

  • CONVERT_TO_BINARY: リクエストペイロードを Base64 でエンコードされた文字列からバイナリ BLOB に変換します。

  • CONVERT_TO_TEXT: リクエストペイロードをバイナリ BLOB から Base64 でエンコードされた文字列に変換します。

このプロパティが定義されていない場合、リクエストペイロードは変更されずにメソッドリクエストから統合リクエストに渡されます。

必須: いいえ

タイプ: 文字列

更新に伴う要件: 中断はありません。

ResponseParameters

API Gateway がメソッドレスポンスに送信するバックエンドレスポンスからのレスポンスパラメータ。リソースパラメーターをキーと値のペアとして指定します (文字列間のマッピング)。

送信先をキーとして、ソースを値として使用します。

  • 送信先は MethodResponse プロパティの既存のレスポンスパラメーターである必要があります。

  • ソースは、既存のメソッドリクエストパラメーターまたは静的な値である必要があります。静的な値は一重引用符で囲み、リクエスト内で指定された送信先に基づいて事前に値をエンコードする必要があります。

詳細については、API Gateway 開発者ガイドAPI Gateway API リクエストとレスポンスパラメーターのマッピングのリファレンスを参照してください。

Required: No

: キーと値のペアのマッピング

ResponseTemplates

統合レスポンス本文の変換に使用するテンプレート。テンプレートをキーと値のペア (文字列から文字列へのマッピング) として指定します。コンテンツタイプがキー、テンプレートが値です。詳細については、API Gateway 開発者ガイドAPI Gateway API リクエストとレスポンスペイロードのマッピングテンプレートのリファレンスを参照してください。

Required: No

: キーと値のペアのマッピング

SelectionPattern

バックエンドマップから統合レスポンスへのエラー文字列またはステータスコードを指定する正規表現

Required: No

Type: String

StatusCode

API Gateway が統合レスポンスを MethodResponse ステータスコードにマッピングするために使用するステータスコード。

Required: Yes

Type: String

このページの内容: