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.

Syntax

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

JSON


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

YAML


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

Properties

ResponseModels

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: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption

ResponseParameters

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: Object of String

Pattern: [a-zA-Z0-9]+

Update requires: No interruption

StatusCode

The method response's status code.

Required: Yes

Type: String

Update requires: No interruption

AWS::ApiGateway::Method MethodResponse

Syntax

JSON

YAML

Properties

See also