IncludeKeyDetails Property
Whether to attempt to retrieve full details when listing CMKs.
Syntax
amazonkms.getIncludeKeyDetails([callback]) amazonkms.setIncludeKeyDetails( includeKeyDetails, [callback])
Default Value
FALSE
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 the getIncludeKeyDetails([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setIncludeKeyDetails([callback]) 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 property specifies whether the class should make additional requests when ListKeys is called in order to retrieve full information for each CMK. By default, Amazon will only return the KeyARN and KeyId of each CMK.
If this property is enabled, then after the initial listing is returned, the class will call GetKeyInfo internally for each CMK returned. For all CMKs for which this call is successful, the additional information will be used to populate the Key* properties. Any CMKs for which the GetKeyInfo call fails will only have their KeyARN and KeyId properties populated, as usual.
This property is not available at design time.
Data Type
Boolean