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.
Provides detailed information about the specified customer master key (CMK).
You can use
DescribeKey on a predefined AWS alias, that is, an AWS alias
with no key ID. When you do, AWS KMS associates the alias with an AWS
managed CMK and returns its
Arn in the response.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeKey and EndDescribeKey.
public virtual Task<DescribeKeyResponse> DescribeKeyAsync( String keyId, CancellationToken cancellationToken )
Describes the specified customer master key (CMK). If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|DependencyTimeoutException||The system timed out while trying to fulfill the request. The request can be retried.|
|InvalidArnException||The request was rejected because a specified ARN was not valid.|
|KMSInternalException||The request was rejected because an internal exception occurred. The request can be retried.|
|NotFoundException||The request was rejected because the specified entity or resource could not be found.|
Supported in: 1.3
Supported in: 4.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms