Class: Aws::ApiGatewayV2::Types::GetIntegrationResult

Inherits:

Struct

Object
Struct
Aws::ApiGatewayV2::Types::GetIntegrationResult

show all

Includes:: Structure

Defined in:: lib/aws-sdk-apigatewayv2/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#api_gateway_managed ⇒ Boolean
#connection_id ⇒ String

A string with a length between [1-1024].
#connection_type ⇒ String

Represents a connection type.
#content_handling_strategy ⇒ String

Specifies how to handle response payload content type conversions.
#credentials_arn ⇒ String

Represents an Amazon Resource Name (ARN).
#description ⇒ String

A string with a length between [0-1024].
#integration_id ⇒ String

The identifier.
#integration_method ⇒ String

A string with a length between [1-64].
#integration_response_selection_expression ⇒ String

An expression used to extract information at runtime.
#integration_subtype ⇒ String

A string with a length between [1-128].
#integration_type ⇒ String

Represents an API method integration type.
#integration_uri ⇒ String

A string representation of a URI with a length between [1-2048].
#passthrough_behavior ⇒ String

Represents passthrough behavior for an integration response.
#payload_format_version ⇒ String

A string with a length between [1-64].
#request_parameters ⇒ Hash<String,String>

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
#request_templates ⇒ Hash<String,String>

A mapping of identifier keys to templates.
#response_parameters ⇒ Hash<String,Hash<String,String>>

Supported only for HTTP APIs.
#template_selection_expression ⇒ String

An expression used to extract information at runtime.
#timeout_in_millis ⇒ Integer

An integer with a value between [50-30000].
#tls_config ⇒ Types::TlsConfig

The TLS configuration for a private integration.

Instance Attribute Details

#api_gateway_managed ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_id ⇒ `String`

A string with a length between [1-1024].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ `String`

Represents a connection type.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  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)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#credentials_arn ⇒ `String`

Represents an Amazon Resource Name (ARN).

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A string with a length between [0-1024].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_id ⇒ `String`

The identifier.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_method ⇒ `String`

A string with a length between [1-64].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_subtype ⇒ `String`

A string with a length between [1-128].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_type ⇒ `String`

Represents an API method integration type.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#integration_uri ⇒ `String`

A string representation of a URI with a length between [1-2048].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#passthrough_behavior ⇒ `String`

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#payload_format_version ⇒ `String`

A string with a length between [1-64].

Returns:

(String)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#request_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 <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].

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

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#response_parameters ⇒ `Hash<String,Hash<String,String>>`

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.

Returns:

(Hash<String,Hash<String,String>>)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  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)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_millis ⇒ `Integer`

An integer with a value between [50-30000].

Returns:

(Integer)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

#tls_config ⇒ `Types::TlsConfig`

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Returns:

(Types::TlsConfig)

# File 'lib/aws-sdk-apigatewayv2/types.rb', line 3800

class GetIntegrationResult < Struct.new(
  :api_gateway_managed,
  :connection_id,
  :connection_type,
  :content_handling_strategy,
  :credentials_arn,
  :description,
  :integration_id,
  :integration_method,
  :integration_response_selection_expression,
  :integration_subtype,
  :integration_type,
  :integration_uri,
  :passthrough_behavior,
  :payload_format_version,
  :request_parameters,
  :response_parameters,
  :request_templates,
  :template_selection_expression,
  :timeout_in_millis,
  :tls_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ApiGatewayV2::Types::GetIntegrationResult

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#api_gateway_managed ⇒ Boolean

#connection_id ⇒ String

#connection_type ⇒ String

#content_handling_strategy ⇒ String

#credentials_arn ⇒ String

#description ⇒ String

#integration_id ⇒ String

#integration_method ⇒ String

#integration_response_selection_expression ⇒ String

#integration_subtype ⇒ String

#integration_type ⇒ String

#integration_uri ⇒ String

#passthrough_behavior ⇒ String

#payload_format_version ⇒ String

#request_parameters ⇒ Hash<String,String>

#request_templates ⇒ Hash<String,String>

#response_parameters ⇒ Hash<String,Hash<String,String>>

#template_selection_expression ⇒ String

#timeout_in_millis ⇒ Integer

#tls_config ⇒ Types::TlsConfig

#api_gateway_managed ⇒ `Boolean`

#connection_id ⇒ `String`

#connection_type ⇒ `String`

#content_handling_strategy ⇒ `String`

#credentials_arn ⇒ `String`

#description ⇒ `String`

#integration_id ⇒ `String`

#integration_method ⇒ `String`

#integration_response_selection_expression ⇒ `String`

#integration_subtype ⇒ `String`

#integration_type ⇒ `String`

#integration_uri ⇒ `String`

#passthrough_behavior ⇒ `String`

#payload_format_version ⇒ `String`

#request_parameters ⇒ `Hash<String,String>`

#request_templates ⇒ `Hash<String,String>`

#response_parameters ⇒ `Hash<String,Hash<String,String>>`

#template_selection_expression ⇒ `String`

#timeout_in_millis ⇒ `Integer`

#tls_config ⇒ `Types::TlsConfig`