Amazon API Gateway · Schema

CreateUsagePlanRequest

CreateUsagePlanRequest schema from Amazon API Gateway v1 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name Type Description
name string Name of the usage plan.
description string Description of the usage plan.
throttle object
quota object
View JSON Schema on GitHub

JSON Schema

v1-create-usage-plan-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the usage plan.",
      "example": "my-resource"
    },
    "description": {
      "type": "string",
      "description": "Description of the usage plan.",
      "example": "A description of this resource."
    },
    "throttle": {
      "type": "object",
      "properties": {
        "burstLimit": {
          "type": "integer",
          "description": "Burst limit for requests.",
          "example": 49
        },
        "rateLimit": {
          "type": "number",
          "description": "Steady-state rate limit (requests per second).",
          "example": 69.99
        }
      }
    },
    "quota": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "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"
        }
      }
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-schema/v1-create-usage-plan-request-schema.json",
  "title": "CreateUsagePlanRequest",
  "description": "CreateUsagePlanRequest schema from Amazon API Gateway v1 API"
}