V1 Usage Plans Structure

UsagePlans schema from Amazon API Gateway v1 API

Type: object Properties: 1

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

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

Properties

items

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

JSON Structure

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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",
                "description": "Time period (DAY, WEEK, MONTH).",
                "enum": [
                  "DAY",
                  "WEEK",
                  "MONTH"
                ],
                "example": "DAY"
              }
            }
          }
        }
      },
      "example": [
        "example-value"
      ]
    }
  },
  "$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-plans-structure.json",
  "name": "UsagePlans",
  "description": "UsagePlans schema from Amazon API Gateway v1 API"
}