get_api_keys¶
Operation¶
get_api_keys
¶
get_api_keys(request: GetApiKeysInput | GetApiKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApiKeysInputDict]) -> GetApiKeysOutput
Gets information about the current ApiKeys resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetApiKeysInput | GetApiKeysInputDict | 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[GetApiKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetApiKeysOutput
|
An instance of |
get_api_keys
async
¶
get_api_keys(request: GetApiKeysInput | GetApiKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApiKeysInputDict]) -> GetApiKeysOutput
Gets information about the current ApiKeys resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetApiKeysInput | GetApiKeysInputDict | 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[GetApiKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetApiKeysOutput
|
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.
GetApiKeysInputDict
¶
Bases: TypedDict
Dictionary form of GetApiKeysInput.
Attributes¶
customer_id
instance-attribute
¶
customer_id: str | None
The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
include_values
instance-attribute
¶
include_values: bool | None
A boolean flag to specify whether (true) or not (false) the result
contains key values.
GetApiKeysInput
dataclass
¶
Bases: _SerdeShape
A request to get information about the current ApiKeys resource.
Attributes¶
customer_id
class-attribute
instance-attribute
¶
customer_id: str | None = ...
The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
include_values
class-attribute
instance-attribute
¶
include_values: bool | None = ...
A boolean flag to specify whether (true) or not (false) the result
contains key values.
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.
Output¶
GetApiKeysOutput
dataclass
¶
Bases: _SerdeShape
Represents a collection of API keys as represented by an ApiKeys resource.
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.