You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::PutIntegrationResponseRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutIntegrationResponseRequest
- Defined in:
- (unknown)
Overview
When passing PutIntegrationResponseRequest as input to an Aws::Client method, you can use a vanilla 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.
Instance Attribute Summary collapse
-
#content_handling ⇒ String
Specifies how to handle response payload content type conversions.
-
#http_method ⇒ String
[Required] Specifies a put integration response request\'s HTTP method.
-
#resource_id ⇒ String
[Required] 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
[Required] The string identifier of the associated RestApi.
-
#selection_pattern ⇒ String
Specifies the selection pattern of a put integration response.
-
#status_code ⇒ String
[Required] 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:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding binary blob.CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
Possible values:
- CONVERT_TO_BINARY
- CONVERT_TO_TEXT
#http_method ⇒ String
[Required] Specifies a put integration response request\'s HTTP method.
#resource_id ⇒ String
[Required] 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. 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.
#response_templates ⇒ Hash<String,String>
Specifies a put integration response\'s templates.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#selection_pattern ⇒ String
Specifies the selection pattern of a put integration response.
#status_code ⇒ String
[Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.