Class: Aws::APIGateway::Types::IntegrationResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::IntegrationResponse
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#content_handling ⇒ String
Specifies how to handle response payload content type conversions.
-
#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 the templates used to transform the integration response body.
-
#selection_pattern ⇒ String
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
-
#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.
3490 3491 3492 3493 3494 3495 3496 3497 3498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3490 class IntegrationResponse < Struct.new( :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
is a
valid and unique response header name and JSON-expression
is a
valid JSON expression without the $
prefix.
3490 3491 3492 3493 3494 3495 3496 3497 3498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3490 class IntegrationResponse < Struct.new( :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#response_templates ⇒ Hash<String,String>
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
3490 3491 3492 3493 3494 3495 3496 3497 3498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3490 class IntegrationResponse < Struct.new( :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |
#selection_pattern ⇒ String
Specifies the regular expression (regex) pattern used to choose an
integration response based on the response from the back end. For
example, if the success response returns nothing and the error
response returns some string, you could use the .+
regex to match
error response. However, make sure that the error response does not
contain any newline (\n
) character in such cases. If the back end
is an Lambda function, the Lambda function error header is matched.
For all other HTTP and Amazon Web Services back ends, the HTTP
status code is matched.
3490 3491 3492 3493 3494 3495 3496 3497 3498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3490 class IntegrationResponse < Struct.new( :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.
3490 3491 3492 3493 3494 3495 3496 3497 3498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3490 class IntegrationResponse < Struct.new( :status_code, :selection_pattern, :response_parameters, :response_templates, :content_handling) SENSITIVE = [] include Aws::Structure end |