UpdateKeyDescription Method

Updates a CMK's description.

Syntax

ANSI (Cross Platform)
int UpdateKeyDescription(const char* lpszKeyId, const char* lpszNewDescription);

Unicode (Windows)
INT UpdateKeyDescription(LPCWSTR lpszKeyId, LPCWSTR lpszNewDescription);
- (void)updateKeyDescription:(NSString*)keyId :(NSString*)newDescription;
#define MID_AMAZONKMS_UPDATEKEYDESCRIPTION 31

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonKMS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method updates the description of the CMK specified by KeyId.

The value passed for the KeyId parameter must be the Id or ARN of a CMK in the current account and Region.

This method will fail if the specified CMK's state is aksPendingDeletion (2), or if it is AWS-managed (see KeyAWSManaged).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]