Class: AWS.KMS

Inherits:
AWS.Service show all
Identifier:
kms
API Version:
2014-11-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using KMS

var kms = new AWS.KMS();
kms.cancelKeyDeletion(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the KMS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kms = new AWS.KMS({apiVersion: '2014-11-01'});

You can also set the API version globally in AWS.config.apiVersions using the kms service identifier:

AWS.config.apiVersions = {
  kms: '2014-11-01',
  // other service API versions
};

var kms = new AWS.KMS();

Version:

  • 2014-11-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.KMS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a KMS object

var kms = new AWS.KMS({apiVersion: '2014-11-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.KMS.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.KMS.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.KMS.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelKeyDeletion(params = {}, callback) ⇒ AWS.Request

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To cancel deletion of a customer master key (CMK)


/* The following example cancels deletion of the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.cancelKeyDeletion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the CMK whose deletion you canceled.
   }
   */
 });

Calling the cancelKeyDeletion operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.cancelKeyDeletion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The unique identifier for the customer master key (CMK) for which to cancel deletion.

      To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyId — (String)

        The unique identifier of the master key for which deletion is canceled.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAlias(params = {}, callback) ⇒ AWS.Request

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

Service Reference:

Examples:

To create an alias


/* The following example creates an alias for the specified customer master key (CMK). */

 var params = {
  AliasName: "alias/ExampleAlias", // The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.
  TargetKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.createAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the createAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  TargetKeyId: 'STRING_VALUE' /* required */
};
kms.createAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasName — (String)

      String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.

    • TargetKeyId — (String)

      An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGrant(params = {}, callback) ⇒ AWS.Request

Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To create a grant


/* The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer master key (CMK). */

 var params = {
  GranteePrincipal: "arn:aws:iam::111122223333:role/ExampleRole", // The identity that is given permission to perform the operations specified in the grant.
  KeyId: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  Operations: [
     "Encrypt", 
     "Decrypt"
  ]// A list of operations that the grant allows.
 };
 kms.createGrant(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    GrantId: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", // The unique identifier of the grant.
    GrantToken: "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA"// The grant token.
   }
   */
 });

Calling the createGrant operation

var params = {
  GranteePrincipal: 'STRING_VALUE', /* required */
  KeyId: 'STRING_VALUE', /* required */
  Constraints: {
    EncryptionContextEquals: {
      '<EncryptionContextKey>': 'STRING_VALUE',
      /* '<EncryptionContextKey>': ... */
    },
    EncryptionContextSubset: {
      '<EncryptionContextKey>': 'STRING_VALUE',
      /* '<EncryptionContextKey>': ... */
    }
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  Operations: [
    Decrypt | Encrypt | GenerateDataKey | GenerateDataKeyWithoutPlaintext | ReEncryptFrom | ReEncryptTo | CreateGrant | RetireGrant | DescribeKey,
    /* more items */
  ],
  RetiringPrincipal: 'STRING_VALUE'
};
kms.createGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The unique identifier for the customer master key (CMK) that the grant applies to.

      To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

      • Globally unique key ID: 12345678-1234-1234-1234-123456789012

      • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012

    • GranteePrincipal — (String)

      The principal that is given permission to perform the operations that the grant permits.

      To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

    • RetiringPrincipal — (String)

      The principal that is given permission to retire the grant by using RetireGrant operation.

      To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

    • Operations — (Array<String>)

      A list of operations that the grant permits.

    • Constraints — (map)

      A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.

      • EncryptionContextSubset — (map<String>)

        A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

      • EncryptionContextEquals — (map<String>)

        A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

    • Name — (String)

      A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

      When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

      When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantToken — (String)

        The grant token.

        For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

      • GrantId — (String)

        The unique identifier for the grant.

        You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createKey(params = {}, callback) ⇒ AWS.Request

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

Service Reference:

Examples:

To create a customer master key (CMK)


/* The following example creates a CMK. */

 var params = {
  Tags: [
     {
    TagKey: "CreatedBy", 
    TagValue: "ExampleUser"
   }
  ]// One or more tags. Each tag consists of a tag key and a tag value.
 };
 kms.createKey(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyMetadata: {
     AWSAccountId: "111122223333", 
     Arn: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CreationDate: <Date Representation>, 
     Description: "", 
     Enabled: true, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     Origin: "AWS_KMS"
    }// An object that contains information about the CMK created by this operation.
   }
   */
 });

Calling the createKey operation

