Api Gateway  >  Operations  >  get_usage_plan

get_usage_plan

Operation

get_usage_plan async

get_usage_plan(input: GetUsagePlanInput, plugins: list[Plugin] | None = None) -> GetUsagePlanOutput

Gets a usage plan of a given plan identifier.

Parameters:

Name	Type	Description	Default
input	GetUsagePlanInput	An instance of GetUsagePlanInput.	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
GetUsagePlanOutput	An instance of GetUsagePlanOutput.

Input

GetUsagePlanInput dataclass

The GET request to get a usage plan of a given plan identifier.

Attributes

usage_plan_id class-attribute instance-attribute

usage_plan_id: str | None = None

The identifier of the UsagePlan resource to be retrieved.

Output

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