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 KeyId and 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.
For .NET Core and PCL this operation is only available in asynchronous form. Please refer to DescribeKeyAsync.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual DescribeKeyResponse DescribeKey( DescribeKeyRequest request )
Container for the necessary parameters to execute the DescribeKey service method.
| Exception | Condition |
|---|---|
| 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, or an ARN in a key policy, is 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. |
The following example returns information (metadata) about the specified CMK.
var response = client.DescribeKey(new DescribeKeyRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
});
KeyMetadata keyMetadata = response.KeyMetadata; // An object that contains information about the specified CMK.
.NET Framework:
Supported in: 4.5, 4.0, 3.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