var params = {
  BypassPolicyLockoutSafetyCheck: true || false,
  Description: 'STRING_VALUE',
  KeyUsage: ENCRYPT_DECRYPT,
  Origin: AWS_KMS | EXTERNAL,
  Policy: 'STRING_VALUE',
  Tags: [
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kms.createKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Policy — (String)

      The key policy to attach to the CMK.

      If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

      • It must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

      • The principals that are specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

      If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.

      The policy size limit is 32 KiB (32768 bytes).

    • Description — (String)

      A description of the CMK.

      Use a description that helps you decide whether the CMK is appropriate for a task.

    • KeyUsage — (String)

      The intended use of the CMK.

      You can use CMKs only for symmetric encryption and decryption.

      Possible values include:
      • "ENCRYPT_DECRYPT"
    • Origin — (String)

      The source of the CMK's key material.

      The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

      The CMK's Origin is immutable and is set when the CMK is created.

      Possible values include:
      • "AWS_KMS"
      • "EXTERNAL"
    • BypassPolicyLockoutSafetyCheck — (Boolean)

      A flag to indicate whether to bypass the key policy lockout safety check.

      Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

      For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

      Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

      The default value is false.

    • Tags — (Array<map>)

      One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

      Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.

      • TagKeyrequired — (String)

        The key of the tag.

      • TagValuerequired — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyMetadata — (map)

        Metadata associated with the CMK.

        • AWSAccountId — (String)

          The twelve-digit account ID of the AWS account that owns the CMK.

        • KeyIdrequired — (String)

          The globally unique identifier for the CMK.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

        • CreationDate — (Date)

          The date and time when the CMK was created.

        • Enabled — (Boolean)

          Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

        • Description — (String)

          The description of the CMK.

        • KeyUsage — (String)

          The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.

          Possible values include:
          • "ENCRYPT_DECRYPT"
        • KeyState — (String)

          The state of the CMK.

          For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

          Possible values include:
          • "Enabled"
          • "Disabled"
          • "PendingDeletion"
          • "PendingImport"
        • DeletionDate — (Date)

          The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.

        • ValidTo — (Date)

          The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

        • Origin — (String)

          The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

          Possible values include:
          • "AWS_KMS"
          • "EXTERNAL"
        • ExpirationModel — (String)

          Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

          Possible values include:
          • "KEY_MATERIAL_EXPIRES"
          • "KEY_MATERIAL_DOES_NOT_EXPIRE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

decrypt(params = {}, callback) ⇒ AWS.Request

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

Service Reference:

Examples:

To decrypt data


/* The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS. */

 var params = {
  CiphertextBlob: <Binary String>// The encrypted data (ciphertext).
 };
 kms.decrypt(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.
    Plaintext: <Binary String>// The decrypted (plaintext) data.
   }
   */
 });

Calling the decrypt operation

var params = {
  CiphertextBlob: new Buffer('...') || 'STRING_VALUE', /* required */
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ]
};
kms.decrypt(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CiphertextBlob — (Buffer, Typed Array, Blob, String)

      Ciphertext to be decrypted. The blob includes metadata.

    • EncryptionContext — (map<String>)

      The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyId — (String)

        ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.

      • Plaintext — (Buffer, Typed Array, Blob, String)

        Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAlias(params = {}, callback) ⇒ AWS.Request

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

Service Reference:

Examples:

To delete an alias


/* The following example deletes the specified alias. */

 var params = {
  AliasName: "alias/ExampleAlias"// The alias to delete.
 };
 kms.deleteAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteAlias operation

var params = {
  AliasName: 'STRING_VALUE' /* required */
};
kms.deleteAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasName — (String)

      The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteImportedKeyMaterial(params = {}, callback) ⇒ AWS.Request

Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

Service Reference:

Examples:

To delete imported key material


/* The following example deletes the imported key material from the specified customer master key (CMK). */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.deleteImportedKeyMaterial(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteImportedKeyMaterial operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.deleteImportedKeyMaterial(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The identifier of the CMK whose key material to delete. The CMK's Origin must be EXTERNAL.

      A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeKey(params = {}, callback) ⇒ AWS.Request

Provides detailed information about the specified customer master key.

Service Reference:

Examples:

To obtain information about a customer master key (CMK)


/* The following example returns information (metadata) about the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.describeKey(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyMetadata: {
     AWSAccountId: "111122223333", 
     Arn: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CreationDate: <Date Representation>, 
     Description: "", 
     Enabled: true, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     Origin: "AWS_KMS"
    }// An object that contains information about the specified CMK.
   }
   */
 });

Calling the describeKey operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ]
};
kms.describeKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyMetadata — (map)

        Metadata associated with the key.

        • AWSAccountId — (String)

          The twelve-digit account ID of the AWS account that owns the CMK.

        • KeyIdrequired — (String)

          The globally unique identifier for the CMK.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

        • CreationDate — (Date)

          The date and time when the CMK was created.

        • Enabled — (Boolean)

          Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

        • Description — (String)

          The description of the CMK.

        • KeyUsage — (String)

          The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.

          Possible values include:
          • "ENCRYPT_DECRYPT"
        • KeyState — (String)

          The state of the CMK.

          For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

          Possible values include:
          • "Enabled"
          • "Disabled"
          • "PendingDeletion"
          • "PendingImport"
        • DeletionDate — (Date)

          The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.

        • ValidTo — (Date)

          The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

        • Origin — (String)

          The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

          Possible values include:
          • "AWS_KMS"
          • "EXTERNAL"
        • ExpirationModel — (String)

          Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

          Possible values include:
          • "KEY_MATERIAL_EXPIRES"
          • "KEY_MATERIAL_DOES_NOT_EXPIRE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableKey(params = {}, callback) ⇒ AWS.Request

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To disable a customer master key (CMK)


