UpdateMethodResponse - Amazon API Gateway


Updates an existing MethodResponse resource.

Request Syntax

PATCH /restapis/restapi_id/resources/resource_id/methods/http_method/responses/status_code HTTP/1.1 Content-type: application/json { "patchOperations": [ { "from": "string", "op": "string", "path": "string", "value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


The HTTP verb of the Method resource.

Required: Yes


The Resource identifier for the MethodResponse resource.

Required: Yes


The string identifier of the associated RestApi.

Required: Yes


The status code for the MethodResponse resource.

Pattern: [1-5]\d\d

Required: Yes

Request Body

The request accepts the following data in JSON format.


For more information about supported patch operations, see Patch Operations.

Type: Array of PatchOperation objects

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "responseModels": { "string" : "string" }, "responseParameters": { "string" : boolean }, "statusCode": "string" }

Response Elements

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

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


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


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


The method response's status code.

Type: String

Pattern: [1-5]\d\d


For information about the errors that are common to all actions, see Common Errors.


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


The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409


The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Update response parameters and models

This example illustrates one usage of UpdateMethodResponse.

Sample Request

PATCH /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/x-amz-json-1.1 Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160613T233140Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash} { "patchOperations" : [ { "op" : "replace", "path" : "/responseParameters/method.response.header.operator", "value" : "true" }, { "op" : "replace", "path" : "/responseModels/application~1json", "value" : "output" } ] }

Sample Response

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "output" }, "responseParameters": { "method.response.header.operator": true, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: