Amazon API Gateway · Schema

Deployment

Deployment schema from Amazon API Gateway v2 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name Type Description
DeploymentId string Deployment identifier.
Description string Description of the deployment.
DeploymentStatus string Status of the deployment (PENDING, FAILED, DEPLOYED).
CreatedDate string Timestamp when the deployment was created.
View JSON Schema on GitHub

JSON Schema

v2-deployment-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "DeploymentId": {
      "type": "string",
      "description": "Deployment identifier.",
      "example": "abc123"
    },
    "Description": {
      "type": "string",
      "description": "Description of the deployment.",
      "example": "A description of this resource."
    },
    "DeploymentStatus": {
      "type": "string",
      "description": "Status of the deployment (PENDING, FAILED, DEPLOYED).",
      "example": "ACTIVE"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the deployment was created.",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-schema/v2-deployment-schema.json",
  "title": "Deployment",
  "description": "Deployment schema from Amazon API Gateway v2 API"
}