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.
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
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 command = new UpdateKeyDescriptionCommand(input); const response = await client.send(command);UpdateKeyDescriptionCommandInput for command's
inputshape.UpdateKeyDescriptionCommandOutput for command's
responseshape.config for KMSClient's
configshape.