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

Class: Aws::APIGateway::Types::RestApi

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

Overview

Represents a REST API.

[Create an API][1]

Instance Attribute Summary collapse

Instance Attribute Details

#binary_media_typesArray<String>

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

  • (Array<String>)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#descriptionString

The API's description.

Returns:

  • (String)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#endpoint_configurationTypes::EndpointConfiguration

The endpoint configuration of this RestApi showing the endpoint types of the API.



5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#idString

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Returns:

  • (String)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#nameString

The API's name.

Returns:

  • (String)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#versionString

A version identifier for the API.

Returns:

  • (String)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end

#warningsArray<String>

The warning messages reported when failonwarnings is turned on during API import.

Returns:

  • (Array<String>)


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5871

class RestApi < Struct.new(
  :id,
  :name,
  :description,
  :created_date,
  :version,
  :warnings,
  :binary_media_types,
  :endpoint_configuration)
  include Aws::Structure
end