Amazon API Gateway · Schema
Amazon API Gateway REST API Definition
Schema defining the structure of an Amazon API Gateway REST API resource, including its configuration for resources, methods, integrations, stages, deployments, authorizers, models, and associated settings.
AWSGatewayHTTP APIREST APIServerlessWebSocket
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The unique identifier of the REST API assigned by API Gateway. |
| name | string | The name of the REST API. |
| description | string | A human-readable description of the REST API. |
| version | string | A version identifier for the API. |
| createdDate | string | The timestamp when the REST API was created. |
| apiKeySource | string | The source of the API key for metering requests according to a usage plan. HEADER reads the key from the X-API-Key header. AUTHORIZER reads it from the UsageIdentifierKey from a custom authorizer. |
| binaryMediaTypes | array | The list of binary media types supported by the REST API, such as image/png or application/octet-stream. |
| minimumCompressionSize | integer | A nullable integer that is used to enable or disable compression on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than |
| endpointConfiguration | object | |
| policy | string | A stringified JSON policy document that applies to this REST API regardless of the caller and method configuration. |
| tags | object | The collection of tags associated with the REST API. Each tag is a key-value pair. |
| disableExecuteApiEndpoint | boolean | Specifies whether clients can invoke your API by using the default execute-api endpoint. When true, clients must use a custom domain name to invoke the API. |
| resources | array | The collection of API resources defining the URL structure. |
| stages | array | The named stages of the API deployment lifecycle. |
| deployments | array | Snapshots of the API configuration that are deployed to stages. |
| authorizers | array | Authorization mechanisms configured for the API. |
| models | array | Data models that define the structure of request and response payloads. |
| requestValidators | array | Request validators that check incoming requests before passing them to integrations. |
| gatewayResponses | array | Customized gateway responses for various error types. |
| documentationParts | array | Documentation content associated with API entities. |