KeyDataPlaintextKey Property
The plaintext key or private key data.
Syntax
amazonkms.getKeyDataPlaintextKey([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 getKeyDataPlaintextKey([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 setKeyDataPlaintextKey([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 plaintext key or private key data.
If, when GenerateDataKey or GenerateDataKeyPair is called, the IncludePlaintext parameter was true, this property will reflect the plaintext data key or private key of the data key pair (respectively) that was downloaded. Otherwise, it will be empty.
In the case of GenerateDataKeyPair, this property exposes the private key in PEM format for convenience.
Always empty when GetPublicKey is called.
This property is read-only and not available at design time.
Data Type
Buffer