Skip to content

UsagePlan

Source code in docs_src/capo_api_gateway/types/usage_plan.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class UsagePlan(TypedDict, closed=True):
    id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of a UsagePlan resource.</p>"""
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of a usage plan.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of a usage plan.</p>"""
    api_stages: NotRequired["capo_api_gateway.types.list_of_api_stage.ListOfApiStage"]
    """<p>The associated API stages of a usage plan.</p>"""
    throttle: NotRequired["capo_api_gateway.types.throttle_settings.ThrottleSettings"]
    """<p>A map containing method level throttling information for API stage in a usage plan.</p>"""
    quota: NotRequired["capo_api_gateway.types.quota_settings.QuotaSettings"]
    """<p>The target maximum number of permitted requests per a given unit time interval.</p>"""
    product_code: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.</p>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The collection of tags. Each tag element is associated with a given resource.</p>"""

api_stages instance-attribute 

api_stages: NotRequired[ListOfApiStage]

The associated API stages of a usage plan.

description instance-attribute 

description: NotRequired[String]

The description of a usage plan.

id instance-attribute 

id: NotRequired[String]

The identifier of a UsagePlan resource.

name instance-attribute 

name: NotRequired[String]

The name of a usage plan.

product_code instance-attribute 

product_code: NotRequired[String]

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

quota instance-attribute 

quota: NotRequired[QuotaSettings]

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

tags instance-attribute 

tags: NotRequired[MapOfStringToString]

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

throttle instance-attribute 

throttle: NotRequired[ThrottleSettings]

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