ListKeys Method

Lists CMKs in the current account and region.

Syntax

amazonkms.listKeys([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method lists the CMKs in the current account and Region.

Calling this method will fire the KeyList event once for each CMK, and will also populate the Key* properties. However, note that by default only the KeyARN and KeyId properties will be populated, since the server does not return full information for CMKs when listing them. The IncludeKeyDetails property can be enabled to have the class attempt to retrieve full information for each CMK; refer to its documentation for more information.

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

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