/* The following example disables the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK to disable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.disableKey(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the disableKey operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.disableKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK.

      Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

      • Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableKeyRotation(params = {}, callback) ⇒ AWS.Request

Disables rotation of the specified key.

Service Reference:

Examples:

To disable automatic rotation of key material


/* The following example disables automatic annual rotation of the key material for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.disableKeyRotation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the disableKeyRotation operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.disableKeyRotation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableKey(params = {}, callback) ⇒ AWS.Request

Marks a key as enabled, thereby permitting its use.

Service Reference:

Examples:

To enable a customer master key (CMK)


/* The following example enables the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK to enable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.enableKey(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the enableKey operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.enableKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableKeyRotation(params = {}, callback) ⇒ AWS.Request

Enables rotation of the specified customer master key.

Service Reference:

Examples:

To enable automatic rotation of key material


/* The following example enables automatic annual rotation of the key material for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.enableKeyRotation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the enableKeyRotation operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.enableKeyRotation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

encrypt(params = {}, callback) ⇒ AWS.Request

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

  • You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.

  • If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

Service Reference:

Examples:

To encrypt data


/* The following example encrypts data with the specified customer master key (CMK). */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  Plaintext: <Binary String>// The data to encrypt.
 };
 kms.encrypt(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextBlob: <Binary String>, // The encrypted data (ciphertext).
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the CMK that was used to encrypt the data.
   }
   */
 });

Calling the encrypt operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Plaintext: new Buffer('...') || 'STRING_VALUE', /* required */
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ]
};
kms.encrypt(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

    • Plaintext — (Buffer, Typed Array, Blob, String)

      Data to be encrypted.

    • EncryptionContext — (map<String>)

      Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CiphertextBlob — (Buffer, Typed Array, Blob, String)

        The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.

      • KeyId — (String)

        The ID of the key used during encryption.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

generateDataKey(params = {}, callback) ⇒ AWS.Request

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

We recommend that you use the following pattern to encrypt data locally in your application:

  1. Use this operation (GenerateDataKey) to retrieve a data encryption key.

  2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

  3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

  1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To generate a data key


/* The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK). */

 var params = {
  KeyId: "alias/ExampleAlias", // The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  KeySpec: "AES_256"// Specifies the type of data key to return.
 };
 kms.generateDataKey(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextBlob: <Binary String>, // The encrypted data key.
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The ARN of the CMK that was used to encrypt the data key.
    Plaintext: <Binary String>// The unencrypted (plaintext) data key.
   }
   */
 });

Calling the generateDataKey operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  KeySpec: AES_256 | AES_128,
  NumberOfBytes: 0
};
kms.generateDataKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The identifier of the CMK under which to generate and encrypt the data encryption key.

      A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • CMK ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

    • EncryptionContext — (map<String>)

      A set of key-value pairs that represents additional authenticated data.

      For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

    • NumberOfBytes — (Integer)

      The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

    • KeySpec — (String)

      The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

      Possible values include:
      • "AES_256"
      • "AES_128"
    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CiphertextBlob — (Buffer, Typed Array, Blob, String)

        The encrypted data encryption key.

      • Plaintext — (Buffer, Typed Array, Blob, String)

        The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.

      • KeyId — (String)

        The identifier of the CMK under which the data encryption key was generated and encrypted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

generateDataKeyWithoutPlaintext(params = {}, callback) ⇒ AWS.Request

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

Service Reference:

Examples:

To generate an encrypted data key


/* The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified customer master key (CMK). */

 var params = {
  KeyId: "alias/ExampleAlias", // The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
  KeySpec: "AES_256"// Specifies the type of data key to return.
 };
 kms.generateDataKeyWithoutPlaintext(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextBlob: <Binary String>, // The encrypted data key.
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the CMK that was used to encrypt the data key.
   }
   */
 });

