Cloud Keys 2020 Node.js Edition

Questions / Feedback?

KeyDataForSigning Property

Whether the public key is for signing or encryption.

Syntax

 amazonkms.getKeyDataForSigning([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 getKeyDataForSigning([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 setKeyDataForSigning([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

Whether the public key is for signing or encryption.

When GetPublicKey is called, this property reflects whether the downloaded KeyPublicKey is to be used for verification (true) or encryption (false).

Always false when GenerateDataKey or GenerateDataKeyPair is called.

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

Data Type

Boolean

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