x-amazon-apigateway-gateway-responses.gatewayResponse オブジェクト

ステータスコード、該当するレスポンスパラメータ、またはレスポンステンプレートを含め、特定のレスポンスタイプのゲートウェイレスポンスを定義します。

プロパティ
プロパティ名	タイプ	説明
responseParameters	x-amazon-apigateway-gateway-responses.responseParameters	GatewayResponse パラメータ (ヘッダーパラメータ) を指定します。パラメータ値は、受信リクエストパラメータ値または静的なカスタム値です。
responseTemplates	x-amazon-apigateway-gateway-responses.responseTemplates	ゲートウェイレスポンスのマッピングテンプレートを指定します。テンプレートは、VTL エンジンでは処理されません。
statusCode	string	ゲートウェイレスポンスの HTTP ステータスコードです。

x-amazon-apigateway-gateway-responses.gatewayResponse の例

次の OpenAPI に対する API Gateway 拡張例では、GatewayResponse を定義し、INVALID_API_KEY レスポンスをカスタマイズして、456 のステータスコード、受信リクエストの api-key ヘッダー値、"Bad api-key" メッセージを返しています。

    "INVALID_API_KEY": {
      "statusCode": "456",
      "responseParameters": {
        "gatewayresponse.header.api-key": "method.request.header.api-key"
      },
      "responseTemplates": {
        "application/json": "{\"message\": \"Bad api-key\" }"
      }
    }