Skip to content

CreateUsagePlanRequest

Source code in docs_src/capo_api_gateway/types/create_usage_plan_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateUsagePlanRequest(TypedDict, closed=True):
    name: "capo_api_gateway.types.string.String"
    """<p>The name of the usage plan.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the usage plan.</p>"""
    api_stages: NotRequired["capo_api_gateway.types.list_of_api_stage.ListOfApiStage"]
    """<p>The associated API stages of the usage plan.</p>"""
    throttle: NotRequired["capo_api_gateway.types.throttle_settings.ThrottleSettings"]
    """<p>The throttling limits of the usage plan.</p>"""
    quota: NotRequired["capo_api_gateway.types.quota_settings.QuotaSettings"]
    """<p>The quota of the usage plan.</p>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>"""

api_stages instance-attribute 

api_stages: NotRequired[ListOfApiStage]

The associated API stages of the usage plan.

description instance-attribute 

description: NotRequired[String]

The description of the usage plan.

name instance-attribute 

name: String

The name of the usage plan.

quota instance-attribute 

quota: NotRequired[QuotaSettings]

The quota of the usage plan.

tags instance-attribute 

tags: NotRequired[MapOfStringToString]

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

throttle instance-attribute 

throttle: NotRequired[ThrottleSettings]

The throttling limits of the usage plan.