Amazon API Gateway · Example Payload

Amazon Api Gateway Restapi Example

example-description

GatewayHTTP APIREST APIServerlessWebSocket

Amazon Api Gateway Restapi Example is an example object payload from Amazon API Gateway, with 13 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idnamedescriptioncreatedDateversionwarningsbinaryMediaTypesminimumCompressionSizeapiKeySourceendpointConfigurationpolicytagsdisableExecuteApiEndpoint

Example Payload

Raw ↑ 
{
  "id": "example-id",
  "name": "example-name",
  "description": "example-description",
  "createdDate": "2024-01-15T10:30:00Z",
  "version": "example-version",
  "warnings": [],
  "binaryMediaTypes": [],
  "minimumCompressionSize": 1,
  "apiKeySource": "HEADER",
  "endpointConfiguration": "example-endpointConfiguration",
  "policy": "example-policy",
  "tags": {},
  "disableExecuteApiEndpoint": true
}