AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ApiGatewayV2::Types::UpdateIntegrationResponseRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

When making an API call, you may pass UpdateIntegrationResponseRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#content_handling_strategyString

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

Returns:

  • (String)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#integration_idString

Returns:

  • (String)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#integration_response_idString

Returns:

  • (String)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#integration_response_keyString

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)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#response_parametersHash<String,String>

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location\}.{name\} , where {location\} is querystring, path, or header; and {name\} must be a valid and unique method request parameter name.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.

Returns:

  • (Hash<String,String>)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#response_templatesHash<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>)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end

#template_selection_expressionString

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

Returns:

  • (String)


8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 8049

class UpdateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  SENSITIVE = []
  include Aws::Structure
end