Cloud Keys 2020 Node.js Edition

Questions / Feedback?

KeyDataEncryptedKey Property

The encrypted key or private key data.

Syntax

 amazonkms.getKeyDataEncryptedKey([callback])

Default Value

""

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 getKeyDataEncryptedKey([callback]) method is defined as:

function(err, buffer){ }

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

'buffer' is the value returned by the method.

The callback for the setKeyDataEncryptedKey([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

The encrypted key or private key data.

When GenerateDataKey is called, this property reflects the encrypted data key that was downloaded. When GenerateDataKeyPair is called, this property reflects the encrypted private key of the data key pair that was downloaded.

In the case of GenerateDataKeyPair, note that the actual private key data will be in DER format upon decryption. It is up to the application to convert it to another format after decryption if necessary.

Always empty when GetPublicKey is called.

This property is read-only and not available at design time.

Data Type

Buffer

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]