Class: Aws::APIGateway::Types::IntegrationResponse

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::IntegrationResponse

Includes:

Structure

Defined in:

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.

<div class=“seeAlso” markdown=“1”>

Creating an API][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-create-api.html

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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:

• ‘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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4906

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 4906

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 4906

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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4906

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.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4906

class IntegrationResponse < Struct.new(
  :status_code,
  :selection_pattern,
  :response_parameters,
  :response_templates,
  :content_handling)
  SENSITIVE = []
  include Aws::Structure
end