UpdateKeyDescription - Key Management Service

This operation replaces the description of a customer master key (CMK) with the description that you specify. The original description of the CMK is specified by the Description parameter when you call the DescribeKey operation. You can call this operation to create, modify, or delete the description of a CMK.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateKeyDescription	The operation that you want to perform. Set the value to UpdateKeyDescription.
KeyId	String	Yes	1234abcd-12ab-34cd-56ef-12345678****	The ID of the CMK. The ID must be globally unique.
Description	String	Yes	key description example	The description of the CMK. This description includes the purpose of the CMK, such as the types of data that you want to protect and applications that can use the CMK.

Response parameters

Parameter	Type	Example	Description
RequestId	String	3455b9b4-95c1-419d-b310-db6a53b09a39	The ID of the request, which is used to locate and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateKeyDescription
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&Description=key description example
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateKeyDescriptionResponse>
    <RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId>
</UpdateKeyDescriptionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

Error codes

For a list of error codes, see Service error codes.