AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Updates the description of a customer master key (CMK).

Note:

For PCL this operation is only available in asynchronous form. Please refer to UpdateKeyDescriptionAsync.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z

Syntax

C#
public abstract UpdateKeyDescriptionResponse UpdateKeyDescription(
         UpdateKeyDescriptionRequest request
)
Parameters
request
Type: Amazon.KeyManagementService.Model.UpdateKeyDescriptionRequest

Container for the necessary parameters to execute the UpdateKeyDescription service method.

Return Value
The response from the UpdateKeyDescription service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
DependencyTimeoutException The system timed out while trying to fulfill the request. The request can be retried.
InvalidArnException The request was rejected because a specified ARN was not valid.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
NotFoundException The request was rejected because the specified entity or resource could not be found.

Examples

The following example updates the description of the specified CMK.

To update the description of a customer master key (CMK)


var response = client.UpdateKeyDescription(new UpdateKeyDescriptionRequest 
{
    Description = "Example description that indicates the intended use of this CMK.", // The updated description.
    KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also