

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

 メソッドのレスポンスを定義し、統合レスポンスからメソッドレスポンスまでパラメーターマッピングまたはペイロードマッピングを指定します。


| プロパティ名 | タイプ | 説明 | 
| --- | --- | --- | 
| {{レスポンスステータスのパターン}} | [x-amazon-apigateway-integration.response オブジェクト](api-gateway-swagger-extensions-integration-response.md) | 統合レスポンスとメソッドレスポンスの照合に使用される正規表現、または未設定のすべての応答をキャッチするために使用される `default` のいずれかです。HTTP 統合の場合、この正規表現が統合レスポンスのステータスコードに適用されます。Lambda の呼び出しでは、Lambda 関数の実行によって例外がスローされるときに、失敗レスポンスの本文として AWS Lambda から返されるエラー情報オブジェクトの `errorMessage` フィールドに正規表現が適用されます。{{レスポンスステータスパターン}}のプロパティ名は、レスポンスステータスコードまたはレスポンスステータスコードのグループを表す正規表現を示しています。これは、API Gateway REST API の [IntegrationResponse](https://docs.aws.amazon.com/apigateway/latest/api/API_IntegrationResponse.html) リソースのどの識別子にも対応していません。 | 

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

次の例では、`2xx` から `302` までのレスポンスのリストが示されています。`2xx` レスポンスの場合、メソッドレスポンスは `application/json` または `application/xml` MIME タイプの統合レスポンスのペイロードからマッピングされます。このレスポンスでは、指定のマッピングテンプレートが使用されます。`302` レスポンスの場合、メソッドレスポンスは `Location` ヘッダーを返します。ヘッダーの値は、統合レスポンスのペイロードで `redirect.url` プロパティから派生した値です。

```
"responses" : {
    "2\\d{2}" : {
        "statusCode" : "200",
        "responseTemplates" : {
            "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
            "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
        }
    },
    "302" : {
        "statusCode" : "302",
        "responseParameters" : {
            "method.response.header.Location": "integration.response.body.redirect.url"
        }
    }
}
```

