Class: Aws::APIGateway::Types::MethodResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::MethodResponse
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#response_models ⇒ Hash<String,String>
Specifies the Model resources used for the response's content-type.
-
#response_parameters ⇒ Hash<String,Boolean>
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
-
#status_code ⇒ String
The method response's status code.
Instance Attribute Details
#response_models ⇒ Hash<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.
3650 3651 3652 3653 3654 3655 3656 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3650 class MethodResponse < Struct.new( :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#response_parameters ⇒ Hash<String,Boolean>
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.)
3650 3651 3652 3653 3654 3655 3656 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3650 class MethodResponse < Struct.new( :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#status_code ⇒ String
The method response's status code.
3650 3651 3652 3653 3654 3655 3656 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3650 class MethodResponse < Struct.new( :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |