RestApi - Amazon API Gateway

RestApi

Represents a REST API.

Contents

apiKeySource

The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Type: String

Valid Values: HEADER | AUTHORIZER

Required: No

binaryMediaTypes

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

Type: Array of strings

Required: No

createdDate

The timestamp when the API was created.

Type: Timestamp

Required: No

description

The API's description.

Type: String

Required: No

disableExecuteApiEndpoint

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Type: Boolean

Required: No

endpointConfiguration

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

Type: EndpointConfiguration object

Required: No

id

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

Type: String

Required: No

minimumCompressionSize

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Type: Integer

Required: No

name

The API's name.

Type: String

Required: No

policy

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Type: String

Required: No

tags

The collection of tags. Each tag element is associated with a given resource.

Type: String to string map

Required: No

version

A version identifier for the API.

Type: String

Required: No

warnings

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

Type: Array of strings

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: