Skip to content

Api Gateway  >  Operations  >  update_usage_plan

update_usage_plan

Operation

update_usage_plan async 

update_usage_plan(input: UpdateUsagePlanInput, plugins: list[Plugin] | None = None) -> UpdateUsagePlanOutput

Updates a usage plan of a given plan Id.

Parameters:

Name Type Description Default
input UpdateUsagePlanInput

An instance of UpdateUsagePlanInput.

 required
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

Returns:

Type Description
UpdateUsagePlanOutput

An instance of UpdateUsagePlanOutput.

Input

UpdateUsagePlanInput dataclass

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 = None

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

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

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

Output

UpdateUsagePlanOutput dataclass

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 = None

The associated API stages of a usage plan.

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

The description of a usage plan.

id class-attribute instance-attribute 
id: str | None = None

The identifier of a UsagePlan resource.

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

The name of a usage plan.

product_code class-attribute instance-attribute 
product_code: str | None = 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 = None

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

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

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

throttle class-attribute instance-attribute 
throttle: ThrottleSettings | None = None

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