Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon API Gateway Method MethodResponse

MethodResponse is a property of the AWS::ApiGateway::Method resource that defines the responses that can be sent to the client who calls an Amazon API Gateway (API Gateway) method.

Syntax

JSON

Copy
{ "ResponseModels" : { String:String, ... }, "ResponseParameters" : { String:Boolean, ... }, "StatusCode" : String }

YAML

Copy
ResponseModels: String: String ResponseParameters: String: Boolean StatusCode: String

Properties

ResponseModels

The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

Required: No

Type: Mapping of key-value pairs

ResponseParameters

Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required.

Required: No

Type: Mapping of key-value pairs

StatusCode

The method response's status code, which you map to an IntegrationResponse.

Required: Yes

Type: String