Skip to content

update_usage_plan

Operation

update_usage_plan

update_usage_plan(request: UpdateUsagePlanInput | UpdateUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateUsagePlanInputDict]) -> UpdateUsagePlanOutput

Updates a usage plan of a given plan Id.

Parameters:

Name Type Description Default
request UpdateUsagePlanInput | UpdateUsagePlanInputDict | 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[UpdateUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateUsagePlanOutput

An instance of UpdateUsagePlanOutput.

update_usage_plan async

update_usage_plan(request: UpdateUsagePlanInput | UpdateUsagePlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateUsagePlanInputDict]) -> UpdateUsagePlanOutput

Updates a usage plan of a given plan Id.

Parameters:

Name Type Description Default
request UpdateUsagePlanInput | UpdateUsagePlanInputDict | 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[UpdateUsagePlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateUsagePlanOutput

An instance of UpdateUsagePlanOutput.

Input

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

UpdateUsagePlanInputDict

Bases: TypedDict

Dictionary form of UpdateUsagePlanInput.

Attributes

patch_operations instance-attribute
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None

For more information about supported patch operations, see Patch Operations.

usage_plan_id instance-attribute
usage_plan_id: Required[str]

The Id of the to-be-updated usage plan.

UpdateUsagePlanInput dataclass

Bases: _SerdeShape

The PATCH request to update a usage plan of a given plan Id.

Attributes

patch_operations class-attribute instance-attribute
patch_operations: list[PatchOperation] | None = ...

For more information about supported patch operations, see Patch Operations.

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

The Id of the to-be-updated usage plan.

Output

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