ListAliases Method

Lists aliases in the current account and region.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int ListAliases(const char* lpszForKeyId);

Unicode (Windows)
INT ListAliases(LPCWSTR lpszForKeyId);

- (void)listAliases:(NSString*)forKeyId;

#define MID_AMAZONKMS_LISTALIASES 19

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

Remarks

This method lists the aliases in the current account and Region. Optionally, aliases for a specific CMK (in the current account and Region) can be listed by passing its Id or ARN for the ForKeyId parameter.

Calling this method will fire the AliasList event once for each alias, and will also populate the Alias* properties.

If there are still more aliases available to list when this method returns, the AliasMarker property will be populated. Continue to call this method until AliasMarker is empty to accumulate all pages of results in the Alias* properties.

The MaxAliases configuration setting can be used to control the maximum number of results to return at once.

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.)