AwsApiGatewayRestApiDetails

Contains information about a REST API in version 1 of Amazon API Gateway.

ApiKeySource

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

Type: String

Pattern: .*\S.*

Required: No

BinaryMediaTypes

The list of binary media types supported by the REST API.

Type: Array of strings

Pattern: .*\S.*

Required: No

CreatedDate

Indicates when the API was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Type: String

Pattern: .*\S.*

Required: No

Description

A description of the REST API.

Type: String

Pattern: .*\S.*

Required: No

EndpointConfiguration

The endpoint configuration of the REST API.

Type: AwsApiGatewayEndpointConfiguration object

Required: No

Id

The identifier of the REST API.

Type: String

Pattern: .*\S.*

Required: No

MinimumCompressionSize

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Type: Integer

Required: No

Name

The name of the REST API.

Type: String

Pattern: .*\S.*

Required: No

Version

The version identifier for the REST API.

Type: String

Pattern: .*\S.*

Required: No

AwsApiGatewayRestApiDetails

Contents

See Also