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

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


| プロパティ名 | タイプ | 説明 | 
| --- | --- | --- | 
| responseParameters | [x-amazon-apigateway-gateway-responses.responseParameters](api-gateway-swagger-extensions-gateway-responses.responseParameters.md) |  [GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html) パラメータ (ヘッダーパラメータ) を指定します。パラメータ値は、受信[リクエストパラメータ](rest-api-parameter-mapping.md)値または静的なカスタム値です。  | 
| responseTemplates | [x-amazon-apigateway-gateway-responses.responseTemplates](api-gateway-swagger-extensions-gateway-responses.responseTemplates.md) |  ゲートウェイレスポンスのマッピングテンプレートを指定します。テンプレートは、VTL エンジンでは処理されません。  | 
| statusCode | string |  ゲートウェイレスポンスの HTTP ステータスコードです。  | 

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

 次の OpenAPI に対する API Gateway 拡張例では、[GatewayResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_GatewayResponse.html) を定義し、`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\" }"
      }
    }
```