list_aliases¶
Operation¶
list_aliases
async
¶
list_aliases(request: ListAliasesInput | ListAliasesInputDict, /, *, plugins: list[Plugin] | None = None) -> ListAliasesOutput
list_aliases(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAliasesInputDict]) -> ListAliasesOutput
Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias.
By default, the ListAliases operation returns all aliases in the
account and region. To get only the aliases associated with a particular
KMS key, use the KeyId parameter.
The ListAliases response can include aliases that you created and
associated with your customer managed keys, and aliases that Amazon Web
Services created and associated with Amazon Web Services managed keys in
your account. You can recognize Amazon Web Services aliases because
their names have the format aws/``<service-name>, such as
aws/dynamodb.
The response might also include aliases that have no TargetKeyId
field. These are predefined aliases that Amazon Web Services has created
but has not yet associated with a KMS key. Aliases that Amazon Web
Services creates in your account, including predefined aliases, do not
count against your KMS aliases
quota.
Cross-account use: No. ListAliases does not return aliases in
other Amazon Web Services accounts.
Required permissions: kms:ListAliases (IAM policy)
For details, see Controlling access to aliases in the Key Management Service Developer Guide.
Related operations:
-
CreateAlias
-
DeleteAlias
-
UpdateAlias
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
ListAliasesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
ListAliasesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAliasesInput structure.
Attributes¶
key_id
class-attribute
instance-attribute
¶
key_id: str | None = ...
Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases returns all
aliases in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab -
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Dictionaries¶
ListAliasesInputDict
¶
Bases: TypedDict
Dictionary form of ListAliasesInput.
Attributes¶
key_id
instance-attribute
¶
key_id: str | None
Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases returns all
aliases in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab -
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
limit
instance-attribute
¶
limit: int | None
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
Output¶
ListAliasesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAliasesOutput structure.
Attributes¶
aliases
class-attribute
instance-attribute
¶
aliases: list[AliasListEntry] | None = ...
A list of aliases.
next_marker
class-attribute
instance-attribute
¶
next_marker: str | None = ...
When Truncated is true, this element is present and contains the value
to use for the Marker parameter in a subsequent request.
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.
truncated
class-attribute
instance-attribute
¶
truncated: bool = ...
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker element in this response to
the Marker parameter in a subsequent request.