Class: Aws::APIGateway::Types::PutMethodResponseRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutMethodResponseRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Request to add a MethodResponse to an existing Method resource.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#http_method ⇒ String
The HTTP verb of the Method resource.
-
#resource_id ⇒ String
The Resource identifier for the Method resource.
-
#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.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
-
#status_code ⇒ String
The method response's status code.
Instance Attribute Details
#http_method ⇒ String
The HTTP verb of the Method resource.
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#resource_id ⇒ String
The Resource identifier for the Method resource.
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#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.
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :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 name and the associated value is a Boolean flag
indicating whether the method response parameter is required or not.
The method response header names must match the pattern of
method.response.header.\{name\}
, where name
is a valid and
unique header name. The response parameter names defined here are
available in the integration response to be mapped from 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.)
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |
#status_code ⇒ String
The method response's status code.
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4316 class PutMethodResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :response_parameters, :response_models) SENSITIVE = [] include Aws::Structure end |