Calling the generateDataKeyWithoutPlaintext operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  KeySpec: AES_256 | AES_128,
  NumberOfBytes: 0
};
kms.generateDataKeyWithoutPlaintext(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The identifier of the CMK under which to generate and encrypt the data encryption key.

      A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • CMK ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

    • EncryptionContext — (map<String>)

      A set of key-value pairs that represents additional authenticated data.

      For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

    • KeySpec — (String)

      The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

      Possible values include:
      • "AES_256"
      • "AES_128"
    • NumberOfBytes — (Integer)

      The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CiphertextBlob — (Buffer, Typed Array, Blob, String)

        The encrypted data encryption key.

      • KeyId — (String)

        The identifier of the CMK under which the data encryption key was generated and encrypted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

generateRandom(params = {}, callback) ⇒ AWS.Request

Returns a random byte string that is cryptographically secure.

For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.

Service Reference:

Examples:

To generate random data


/* The following example uses AWS KMS to generate 32 bytes of random data. */

 var params = {
  NumberOfBytes: 32// The length of the random data, specified in number of bytes.
 };
 kms.generateRandom(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Plaintext: <Binary String>// The random data.
   }
   */
 });

Calling the generateRandom operation

var params = {
  NumberOfBytes: 0
};
kms.generateRandom(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NumberOfBytes — (Integer)

      The length of the byte string.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Plaintext — (Buffer, Typed Array, Blob, String)

        The random byte string.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getKeyPolicy(params = {}, callback) ⇒ AWS.Request

Retrieves a policy attached to the specified key.

Service Reference:

Examples:

To retrieve a key policy


/* The following example retrieves the key policy for the specified customer master key (CMK). */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  PolicyName: "default"// The name of the key policy to retrieve.
 };
 kms.getKeyPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: "{\n  \"Version\" : \"2012-10-17\",\n  \"Id\" : \"key-default-1\",\n  \"Statement\" : [ {\n    \"Sid\" : \"Enable IAM User Permissions\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n      \"AWS\" : \"arn:aws:iam::111122223333:root\"\n    },\n    \"Action\" : \"kms:*\",\n    \"Resource\" : \"*\"\n  } ]\n}"// The key policy document.
   }
   */
 });

Calling the getKeyPolicy operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE' /* required */
};
kms.getKeyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

    • PolicyName — (String)

      String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

        A policy document in JSON format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getKeyRotationStatus(params = {}, callback) ⇒ AWS.Request

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

Service Reference:

Examples:

To retrieve the rotation status for a customer master key (CMK)


/* The following example retrieves the status of automatic annual rotation of the key material for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.getKeyRotationStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyRotationEnabled: true// A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not.
   }
   */
 });

Calling the getKeyRotationStatus operation

var params = {
  KeyId: 'STRING_VALUE' /* required */
};
kms.getKeyRotationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyRotationEnabled — (Boolean)

        A Boolean value that specifies whether key rotation is enabled.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getParametersForImport(params = {}, callback) ⇒ AWS.Request

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

Service Reference:

Examples:

To retrieve the public key and import token for a customer master key (CMK)


/* The following example retrieves the public key and import token for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  WrappingAlgorithm: "RSAES_OAEP_SHA_1", // The algorithm that you will use to encrypt the key material before importing it.
  WrappingKeySpec: "RSA_2048"// The type of wrapping key (public key) to return in the response.
 };
 kms.getParametersForImport(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ImportToken: <Binary String>, // The import token to send with a subsequent ImportKeyMaterial request.
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The ARN of the CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.
    ParametersValidTo: <Date Representation>, // The time at which the import token and public key are no longer valid.
    PublicKey: <Binary String>// The public key to use to encrypt the key material before importing it.
   }
   */
 });

Calling the getParametersForImport operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  WrappingAlgorithm: RSAES_PKCS1_V1_5 | RSAES_OAEP_SHA_1 | RSAES_OAEP_SHA_256, /* required */
  WrappingKeySpec: RSA_2048 /* required */
};
kms.getParametersForImport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.

      A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • WrappingAlgorithm — (String)

      The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

      Possible values include:
      • "RSAES_PKCS1_V1_5"
      • "RSAES_OAEP_SHA_1"
      • "RSAES_OAEP_SHA_256"
    • WrappingKeySpec — (String)

      The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

      Possible values include:
      • "RSA_2048"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyId — (String)

        The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.

      • ImportToken — (Buffer, Typed Array, Blob, String)

        The import token to send in a subsequent ImportKeyMaterial request.

      • PublicKey — (Buffer, Typed Array, Blob, String)

        The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

      • ParametersValidTo — (Date)

        The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to retrieve new ones.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

importKeyMaterial(params = {}, callback) ⇒ AWS.Request

Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.

After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

Service Reference:

Examples:

To import key material into a customer master key (CMK)


