Container for the parameters to the UpdateKeyDescription operation. Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:UpdateKeyDescription (key policy)
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.UpdateKeyDescriptionRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class UpdateKeyDescriptionRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The UpdateKeyDescriptionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateKeyDescriptionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Description | System.String |
Gets and sets the property Description. New description for the KMS key. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output. |
|
|
KeyId | System.String |
Gets and sets the property KeyId. Updates the description of the specified KMS key. 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. |
Examples
The following example updates the description of the specified KMS key.
To update the description of a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.UpdateKeyDescription(new UpdateKeyDescriptionRequest
{
Description = "Example description that indicates the intended use of this KMS key.", // The updated description.
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
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