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

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

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 CreateIntegrationResponseRequest 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_key: "SelectionKey", # required
  response_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
}

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end

#content_handling_strategyString

Specifies how to handle response payload content type conversions.

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end

#integration_idString

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end

#integration_response_keyString

After evaulating 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)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end

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


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  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>)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end

#template_selection_expressionString

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

Returns:

  • (String)


1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 1439

class CreateIntegrationResponseRequest < Struct.new(
  :api_id,
  :content_handling_strategy,
  :integration_id,
  :integration_response_key,
  :response_parameters,
  :response_templates,
  :template_selection_expression)
  include Aws::Structure
end