GetPublicKey Method

Retrieves the public key of an asymmetric CMK.

Syntax

amazonkms.getPublicKey(keyId, [callback])

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 this 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 method retrieves the public key of the asymmetric CMK specified by KeyId. The public key and its related information will be downloaded to the following KeyData* properties, refer to their documentation for more information:

• KeyDataAlgorithms
• KeyDataARN
• KeyDataForSigning
• KeyDataKeySpec
• KeyDataPublicKey

This method will fail if any of the following are true regarding the specified CMK:

• Its KeyState is anything other than aksEnabled (0).
• It is symmetric (see KeyKeySpec).
• It is an AWS-managed CMK (see KeyAWSManaged).