V1 Usage Plan Structure

UsagePlan schema from Amazon API Gateway v1 API

Type: object Properties: 4

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

UsagePlan is a JSON Structure definition published by Amazon API Gateway, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name throttle quota

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Usage plan identifier.",
      "example": "abc123"
    },
    "name": {
      "type": "string",
      "description": "Usage plan name.",
      "example": "my-resource"
    },
    "throttle": {
      "type": "object",
      "properties": {
        "burstLimit": {
          "type": "int32",
          "description": "Burst limit for requests.",
          "example": 49
        },
        "rateLimit": {
          "type": "double",
          "description": "Steady-state rate limit (requests per second).",
          "example": 69.99
        }
      }
    },
    "quota": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "int32",
          "description": "Maximum number of requests in the period.",
          "example": 24
        },
        "period": {
          "type": "string",
          "enum": [
            "DAY",
            "WEEK",
            "MONTH"
          ],
          "description": "Time period (DAY, WEEK, MONTH).",
          "example": "DAY"
        }
      }
    }
  },
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v1-usage-plan-structure.json",
  "name": "UsagePlan",
  "description": "UsagePlan schema from Amazon API Gateway v1 API"
}