Skip to content

QuotaSettings

Source code in docs_src/capo_api_gateway/types/quota_settings.py
class QuotaSettings(TypedDict, closed=True):
    limit: "capo_api_gateway.types.integer.Integer"
    """<p>The target maximum number of requests that can be made in a given time period.</p>"""
    offset: "capo_api_gateway.types.integer.Integer"
    """<p>The number of requests subtracted from the given limit in the initial time period.</p>"""
    period: NotRequired["capo_api_gateway.types.quota_period_type.QuotaPeriodType"]
    """<p>The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".</p>"""

limit instance-attribute

limit: Integer

The target maximum number of requests that can be made in a given time period.

offset instance-attribute

offset: Integer

The number of requests subtracted from the given limit in the initial time period.

period instance-attribute

period: NotRequired[QuotaPeriodType]

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".