get_usage_plan_keys¶
Operation¶
async
¶
get_usage_plan_keys(input: GetUsagePlanKeysInput, plugins: list[Plugin] | None = None) -> GetUsagePlanKeysOutput
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetUsagePlanKeysInput
|
An instance of |
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 |
|---|---|
GetUsagePlanKeysOutput
|
An instance of |
Input¶
dataclass
¶
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
Attributes¶
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.
class-attribute
instance-attribute
¶
name_query: str | None = None
A query parameter specifying the name of the to-be-returned usage plan keys.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.
class-attribute
instance-attribute
¶
usage_plan_id: str | None = None
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
Output¶
dataclass
¶
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
Attributes¶
class-attribute
instance-attribute
¶
items: list[UsagePlanKey] | None = None
The current page of elements from this collection.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.