get_api_keys¶
Operation¶
async
¶
get_api_keys(input: GetApiKeysInput, plugins: list[Plugin] | None = None) -> GetApiKeysOutput
Gets information about the current ApiKeys resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetApiKeysInput
|
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 |
|---|---|
GetApiKeysOutput
|
An instance of |
Input¶
dataclass
¶
A request to get information about the current ApiKeys resource.
Attributes¶
class-attribute
instance-attribute
¶
customer_id: str | None = None
The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
class-attribute
instance-attribute
¶
include_values: bool | None = None
A boolean flag to specify whether (true) or not (false) the result
contains key values.
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
The name of queried API keys.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set.
Output¶
dataclass
¶
Represents a collection of API keys as represented by an ApiKeys resource.
Attributes¶
class-attribute
instance-attribute
¶
items: list[ApiKey] | 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.
class-attribute
instance-attribute
¶
warnings: list[str] | None = None
A list of warning messages logged during the import of API keys when the
failOnWarnings option is set to true.