AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeys (IAM policy)

Related operations:

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListKeysAsync.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z

Syntax

C#
public virtual ListKeysResponse ListKeys(
         ListKeysRequest request
)
Parameters
request
Type: Amazon.KeyManagementService.Model.ListKeysRequest

Container for the necessary parameters to execute the ListKeys service method.

Return Value
The response from the ListKeys service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
DependencyTimeoutException The system timed out while trying to fulfill the request. The request can be retried.
InvalidMarkerException The request was rejected because the marker that specifies where pagination should next begin is not valid.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.

Examples

The following example lists KMS keys.

To list KMS keys


var client = new AmazonKeyManagementServiceClient();
var response = client.ListKeys(new ListKeysRequest 
{
});

List<KeyListEntry> keys = response.Keys; // A list of KMS keys, including the key ID and Amazon Resource Name (ARN) of each one.
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 Framework:
Supported in: 4.5, 4.0, 3.5

See Also