UsagePlan

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don't rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id object
name object
description object
apiStages object
throttle object
quota object
productCode object
tags object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-usageplan-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsagePlan",
  "title": "UsagePlan",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The identifier of a UsagePlan resource."
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of a usage plan."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of a usage plan."
        }
      ]
    },
    "apiStages": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfApiStage"
        },
        {
          "description": "The associated API stages of a usage plan."
        }
      ]
    },
    "throttle": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThrottleSettings"
        },
        {
          "description": "A map containing method level throttling information for API stage in a usage plan."
        }
      ]
    },
    "quota": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QuotaSettings"
        },
        {
          "description": "The target maximum number of permitted requests per a given unit time interval."
        }
      ]
    },
    "productCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "The collection of tags. Each tag element is associated with a given resource."
        }
      ]
    }
  },
  "description": "Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don't rely on usage plans to control costs. Consider using <a href=\"https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html\">Amazon Web Services Budgets</a> to monitor costs and <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">WAF</a> to manage API requests."
}