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

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_id ⇒ String

Returns:

  • (String) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

#content_handling_strategy ⇒ String

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

Returns:

  • (String) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

#integration_id ⇒ String

Returns:

  • (String) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

#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][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

  • (String) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

#response_parameters ⇒ Hash<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 &lt;action&gt;:&lt;header|querystring|path&gt;.&lt;location&gt; 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].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

Returns:

  • (Hash<String,String>) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

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


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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

#template_selection_expression ⇒ String

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

  • (String) 


1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
 
# File 'lib/aws-sdk-apigatewayv2/types.rb', line 1888

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