/* The following example imports key material into the specified CMK. */

 var params = {
  EncryptedKeyMaterial: <Binary String>, // The encrypted key material to import.
  ExpirationModel: "KEY_MATERIAL_DOES_NOT_EXPIRE", // A value that specifies whether the key material expires.
  ImportToken: <Binary String>, // The import token that you received in the response to a previous GetParametersForImport request.
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.importKeyMaterial(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the importKeyMaterial operation

var params = {
  EncryptedKeyMaterial: new Buffer('...') || 'STRING_VALUE', /* required */
  ImportToken: new Buffer('...') || 'STRING_VALUE', /* required */
  KeyId: 'STRING_VALUE', /* required */
  ExpirationModel: KEY_MATERIAL_EXPIRES | KEY_MATERIAL_DOES_NOT_EXPIRE,
  ValidTo: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
kms.importKeyMaterial(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL.

      A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • ImportToken — (Buffer, Typed Array, Blob, String)

      The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

    • EncryptedKeyMaterial — (Buffer, Typed Array, Blob, String)

      The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.

    • ValidTo — (Date)

      The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

    • ExpirationModel — (String)

      Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

      Possible values include:
      • "KEY_MATERIAL_EXPIRES"
      • "KEY_MATERIAL_DOES_NOT_EXPIRE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAliases(params = {}, callback) ⇒ AWS.Request

Lists all of the key aliases in the account.

Service Reference:

Examples:

To list aliases


/* The following example lists aliases. */

 var params = {
 };
 kms.listAliases(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Aliases: [
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/acm", 
      AliasName: "alias/aws/acm", 
      TargetKeyId: "da03f6f7-d279-427a-9cae-de48d07e5b66"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs", 
      AliasName: "alias/aws/ebs", 
      TargetKeyId: "25a217e7-7170-4b8c-8bf6-045ea5f70e5b"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/rds", 
      AliasName: "alias/aws/rds", 
      TargetKeyId: "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift", 
      AliasName: "alias/aws/redshift", 
      TargetKeyId: "08f7a25a-69e2-4fb5-8f10-393db27326fa"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/aws/s3", 
      AliasName: "alias/aws/s3", 
      TargetKeyId: "d2b0f1a3-580d-4f79-b836-bc983be8cfa5"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example1", 
      AliasName: "alias/example1", 
      TargetKeyId: "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example2", 
      AliasName: "alias/example2", 
      TargetKeyId: "f32fef59-2cc2-445b-8573-2d73328acbee"
     }, 
       {
      AliasArn: "arn:aws:kms:us-east-2:111122223333:alias/example3", 
      AliasName: "alias/example3", 
      TargetKeyId: "1374ef38-d34e-4d5f-b2c9-4e0daee38855"
     }
    ], // A list of aliases, including the key ID of the customer master key (CMK) that each alias refers to.
    Truncated: false// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listAliases operation

var params = {
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Aliases — (Array<map>)

        A list of key aliases in the user's account.

        • AliasName — (String)

          String that contains the alias.

        • AliasArn — (String)

          String that contains the key ARN.

        • TargetKeyId — (String)

          String that contains the key identifier referred to by the alias.

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGrants(params = {}, callback) ⇒ AWS.Request

List the grants for a specified key.

Service Reference:

Examples:

To list grants for a customer master key (CMK)


/* The following example lists grants for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.listGrants(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Grants: [
       {
      CreationDate: <Date Representation>, 
      GrantId: "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172", 
      GranteePrincipal: "acm.us-east-2.amazonaws.com", 
      IssuingAccount: "arn:aws:iam::111122223333:root", 
      KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      Operations: [
         "Encrypt", 
         "ReEncryptFrom", 
         "ReEncryptTo"
      ], 
      RetiringPrincipal: "acm.us-east-2.amazonaws.com"
     }, 
       {
      CreationDate: <Date Representation>, 
      GrantId: "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200", 
      GranteePrincipal: "acm.us-east-2.amazonaws.com", 
      IssuingAccount: "arn:aws:iam::111122223333:root", 
      KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      Operations: [
         "ReEncryptFrom", 
         "ReEncryptTo"
      ], 
      RetiringPrincipal: "acm.us-east-2.amazonaws.com"
     }, 
       {
      CreationDate: <Date Representation>, 
      GrantId: "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f", 
      GranteePrincipal: "acm.us-east-2.amazonaws.com", 
      IssuingAccount: "arn:aws:iam::111122223333:root", 
      KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      Operations: [
         "Encrypt", 
         "ReEncryptFrom", 
         "ReEncryptTo"
      ], 
      RetiringPrincipal: "acm.us-east-2.amazonaws.com"
     }, 
       {
      CreationDate: <Date Representation>, 
      GrantId: "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c", 
      GranteePrincipal: "acm.us-east-2.amazonaws.com", 
      IssuingAccount: "arn:aws:iam::111122223333:root", 
      KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      Operations: [
         "Encrypt", 
         "ReEncryptFrom", 
         "ReEncryptTo"
      ], 
      RetiringPrincipal: "acm.us-east-2.amazonaws.com"
     }
    ], // A list of grants.
    Truncated: true// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listGrants operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

    • KeyId — (String)

      A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grants — (Array<map>)

        A list of grants.

        • KeyId — (String)

          The unique identifier for the customer master key (CMK) to which the grant applies.

        • GrantId — (String)

          The unique identifier for the grant.

        • Name — (String)

          The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

        • CreationDate — (Date)

          The date and time when the grant was created.

        • GranteePrincipal — (String)

          The principal that receives the grant's permissions.

        • RetiringPrincipal — (String)

          The principal that can retire the grant.

        • IssuingAccount — (String)

          The AWS account under which the grant was issued.

        • Operations — (Array<String>)

          The list of operations permitted by the grant.

        • Constraints — (map)

          A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

          • EncryptionContextSubset — (map<String>)

            A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

          • EncryptionContextEquals — (map<String>)

            A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listKeyPolicies(params = {}, callback) ⇒ AWS.Request

Retrieves a list of policies attached to a key.

Service Reference:

Examples:

To list key policies for a customer master key (CMK)


/* The following example lists key policies for the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.listKeyPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyNames: [
       "default"
    ], // A list of key policy names.
    Truncated: false// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listKeyPolicies operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listKeyPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

      Currently only 1 policy can be attached to a key.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyNames — (Array<String>)

        A list of policy names. Currently, there is only one policy and it is named "Default".

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listKeys(params = {}, callback) ⇒ AWS.Request

Lists the customer master keys.

Service Reference:

Examples:

To list customer master keys (CMKs)


/* The following example lists CMKs. */

 var params = {
 };
 kms.listKeys(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Keys: [
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e", 
      KeyId: "0d990263-018e-4e65-a703-eff731de951e"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841", 
      KeyId: "144be297-0ae1-44ac-9c8f-93cd8c82f841"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571", 
      KeyId: "21184251-b765-428e-b852-2c7353e72571"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c", 
      KeyId: "214fe92f-5b03-4ae1-b350-db2a45dbe10c"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458", 
      KeyId: "339963f2-e523-49d3-af24-a0fe752aa458"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a", 
      KeyId: "b776a44b-df37-4438-9be4-a27494e4271a"
     }, 
       {
      KeyArn: "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb", 
      KeyId: "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb"
     }
    ], // A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.
    Truncated: false// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listKeys operation

var params = {
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listKeys(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Keys — (Array<map>)

        A list of keys.

        • KeyId — (String)

          Unique identifier of the key.

        • KeyArn — (String)

          ARN of the key.

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResourceTags(params = {}, callback) ⇒ AWS.Request

Returns a list of all tags for the specified customer master key (CMK).

Service Reference:

Examples:

To list tags for a customer master key (CMK)


/* The following example lists tags for a CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose tags you are listing. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.listResourceTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: [
       {
      TagKey: "CostCenter", 
      TagValue: "87654"
     }, 
       {
      TagKey: "CreatedBy", 
      TagValue: "ExampleUser"
     }, 
       {
      TagKey: "Purpose", 
      TagValue: "Test"
     }
    ], // A list of tags.
    Truncated: false// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listResourceTags operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listResourceTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK whose tags you are listing. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

      Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A list of tags. Each tag consists of a tag key and a tag value.

        • TagKeyrequired — (String)

          The key of the tag.

        • TagValuerequired — (String)

          The value of the tag.

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

        Do not assume or infer any information from this value.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRetirableGrants(params = {}, callback) ⇒ AWS.Request

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

Service Reference:

Examples:

To list grants that the specified principal can retire


/* The following example lists the grants that the specified principal (identity) can retire. */

 var params = {
  RetiringPrincipal: "arn:aws:iam::111122223333:role/ExampleRole"// The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of an AWS principal such as an AWS account (root), IAM user, federated user, or assumed role user.
 };
 kms.listRetirableGrants(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Grants: [
       {
      CreationDate: <Date Representation>, 
      GrantId: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", 
      GranteePrincipal: "arn:aws:iam::111122223333:role/ExampleRole", 
      IssuingAccount: "arn:aws:iam::444455556666:root", 
      KeyId: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
      Operations: [
         "Decrypt", 
         "Encrypt"
      ], 
      RetiringPrincipal: "arn:aws:iam::111122223333:role/ExampleRole"
     }
    ], // A list of grants that the specified principal can retire.
    Truncated: false// A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not.
   }
   */
 });

Calling the listRetirableGrants operation

var params = {
  RetiringPrincipal: 'STRING_VALUE', /* required */
  Limit: 0,
  Marker: 'STRING_VALUE'
};
kms.listRetirableGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

      Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

    • Marker — (String)

      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

    • RetiringPrincipal — (String)

      The retiring principal for which to list grants.

      To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grants — (Array<map>)

        A list of grants.

        • KeyId — (String)

          The unique identifier for the customer master key (CMK) to which the grant applies.

        • GrantId — (String)

          The unique identifier for the grant.

        • Name — (String)

          The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

        • CreationDate — (Date)

          The date and time when the grant was created.

        • GranteePrincipal — (String)

          The principal that receives the grant's permissions.

        • RetiringPrincipal — (String)

          The principal that can retire the grant.

        • IssuingAccount — (String)

          The AWS account under which the grant was issued.

        • Operations — (Array<String>)

          The list of operations permitted by the grant.

        • Constraints — (map)

          A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

          • EncryptionContextSubset — (map<String>)

            A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

          • EncryptionContextEquals — (map<String>)

            A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.

      • NextMarker — (String)

        When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

      • Truncated — (Boolean)

        A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putKeyPolicy(params = {}, callback) ⇒ AWS.Request

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To attach a key policy to a customer master key (CMK)


/* The following example attaches a key policy to the specified CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  Policy: "{\n    \"Version\": \"2012-10-17\",\n    \"Id\": \"custom-policy-2016-12-07\",\n    \"Statement\": [\n        {\n            \"Sid\": \"Enable IAM User Permissions\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:root\"\n            },\n            \"Action\": \"kms:*\",\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow access for Key Administrators\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": [\n                    \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n                    \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n                ]\n            },\n            \"Action\": [\n                \"kms:Create*\",\n                \"kms:Describe*\",\n                \"kms:Enable*\",\n                \"kms:List*\",\n                \"kms:Put*\",\n                \"kms:Update*\",\n                \"kms:Revoke*\",\n                \"kms:Disable*\",\n                \"kms:Get*\",\n                \"kms:Delete*\",\n                \"kms:ScheduleKeyDeletion\",\n                \"kms:CancelKeyDeletion\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow use of the key\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:Encrypt\",\n                \"kms:Decrypt\",\n                \"kms:ReEncrypt*\",\n                \"kms:GenerateDataKey*\",\n                \"kms:DescribeKey\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow attachment of persistent resources\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:CreateGrant\",\n                \"kms:ListGrants\",\n                \"kms:RevokeGrant\"\n            ],\n            \"Resource\": \"*\",\n            \"Condition\": {\n                \"Bool\": {\n                    \"kms:GrantIsForAWSResource\": \"true\"\n                }\n            }\n        }\n    ]\n}\n", // The key policy document.
  PolicyName: "default"// The name of the key policy.
 };
 kms.putKeyPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the putKeyPolicy operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE', /* required */
  BypassPolicyLockoutSafetyCheck: true || false
};
kms.putKeyPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK.

      Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

      • Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • PolicyName — (String)

      The name of the key policy.

      This value must be default.

    • Policy — (String)

      The key policy to attach to the CMK.

      If you do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

      • It must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

      • The principals that are specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

      The policy size limit is 32 KiB (32768 bytes).

    • BypassPolicyLockoutSafetyCheck — (Boolean)

      A flag to indicate whether to bypass the key policy lockout safety check.

      Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

      For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

      Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

      The default value is false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

reEncrypt(params = {}, callback) ⇒ AWS.Request

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

Service Reference:

Examples:

To reencrypt data


/* The following example reencrypts data with the specified CMK. */

 var params = {
  CiphertextBlob: <Binary String>, // The data to reencrypt.
  DestinationKeyId: "0987dcba-09fe-87dc-65ba-ab0987654321"// The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
 };
 kms.reEncrypt(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextBlob: <Binary String>, // The reencrypted data.
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", // The ARN of the CMK that was used to reencrypt the data.
    SourceKeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the CMK that was used to originally encrypt the data.
   }
   */
 });

Calling the reEncrypt operation

var params = {
  CiphertextBlob: new Buffer('...') || 'STRING_VALUE', /* required */
  DestinationKeyId: 'STRING_VALUE', /* required */
  DestinationEncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceEncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  }
};
kms.reEncrypt(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CiphertextBlob — (Buffer, Typed Array, Blob, String)

      Ciphertext of the data to reencrypt.

    • SourceEncryptionContext — (map<String>)

      Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

    • DestinationKeyId — (String)

      A unique identifier for the CMK to use to reencrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      • Alias Name Example - alias/MyAliasName

    • DestinationEncryptionContext — (map<String>)

      Encryption context to use when the data is reencrypted.

    • GrantTokens — (Array<String>)

      A list of grant tokens.

      For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CiphertextBlob — (Buffer, Typed Array, Blob, String)

        The reencrypted data.

      • SourceKeyId — (String)

        Unique identifier of the CMK used to originally encrypt the data.

      • KeyId — (String)

        Unique identifier of the CMK used to reencrypt the data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

retireGrant(params = {}, callback) ⇒ AWS.Request

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Service Reference:

Examples:

To retire a grant


/* The following example retires a grant. */

 var params = {
  GrantId: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", // The identifier of the grant to retire.
  KeyId: "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The Amazon Resource Name (ARN) of the customer master key (CMK) associated with the grant.
 };
 kms.retireGrant(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the retireGrant operation

var params = {
  GrantId: 'STRING_VALUE',
  GrantToken: 'STRING_VALUE',
  KeyId: 'STRING_VALUE'
};
kms.retireGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GrantToken — (String)

      Token that identifies the grant to be retired.

    • KeyId — (String)

      The Amazon Resource Name of the CMK associated with the grant. Example:

      • arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • GrantId — (String)

      Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

      • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

revokeGrant(params = {}, callback) ⇒ AWS.Request

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

Service Reference:

Examples:

To revoke a grant


/* The following example revokes a grant. */

 var params = {
  GrantId: "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", // The identifier of the grant to revoke.
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.revokeGrant(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the revokeGrant operation

var params = {
  GrantId: 'STRING_VALUE', /* required */
  KeyId: 'STRING_VALUE' /* required */
};
kms.revokeGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

    • GrantId — (String)

      Identifier of the grant to be revoked.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

scheduleKeyDeletion(params = {}, callback) ⇒ AWS.Request

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

Service Reference:

Examples:

To schedule a customer master key (CMK) for deletion


/* The following example schedules the specified CMK for deletion. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  PendingWindowInDays: 7// The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK.
 };
 kms.scheduleKeyDeletion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeletionDate: <Date Representation>, // The date and time after which AWS KMS deletes the CMK.
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the CMK that is scheduled for deletion.
   }
   */
 });

Calling the scheduleKeyDeletion operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  PendingWindowInDays: 0
};
kms.scheduleKeyDeletion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      The unique identifier for the customer master key (CMK) to delete.

      To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

    • PendingWindowInDays — (Integer)

      The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

      This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • KeyId — (String)

        The unique identifier of the customer master key (CMK) for which deletion is scheduled.

      • DeletionDate — (Date)

        The date and time after which AWS KMS deletes the customer master key (CMK).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or overwrites one or more tags for the specified customer master key (CMK).

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose and tag value is Test. If you send a TagResource request for this CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.

Service Reference:

Examples:

To tag a customer master key (CMK)


/* The following example tags a CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
  Tags: [
     {
    TagKey: "Purpose", 
    TagValue: "Test"
   }
  ]// A list of tags.
 };
 kms.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the tagResource operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
kms.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK you are tagging. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • Tags — (Array<map>)

      One or more tags. Each tag consists of a tag key and a tag value.

      • TagKeyrequired — (String)

        The key of the tag.

      • TagValuerequired — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the specified tag or tags from the specified customer master key (CMK).

To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.

Service Reference:

Examples:

To remove tags from a customer master key (CMK)


/* The following example removes tags from a CMK. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the CMK whose tags you are removing.
  TagKeys: [
     "Purpose", 
     "CostCenter"
  ]// A list of tag keys. Provide only the tag keys, not the tag values.
 };
 kms.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the untagResource operation

var params = {
  KeyId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kms.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK from which you are removing tags. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

      • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

    • TagKeys — (Array<String>)

      One or more tag keys. Specify only the tag keys, not the tag values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAlias(params = {}, callback) ⇒ AWS.Request

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

Service Reference:

Examples:

To update an alias


/* The following example updates the specified alias to refer to the specified customer master key (CMK). */

 var params = {
  AliasName: "alias/ExampleAlias", // The alias to update.
  TargetKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.updateAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the updateAlias operation

var params = {
  AliasName: 'STRING_VALUE', /* required */
  TargetKeyId: 'STRING_VALUE' /* required */
};
kms.updateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasName — (String)

      String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

    • TargetKeyId — (String)

      Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

      You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateKeyDescription(params = {}, callback) ⇒ AWS.Request

Updates the description of a customer master key (CMK).

Service Reference:

Examples:

To update the description of a customer master key (CMK)


/* The following example updates the description of the specified CMK. */

 var params = {
  Description: "Example description that indicates the intended use of this CMK.", // The updated description.
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
 };
 kms.updateKeyDescription(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the updateKeyDescription operation

var params = {
  Description: 'STRING_VALUE', /* required */
  KeyId: 'STRING_VALUE' /* required */
};
kms.updateKeyDescription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • KeyId — (String)

      A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key.

      • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

      • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

    • Description — (String)

      New description for the CMK.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.