# x-amazon-apigateway-gateway-responses オブジェクト
<a name="api-gateway-swagger-extensions-gateway-responses"></a>

API のゲートウェイレスポンスを、キーと値のペアの string-to-[GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html) マップとして定義します。この拡張機能は、ルートレベルの OpenAPI 構造に適用されます。


| プロパティ名 | タイプ | 説明 | 
| --- | --- | --- | 
| responseType | [x-amazon-apigateway-gateway-responses.gatewayResponse](api-gateway-swagger-extensions-gateway-responses.gatewayResponse.md) |  指定した *responseType* の `GatewayResponse`です。  | 

## x-amazon-apigateway-gateway-responses の例
<a name="api-gateway-swagger-extensions-gateway-responses-example"></a>

 次の OpenAPI に対する API Gateway 拡張例では、2 つの [GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html) インスタンス (1 つは `DEFAULT_4XX` タイプ用、もう 1 つは `INVALID_API_KEY` タイプ用) を含む [GatewayResponses](https://docs.aws.amazon.com/apigateway/latest/api/API_GetGatewayResponses.html) マップを定義しています。

```
{
  "x-amazon-apigateway-gateway-responses": {
    "DEFAULT_4XX": {
      "responseParameters": {
        "gatewayresponse.header.Access-Control-Allow-Origin": "'domain.com'"
      },
      "responseTemplates": {
        "application/json": "{\"message\": test 4xx b }"
      }
    },
    "INVALID_API_KEY": {
      "statusCode": "429",
      "responseTemplates": {
        "application/json": "{\"message\": test forbidden }"
      }
    }
  }
}
```