Skip to content

UsagePlan

Structure Class

UsagePlan dataclass

Bases: _SerdeShape

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.

Attributes

api_stages class-attribute instance-attribute
api_stages: list[ApiStage] | None = ...

The associated API stages of a usage plan.

description class-attribute instance-attribute
description: str | None = ...

The description of a usage plan.

id class-attribute instance-attribute
id: str | None = ...

The identifier of a UsagePlan resource.

name class-attribute instance-attribute
name: str | None = ...

The name of a usage plan.

product_code class-attribute instance-attribute
product_code: str | None = ...

The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

quota class-attribute instance-attribute
quota: QuotaSettings | None = ...

The target maximum number of permitted requests per a given unit time interval.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The collection of tags. Each tag element is associated with a given resource.

throttle class-attribute instance-attribute
throttle: ThrottleSettings | None = ...

A map containing method level throttling information for API stage in a usage plan.