Container for the parameters to the ListAliases operation. 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/,
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:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.ListAliasesRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ListAliasesRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ListAliasesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListAliasesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. 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, Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
Limit | System.Int32 |
Gets and sets the property Limit. 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. |
|
|
Marker | System.String |
Gets and sets the property Marker.
Use this parameter in a subsequent request after you receive a response with truncated
results. Set it to the value of |
Examples
The following example lists aliases.
To list aliases
var client = new AmazonKeyManagementServiceClient();
var response = client.ListAliases(new ListAliasesRequest
{
});
List<AliasListEntry> aliases = response.Aliases; // A list of aliases, including the key ID of the KMS key that each alias refers to.
bool truncated = response.Truncated; // A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5