Skip to content

create_usage_plan

Operation

create_usage_plan

create_usage_plan(request: CreateUsagePlanInput | CreateUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateUsagePlanInputDict]) -> CreateUsagePlanOutput

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Parameters:

Name Type Description Default
request CreateUsagePlanInput | CreateUsagePlanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateUsagePlanOutput

An instance of CreateUsagePlanOutput.

create_usage_plan async

create_usage_plan(request: CreateUsagePlanInput | CreateUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateUsagePlanInputDict]) -> CreateUsagePlanOutput

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Parameters:

Name Type Description Default
request CreateUsagePlanInput | CreateUsagePlanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateUsagePlanOutput

An instance of CreateUsagePlanOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateUsagePlanInputDict

Bases: TypedDict

Dictionary form of CreateUsagePlanInput.

Attributes

api_stages instance-attribute
api_stages: Sequence[ApiStage | ApiStageDict] | None

The associated API stages of the usage plan.

description instance-attribute
description: str | None

The description of the usage plan.

name instance-attribute
name: Required[str]

The name of the usage plan.

quota instance-attribute

The quota of the usage plan.

tags instance-attribute
tags: Mapping[str, str] | None

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

The throttling limits of the usage plan.

CreateUsagePlanInput dataclass

Bases: _SerdeShape

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

Attributes

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

The associated API stages of the usage plan.

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

The description of the usage plan.

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

The name of the usage plan.

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

The quota of the usage plan.

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

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 class-attribute instance-attribute
throttle: ThrottleSettings | None = ...

The throttling limits of the usage plan.

Output

CreateUsagePlanOutput 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

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.