You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::MethodResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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.

#### Example: A **MethodResponse** instance of an API ##### Request The example request retrieves a **MethodResponse** of the 200 status code. GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID\}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash\} ##### Response The successful response returns `200 OK` status and a payload as follows: \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \}
Method, IntegrationResponse, Integration [Creating an API][1]

Instance Attribute Summary collapse

Instance Attribute Details

#response_modelsHash<String,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.

Returns:

  • (Hash<String,String>)


4243
4244
4245
4246
4247
4248
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4243

class MethodResponse < Struct.new(
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

#response_parametersHash<String,Boolean>

A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

Returns:

  • (Hash<String,Boolean>)


4243
4244
4245
4246
4247
4248
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4243

class MethodResponse < Struct.new(
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end

#status_codeString

The method response's status code.

Returns:

  • (String)


4243
4244
4245
4246
4247
4248
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4243

class MethodResponse < Struct.new(
  :status_code,
  :response_parameters,
  :response_models)
  include Aws::Structure
end