Skip to content

Api Gateway  >  Operations  >  get_usage_plans

get_usage_plans

Operation

get_usage_plans async

get_usage_plans(input: GetUsagePlansInput, plugins: list[Plugin] | None = None) -> GetUsagePlansOutput

Gets all the usage plans of the caller's account.

Parameters:

Name Type Description Default
input GetUsagePlansInput

An instance of GetUsagePlansInput.

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
GetUsagePlansOutput

An instance of GetUsagePlansOutput.

Input

GetUsagePlansInput dataclass

The GET request to get all the usage plans of the caller's account.

Attributes

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

The identifier of the API key associated with the usage plans.

limit class-attribute instance-attribute
limit: int | None = None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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

The current pagination position in the paged result set.

Output

GetUsagePlansOutput dataclass

Represents a collection of usage plans for an AWS account.

Attributes

items class-attribute instance-attribute
items: list[UsagePlan] | None = None

The current page of elements from this collection.

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

The current pagination position in the paged result set.