Class: Aws::APIGateway::Types::PutIntegrationResponseRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutIntegrationResponseRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
When making an API call, you may pass PutIntegrationResponseRequest data as a hash:
{
rest_api_id: "String", # required
resource_id: "String", # required
http_method: "String", # required
status_code: "StatusCode", # required
selection_pattern: "String",
response_parameters: {
"String" => "String",
},
response_templates: {
"String" => "String",
},
content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
}
Represents a put integration response request.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#content_handling ⇒ String
Specifies how to handle response payload content type conversions.
-
#http_method ⇒ String
Specifies a put integration response request's HTTP method.
-
#resource_id ⇒ String
Specifies a put integration response request's resource identifier.
-
#response_parameters ⇒ Hash<String,String>
A key-value map specifying response parameters that are passed to the method response from the back end.
-
#response_templates ⇒ Hash<String,String>
Specifies a put integration response's templates.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
-
#selection_pattern ⇒ String
Specifies the selection pattern of a put integration response.
-
#status_code ⇒ String
Specifies the status code that is used to map the integration response to an existing MethodResponse.
Instance Attribute Details
#content_handling ⇒ String
Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with
the following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#http_method ⇒ String
Specifies a put integration response request's HTTP method.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#resource_id ⇒ String
Specifies a put integration response request's resource identifier.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#response_parameters ⇒ Hash<String,String>
A key-value map specifying response parameters that are passed to
the method response from the back end. The key is a method response
header parameter name and the mapped value is an integration
response header value, a static value enclosed within a pair of
single quotes, or a JSON expression from the integration response
body. The mapping key must match the pattern of
method.response.header.\{name\}
, where name
is a valid and
unique header name. The mapped non-static value must match the
pattern of integration.response.header.\{name\}
or
integration.response.body.\{JSON-expression\}
, where name
must
be a valid and unique response header name and JSON-expression
a
valid JSON expression without the $
prefix.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#response_templates ⇒ Hash<String,String>
Specifies a put integration response's templates.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#selection_pattern ⇒ String
Specifies the selection pattern of a put integration response.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#status_code ⇒ String
Specifies the status code that is used to map the integration response to an existing MethodResponse.
5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5193 class PutIntegrationResponseRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |