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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

    The list of binary media types supported by the RestApi.

#created_dateTime

The timestamp when the API was created.

Returns:

  • (Time)

    The timestamp when the API was created.

#descriptionString

The API\'s description.

Returns:

  • (String)

    The API\'s description.

#endpoint_configurationTypes::EndpointConfiguration

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

Returns:

#idString

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

Returns:

  • (String)

    The API\'s identifier.

#nameString

The API\'s name.

Returns:

  • (String)

    The API\'s name.

#versionString

A version identifier for the API.

Returns:

  • (String)

    A version identifier for the API.

#warningsArray<String>

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

Returns:

  • (Array<String>)

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