methodResponses property

Map<String, MethodResponse>? methodResponses
final

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET
/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1
Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com
Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization:
AWS4-HMAC-SHA256
Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request,
SignedHeaders=content-type;host;x-amz-date,
Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_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": "Empty" }, "responseParameters": {
"method.response.header.operator": false,
"method.response.header.operand_2": false,
"method.response.header.operand_1": false }, "statusCode": "200"
}

AWS CLI

Implementation

final Map<String, MethodResponse>? methodResponses;