get_usage_plans¶
Operation¶
get_usage_plans
¶
get_usage_plans(request: GetUsagePlansInput | GetUsagePlansInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlansInputDict]) -> GetUsagePlansOutput
Gets all the usage plans of the caller's account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetUsagePlansInput | GetUsagePlansInputDict | 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[GetUsagePlansInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetUsagePlansOutput
|
An instance of |
get_usage_plans
async
¶
get_usage_plans(request: GetUsagePlansInput | GetUsagePlansInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlansInputDict]) -> GetUsagePlansOutput
Gets all the usage plans of the caller's account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetUsagePlansInput | GetUsagePlansInputDict | 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[GetUsagePlansInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetUsagePlansOutput
|
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.
GetUsagePlansInputDict
¶
Bases: TypedDict
Dictionary form of GetUsagePlansInput.
GetUsagePlansInput
dataclass
¶
Bases: _SerdeShape
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 = ...
The identifier of the API key associated with the usage plans.
Output¶
GetUsagePlansOutput
dataclass
¶
Bases: _SerdeShape
Represents a collection of usage plans for an AWS account.
Attributes¶
items
class-attribute
instance-attribute
¶
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.