# PutMethodResponse
<a name="API_PutMethodResponse"></a>

Adds a MethodResponse to an existing Method resource.

## Request Syntax
<a name="API_PutMethodResponse_RequestSyntax"></a>

```
PUT /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   }
}
```

## URI Request Parameters
<a name="API_PutMethodResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [http\$1method](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-httpMethod"></a>
The HTTP verb of the Method resource.  
Required: Yes

 ** [resource\$1id](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-resourceId"></a>
The Resource identifier for the Method resource.  
Required: Yes

 ** [restapi\$1id](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-restApiId"></a>
The string identifier of the associated RestApi.  
Required: Yes

 ** [status\$1code](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-uri-statusCode"></a>
The method response's status code.  
Pattern: `[1-5]\d\d`   
Required: Yes

## Request Body
<a name="API_PutMethodResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [responseModels](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-responseModels"></a>
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.  
Type: String to string map  
Required: No

 ** [responseParameters](#API_PutMethodResponse_RequestSyntax) **   <a name="apigw-PutMethodResponse-request-responseParameters"></a>
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., `'application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.)  
Type: String to boolean map  
Required: No

## Response Syntax
<a name="API_PutMethodResponse_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "responseModels": { 
      "string" : "string" 
   },
   "responseParameters": { 
      "string" : boolean 
   },
   "statusCode": "string"
}
```

## Response Elements
<a name="API_PutMethodResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [responseModels](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-responseModels"></a>
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.  
Type: String to string map

 ** [responseParameters](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-responseParameters"></a>
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern `method.response.header.{name}`, where `name` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., `'application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.)  
Type: String to boolean map

 ** [statusCode](#API_PutMethodResponse_ResponseSyntax) **   <a name="apigw-PutMethodResponse-response-statusCode"></a>
The method response's status code.  
Type: String  
Pattern: `[1-5]\d\d` 

## Errors
<a name="API_PutMethodResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.  
HTTP Status Code: 400

 ** ConflictException **   
The request configuration has conflicts. For details, see the accompanying error message.  
HTTP Status Code: 409

 ** LimitExceededException **   
The request exceeded the rate limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** NotFoundException **   
The requested resource is not found. Make sure that the request URI is correct.  
HTTP Status Code: 404

 ** TooManyRequestsException **   
The request has reached its throttling limit. Retry after the specified time period.  
HTTP Status Code: 429

 ** UnauthorizedException **   
The request is denied because the caller has insufficient permissions.  
HTTP Status Code: 401

## Examples
<a name="API_PutMethodResponse_Examples"></a>

### Set up a method response with an optional Content-Type header
<a name="API_PutMethodResponse_Example_1"></a>

This example illustrates one usage of PutMethodResponse.

#### Sample Request
<a name="API_PutMethodResponse_Example_1_Request"></a>

```
PUT /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160603T004142Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
    "responseParameters" : {
        "method.response.header.Content-Type" : false
    },
    "responseModels" : {
        "application/json" : "Empty"
    }
}
```

#### Sample Response
<a name="API_PutMethodResponse_Example_1_Response"></a>

```
{
  "_links": {
    "curies": {
      "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html",
      "name": "methodresponse",
      "templated": true
    },
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200",
      "title": "200"
    },
    "methodresponse:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
    },
    "methodresponse:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200"
    }
  },
  "responseModels": {
    "application/json": "Empty"
  },
  "responseParameters": {
    "method.response.header.Content-Type": false
  },
  "statusCode": "200"
}
```

## See Also
<a name="API_PutMethodResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/apigateway-2015-07-09/PutMethodResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/apigateway-2015-07-09/PutMethodResponse)