GetKeyInfo Method

Gets information about a CMK.

Syntax

ANSI (Cross Platform)
int GetKeyInfo(const char* lpszKeyId);

Unicode (Windows)
INT GetKeyInfo(LPCWSTR lpszKeyId);
- (void)getKeyInfo:(NSString*)keyId;
#define MID_AMAZONKMS_GETKEYINFO 16

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

Remarks

This method gets information about the CMK specified by KeyId. When the information is returned, the class clears the Key* properties and repopulates them with a single item that contains the CMK's information. The KeyList event is also fired.

The value passed for the KeyId parameter must be the Id or ARN of a CMK, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a CMK or alias in another account so long as the appropriate permissions are in place.

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]