Class: Aws::ApiGatewayV2::Types::GetApiResponse

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::GetApiResponse

Includes:

Structure

Defined in:

lib/aws-sdk-apigatewayv2/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_endpoint ⇒ String
• #api_gateway_managed ⇒ Boolean
• #api_id ⇒ String

  The identifier.

• #api_key_selection_expression ⇒ String

  An expression used to extract information at runtime.

• #cors_configuration ⇒ Types::Cors

  Represents a CORS configuration.

• #created_date ⇒ Time
• #description ⇒ String

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

• #disable_execute_api_endpoint ⇒ Boolean
• #disable_schema_validation ⇒ Boolean
• #import_info ⇒ Array<String>
• #name ⇒ String

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

• #protocol_type ⇒ String

  Represents a protocol type.

• #route_selection_expression ⇒ String

  An expression used to extract information at runtime.

• #tags ⇒ Hash<String,String>

  Represents a collection of tags associated with the resource.

• #version ⇒ String

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

• #warnings ⇒ Array<String>

Instance Attribute Details

#api_endpoint ⇒ String

Returns:

• (String)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_gateway_managed ⇒ Boolean

Returns:

• (Boolean)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The identifier.

Returns:

• (String)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#api_key_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 3336

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#cors_configuration ⇒ Types::Cors

Represents a CORS configuration. Supported only for HTTP APIs. See

Configuring CORS][1

for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html

Returns:

• (Types::Cors)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

Returns:

• (Time)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  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 3336

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#disable_execute_api_endpoint ⇒ Boolean

Returns:

• (Boolean)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#disable_schema_validation ⇒ Boolean

Returns:

• (Boolean)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#import_info ⇒ Array<String>

Returns:

• (Array<String>)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#protocol_type ⇒ String

Represents a protocol type.

Returns:

• (String)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#route_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 3336

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Represents a collection of tags associated with the resource.

Returns:

• (Hash<String,String>)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

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

Returns:

• (String)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ Array<String>

Returns:

• (Array<String>)

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

class GetApiResponse < Struct.new(
  :api_endpoint,
  :api_gateway_managed,
  :api_id,
  :api_key_selection_expression,
  :cors_configuration,
  :created_date,
  :description,
  :disable_schema_validation,
  :disable_execute_api_endpoint,
  :import_info,
  :name,
  :protocol_type,
  :route_selection_expression,
  :tags,
  :version,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end