You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::CreateIntegrationResponseRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateIntegrationResponseRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  api_id: "__string", # required
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  integration_id: "__string", # required
  integration_response_key: "SelectionKey", # required
  response_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_id ⇒ String

Returns:

  • (String)

#content_handling_strategy ⇒ String

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

Possible values:

  • CONVERT_TO_BINARY
  • CONVERT_TO_TEXT

Returns:

  • (String) —

    Specifies how to handle response payload content type conversions.

#integration_id ⇒ String

Returns:

  • (String)

#integration_response_key ⇒ String

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Returns:

  • (String) —

    After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key.

#response_parameters ⇒ Hash<String,String>

A key-value map specifying response parameters that are passed to the method response from the backend. 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>) —

    A key-value map specifying response parameters that are passed to the method response from the backend.

#response_templates ⇒ Hash<String,String>

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.

Returns:

  • (Hash<String,String>) —

    A mapping of identifier keys to templates.

#template_selection_expression ⇒ String

An expression used to extract information at runtime. See Selection Expressions for more information.

Returns:

  • (String) —

    An expression used to extract information at runtime.