AWS::ApiGateway::Method MethodResponse - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ApiGateway::Method MethodResponse

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "ResponseModels" : {Key : Value, ...}, "ResponseParameters" : {Key : Value, ...}, "StatusCode" : String }


ResponseModels: Key : Value ResponseParameters: Key : Value StatusCode: String



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.

Required: No

Type: Map of String

Update requires: No interruption


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.)

Required: No

Type: Map of Boolean

Update requires: No interruption


The method response's status code.

Required: Yes

Type: String

Update requires: No interruption

See also

  • Method in the Amazon API Gateway REST API Reference