PutRestApiResponse

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.

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

The timestamp when the API was created.

The API's description.

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.

The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

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

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.

The API's name.

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

The API's root resource ID.

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

A version identifier for the API.

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