AwsApiGatewayRestApiDetails
Contains information about a REST API in version 1 of Amazon API Gateway.
Contents
- 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 theUsageIdentifierKey
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.
For more information about the validation and formatting of timestamp fields in AWS Security Hub, see Timestamps.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: