GetKeyRotationStatus Method

Retrieves the key rotation status for a CMK.

Syntax

• C++
• Objective-C
• C

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

Unicode (Windows)
INT GetKeyRotationStatus(LPCWSTR lpszKeyId);

- (BOOL)getKeyRotationStatus:(NSString*)keyId;

#define MID_AMAZONKMS_GETKEYROTATIONSTATUS 17

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

Remarks

This method retrieves the key rotation status for the CMK specified by KeyId; it will return true if the CMK's key material is set to be automatically rotated, or false if not.

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

This method will always return false for asymmetric CMKs, CMKs with imported key material, and CMKs that reside in a custom key store, as such CMKs do not support automatic key rotation. This method will also return false if the server returns an error for any other reason.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its 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.