You can call this operation to update the description of a specified CMK.

This operation replaces the description of the CMK (the Description value in KeyMetadata parameters) with the value that you specify. You can add, modify, or delete the description of a CMK through this operation.

Request parameters

Parameter Type Required Description
KeyId String Yes The globally unique ID of the CMK.
Description String Yes The description of the CMK. It usually involves the purpose of the CMK, such as the data types to be protected by the CMK or the applications that can use the CMK.

Response parameters

Parameter Type Description
RequestId String The ID of the request.

Examples

Sample requests

https://kms.cn-hangzhou.aliyuncs.com/?Action=UpdateKeyDescription
&KeyId=<cmkid>
&Description=<your key description>
&<Common request parameters>

Sample responses

JSON format

//json response
{
    "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

XML format

//xml response
<KMS>
    <RequestId>475f1620-b9d3-4d35-b5c6-3fbdd941423d</RequestId>
</KMS>