AWS ドキュメント » AWS CloudFormation » ユーザーガイド » テンプレートリファレンス » AWS リソースおよびプロパティタイプのリファレンス » Amazon API Gateway リソースタイプのリファレンス » AWS::ApiGateway::Method » Amazon API Gateway Method MethodResponse

Filter View: All JSON YAML

Amazon API Gateway Method MethodResponse

MethodResponse は AWS::ApiGateway::Method リソースのプロパティであり、Amazon API Gateway (API Gateway) メソッドを呼び出すクライアントに送信するレスポンスを定義します。

構文

JSON

{
  "ResponseModels" : { 文字列: 文字列, ... },
  "ResponseParameters" : { String:Boolean, ... },
  "StatusCode" : String
}

YAML

ResponseModels:
  文字列: 文字列
ResponseParameters:
  文字列: ブール
StatusCode: String

プロパティ

ResponseModels

リソースは応答のコンテンツタイプに使用します。応答モデルをキーと値のペア (文字列から文字列へのマッピング) として指定します。コンテンツタイプがキーであり、Model リソース名が値です。

Required: No

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

ResponseParameters

メソッドを呼び出すクライアントに API Gateway が送信する応答パラメーター。レスポンスパラメーターをキーと値のペア (String から Boolean へのマッピング) として指定します。送信先がキー、Boolean が値です。method.response.header.name というパターンを使用して送信先を指定します。name は有効な一意のヘッダー名です。Boolean はパラメーターが必須かどうかを指定します。

Required: No

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

StatusCode

IntegrationResponse にマッピングするメソッド応答のステータスコード。

Required: Yes

Type: String