get_usage_plan_keys¶
Operation¶
get_usage_plan_keys
¶
get_usage_plan_keys(request: GetUsagePlanKeysInput | GetUsagePlanKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlanKeysInputDict]) -> GetUsagePlanKeysOutput
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetUsagePlanKeysInput | GetUsagePlanKeysInputDict | 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[GetUsagePlanKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetUsagePlanKeysOutput
|
An instance of |
get_usage_plan_keys
async
¶
get_usage_plan_keys(request: GetUsagePlanKeysInput | GetUsagePlanKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlanKeysInputDict]) -> GetUsagePlanKeysOutput
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetUsagePlanKeysInput | GetUsagePlanKeysInputDict | 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[GetUsagePlanKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetUsagePlanKeysOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetUsagePlanKeysInputDict
¶
Bases: TypedDict
Dictionary form of GetUsagePlanKeysInput.
Attributes¶
limit
instance-attribute
¶
limit: int | None
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
name_query
instance-attribute
¶
name_query: str | None
A query parameter specifying the name of the to-be-returned usage plan keys.
GetUsagePlanKeysInput
dataclass
¶
Bases: _SerdeShape
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
Attributes¶
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
name_query
class-attribute
instance-attribute
¶
name_query: str | None = ...
A query parameter specifying the name of the to-be-returned usage plan keys.
Output¶
GetUsagePlanKeysOutput
dataclass
¶
Bases: _SerdeShape
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
Attributes¶
items
class-attribute
instance-attribute
¶
items: list[UsagePlanKey] | None = ...
The current page of elements from this collection.
position
class-attribute
instance-attribute
¶
position: str | None = ...
The current pagination position in the paged result set.
response_metadata
class-attribute
instance-attribute
¶
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.