| Server IP : 52.25.153.185 / Your IP : 216.73.216.194 Web Server : Apache System : Linux ip-172-26-6-158 5.10.0-45-cloud-amd64 #1 SMP Debian 5.10.259-1 (2026-07-02) x86_64 User : daemon ( 1) PHP Version : 8.1.10 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /lib/python3/dist-packages/awscli/examples/kms/ |
Upload File : |
**Example 1: To delete the description of a customer managed CMK**
The following ``update-key-description`` example deletes the description to a customer managed CMK.
* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK.
* The ``--description`` parameter with an empty string value ('') deletes the existing description. ::
aws kms update-key-description \
--key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \
--description ''
This command produces no output. To view the description of a CMK, use the the describe-key command.
For more information, see `UpdateKeyDescription <https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.
**Example 2: To add or change a description to a customer managed CMK**
The following ``update-key-description`` example adds a description to a customer managed CMK. You can use the same command to change an existing description.
* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ARN value, but you can use either the key ID or the key ARN of the CMK.
* The ``--description`` parameter specifies the new description. The value of this parameter replaces the current description of the CMK, if any. ::
aws kms update-key-description \
--key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \
--description "IT Department test key"
This command produces no output. To view the description of a CMK, use the ``describe-key`` command.
For more information, see `UpdateKeyDescription <https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html>`__ in the *AWS Key Management Service API Reference*.