KeyDataAlgorithms Property

The algorithms supported by the public key.

Syntax

 amazonkms.getKeyDataAlgorithms([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 getKeyDataAlgorithms([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 setKeyDataAlgorithms([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 algorithms supported by the public key.

When GetPublicKey is called, this property will contain a comma-separated list of algorithms that the KeyPublicKey can be used with. Always empty when GenerateDataKey or GenerateDataKeyPair is called.

If KeyForSigning is false, possible values are:

SYMMETRIC_DEFAULT
RSAES_OAEP_SHA_1
RSAES_OAEP_SHA_256

If KeyForSigning is true, possible values are:

RSASSA_PSS_SHA_256
RSASSA_PSS_SHA_384
RSASSA_PSS_SHA_512
RSASSA_PKCS1_V1_5_SHA_256
RSASSA_PKCS1_V1_5_SHA_384
RSASSA_PKCS1_V1_5_SHA_512
ECDSA_SHA_256
ECDSA_SHA_384
ECDSA_SHA_512

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

Data Type

String