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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#api_endpointString

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#api_idString

The identifier.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#api_key_selection_expressionString

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

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#cors_configurationTypes::Cors

Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Returns:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#created_dateTime

Returns:

  • (Time)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#descriptionString

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

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#disable_schema_validationBoolean

Returns:

  • (Boolean)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#import_infoArray<String>

Returns:

  • (Array<String>)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#nameString

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

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#protocol_typeString

Represents a protocol type.

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#route_selection_expressionString

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

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#tagsHash<String,String>

Represents a collection of tags associated with the resource.

Returns:

  • (Hash<String,String>)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#versionString

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

Returns:

  • (String)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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

#warningsArray<String>

Returns:

  • (Array<String>)


3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 3132

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