Amazon API Gateway · Example Payload

Amazon Api Gateway Stage Example

example-description

GatewayHTTP APIREST APIServerlessWebSocket

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

Top-level fields

deploymentIdclientCertificateIdstageNamedescriptioncacheClusterEnabledcacheClusterSizecacheClusterStatusmethodSettingsvariablesdocumentationVersionaccessLogSettingscanarySettingstracingEnabledwebAclArntagscreatedDatelastUpdatedDate

Example Payload

Raw ↑ 
{
  "deploymentId": "example-deploymentId",
  "clientCertificateId": "example-clientCertificateId",
  "stageName": "example-stageName",
  "description": "example-description",
  "cacheClusterEnabled": true,
  "cacheClusterSize": "0.5",
  "cacheClusterStatus": "CREATE_IN_PROGRESS",
  "methodSettings": {},
  "variables": {},
  "documentationVersion": "example-documentationVersion",
  "accessLogSettings": "example-accessLogSettings",
  "canarySettings": "example-canarySettings",
  "tracingEnabled": true,
  "webAclArn": "example-webAclArn",
  "tags": {},
  "createdDate": "2024-01-15T10:30:00Z",
  "lastUpdatedDate": "2024-01-15T10:30:00Z"
}