Class UpdateKeyDescriptionCommandProtected

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

• CreateKey

• DescribeKey

Example

Use a bare-bones client and the command you need to make an API call.

import { KMSClient, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, UpdateKeyDescriptionCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // UpdateKeyDescriptionRequest
  KeyId: "STRING_VALUE", // required
  Description: "STRING_VALUE", // required
};
const command = new UpdateKeyDescriptionCommand(input);
const response = await client.send(command);
// {};

Param

UpdateKeyDescriptionCommandInput

Returns

UpdateKeyDescriptionCommandOutput

See

• UpdateKeyDescriptionCommandInput for command's input shape.
• UpdateKeyDescriptionCommandOutput for command's response shape.
• config for KMSClient's config shape.

Throws

DependencyTimeoutException (server fault)

The system timed out while trying to fulfill the request. You can retry the request.

Throws

InvalidArnException (client fault)

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

Throws

KMSInternalException (server fault)

The request was rejected because an internal exception occurred. The request can be retried.

Throws

KMSInvalidStateException (client fault)

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

Throws

NotFoundException (client fault)

The request was rejected because the specified entity or resource could not be found.

Throws

KMSServiceException

Base exception class for all service exceptions from KMS service.

Example

To update the description of a KMS key

// The following example updates the description of the specified KMS key.
const input = {
  "Description": "Example description that indicates the intended use of this KMS key.",
  "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
};
const command = new UpdateKeyDescriptionCommand(input);
await client.send(command);
// example id: to-update-the-description-of-a-cmk-1481574808619