Class: AWS.KMS

/* This example connects an AWS KMS custom key store to its backing key store. For an AWS CloudHSM key store, it connects the key store to its AWS CloudHSM cluster. For an external key store, it connects the key store to the external key store proxy that communicates with your external key manager. This operation does not return any data. To verify that the custom key store is connected, use the <code>DescribeCustomKeyStores</code> operation. */

 var params = {
  CustomKeyStoreId: "cks-1234567890abcdef0"// The ID of the AWS KMS custom key store.
 };
 kms.connectCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  CustomKeyStoreId: 'STRING_VALUE' /* required */
};
kms.connectCustomKeyStore(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: {}) —
  • CustomKeyStoreId — (String)

    Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

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.

/* The following example creates an alias for the specified KMS key. */

 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 KMS key whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
 };
 kms.createAlias(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

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)

    Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

  • TargetKeyId — (String)

    Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

    A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

    For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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.

Returns:

• (AWS.Request) —

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

/* This example creates a custom key store that is associated with an AWS CloudHSM cluster. */

 var params = {
  CloudHsmClusterId: "cluster-234abcdefABC", // The ID of the CloudHSM cluster.
  CustomKeyStoreName: "ExampleKeyStore", // A friendly name for the custom key store.
  KeyStorePassword: "kmsPswd", // The password for the kmsuser CU account in the specified cluster.
  TrustAnchorCertificate: "<certificate-goes-here>"// The content of the customerCA.crt file that you created when you initialized the cluster.
 };
 kms.createCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStoreId: "cks-1234567890abcdef0"// The ID of the new custom key store.
   }
   */
 });

/* This example creates an external key store that uses an Amazon VPC endpoint service to communicate with AWS KMS. */

 var params = {
  CustomKeyStoreName: "ExampleVPCEndpointKeyStore", // A friendly name for the custom key store
  CustomKeyStoreType: "EXTERNAL_KEY_STORE", // For external key stores, the value must be EXTERNAL_KEY_STORE
  XksProxyAuthenticationCredential: {
   AccessKeyId: "ABCDE12345670EXAMPLE", 
   RawSecretAccessKey: "DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo="
  }, // The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
  XksProxyConnectivity: "VPC_ENDPOINT_SERVICE", // Indicates how AWS KMS communicates with the external key store proxy
  XksProxyUriEndpoint: "https://myproxy-private.xks.example.com", // The URI that AWS KMS uses to connect to the external key store proxy
  XksProxyUriPath: "/example-prefix/kms/xks/v1", // The URI path to the external key store proxy APIs
  XksProxyVpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example1"// The VPC endpoint service that KMS uses to communicate with the external key store proxy
 };
 kms.createCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStoreId: "cks-1234567890abcdef0"// The ID of the new custom key store.
   }
   */
 });

/* This example creates an external key store with public endpoint connectivity. */

 var params = {
  CustomKeyStoreName: "ExamplePublicEndpointKeyStore", // A friendly name for the custom key store
  CustomKeyStoreType: "EXTERNAL_KEY_STORE", // For external key stores, the value must be EXTERNAL_KEY_STORE
  XksProxyAuthenticationCredential: {
   AccessKeyId: "ABCDE12345670EXAMPLE", 
   RawSecretAccessKey: "DXjSUawnel2fr6SKC7G25CNxTyWKE5PF9XX6H/u9pSo="
  }, // The access key ID and secret access key that KMS uses to authenticate to your external key store proxy
  XksProxyConnectivity: "PUBLIC_ENDPOINT", // Indicates how AWS KMS communicates with the external key store proxy
  XksProxyUriEndpoint: "https://myproxy.xks.example.com", // The URI that AWS KMS uses to connect to the external key store proxy
  XksProxyUriPath: "/kms/xks/v1"// The URI path to your external key store proxy API
 };
 kms.createCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStoreId: "cks-987654321abcdef0"// The ID of the new custom key store.
   }
   */
 });

var params = {
  CustomKeyStoreName: 'STRING_VALUE', /* required */
  CloudHsmClusterId: 'STRING_VALUE',
  CustomKeyStoreType: AWS_CLOUDHSM | EXTERNAL_KEY_STORE,
  KeyStorePassword: 'STRING_VALUE',
  TrustAnchorCertificate: 'STRING_VALUE',
  XksProxyAuthenticationCredential: {
    AccessKeyId: 'STRING_VALUE', /* required */
    RawSecretAccessKey: 'STRING_VALUE' /* required */
  },
  XksProxyConnectivity: PUBLIC_ENDPOINT | VPC_ENDPOINT_SERVICE,
  XksProxyUriEndpoint: 'STRING_VALUE',
  XksProxyUriPath: 'STRING_VALUE',
  XksProxyVpcEndpointServiceName: 'STRING_VALUE'
};
kms.createCustomKeyStore(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: {}) —
  • CustomKeyStoreName — (String)

    Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

  • CloudHsmClusterId — (String)

    Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM.

    Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

  • TrustAnchorCertificate — (String)

    Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

    Enter the content of the trust anchor certificate for the CloudHSM cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

  • KeyStorePassword — (String)

    Specifies the kmsuser password for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

    Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

    The password must be a string of 7 to 32 characters. Its value is case sensitive.

    This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

  • CustomKeyStoreType — (String)

    Specifies the type of custom key store. The default value is AWS_CLOUDHSM.

    For a custom key store backed by an CloudHSM cluster, omit the parameter or enter AWS_CLOUDHSM. For a custom key store backed by an external key manager outside of Amazon Web Services, enter EXTERNAL_KEY_STORE. You cannot change this property after the key store is created.

    Possible values include:
    • "AWS_CLOUDHSM"
    • "EXTERNAL_KEY_STORE"
  • XksProxyUriEndpoint — (String)

    Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy). This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

    The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the XksProxyUriEndpoint value.

    For external key stores with XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name of the VPC endpoint service.

    For external key stores with PUBLIC_ENDPOINT connectivity, this endpoint must be reachable before you create the custom key store. KMS connects to the external key store proxy while creating the custom key store. For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects when you call the ConnectCustomKeyStore operation.

    The value of this parameter must begin with https://. The remainder can contain upper and lower case letters (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (/ and \) are not permitted.

    Uniqueness requirements:

    • The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

    • An external key store with PUBLIC_ENDPOINT connectivity cannot use the same XksProxyUriEndpoint value as an external key store with VPC_ENDPOINT_SERVICE connectivity in this Amazon Web Services Region.

    • Each external key store with VPC_ENDPOINT_SERVICE connectivity must have its own private DNS name. The XksProxyUriEndpoint value for external key stores with VPC_ENDPOINT_SERVICE connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.

  • XksProxyUriPath — (String)

    Specifies the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

    The value must start with / and must end with /kms/xks/v1 where v1 represents the version of the KMS external key store proxy API. This path can include an optional prefix between the required elements such as /prefix/kms/xks/v1.

    Uniqueness requirements:

    • The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

  • XksProxyVpcEndpointServiceName — (String)

    Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). This parameter is required when the value of CustomKeyStoreType is EXTERNAL_KEY_STORE and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE.

    The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.

    Uniqueness requirements:

    • External key stores with VPC_ENDPOINT_SERVICE connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.

  • XksProxyAuthenticationCredential — (map)

    Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

    The XksProxyAuthenticationCredential has two required elements: RawSecretAccessKey, a secret key, and AccessKeyId, a unique identifier for the RawSecretAccessKey. For character requirements, see XksProxyAuthenticationCredentialType.

    KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.

    This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.

    • AccessKeyId — required — (String)

      A unique identifier for the raw secret access key.

    • RawSecretAccessKey — required — (String)

      A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and =.

  • XksProxyConnectivity — (String)

    Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

    If the external key store proxy uses a public endpoint, specify PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC endpoint service for communication with KMS, specify VPC_ENDPOINT_SERVICE. For help making this choice, see Choosing a connectivity option in the Key Management Service Developer Guide.

    An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.

    Possible values include:
    • "PUBLIC_ENDPOINT"
    • "VPC_ENDPOINT_SERVICE"

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:

    • CustomKeyStoreId — (String)

      A unique identifier for the new custom key store.

Returns:

• (AWS.Request) —

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

/* The following example creates a grant that allows the specified IAM role to encrypt data with the specified KMS key. */

 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 KMS key to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
  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.
   }
   */
 });

var params = {
  GranteePrincipal: 'STRING_VALUE', /* required */
  KeyId: 'STRING_VALUE', /* required */
  Operations: [ /* required */
    Decrypt | Encrypt | GenerateDataKey | GenerateDataKeyWithoutPlaintext | ReEncryptFrom | ReEncryptTo | Sign | Verify | GetPublicKey | CreateGrant | RetireGrant | DescribeKey | GenerateDataKeyPair | GenerateDataKeyPairWithoutPlaintext | GenerateMac | VerifyMac | DeriveSharedSecret,
    /* more items */
  ],
  Constraints: {
    EncryptionContextEquals: {
      '<EncryptionContextKey>': 'STRING_VALUE',
      /* '<EncryptionContextKey>': ... */
    },
    EncryptionContextSubset: {
      '<EncryptionContextKey>': 'STRING_VALUE',
      /* '<EncryptionContextKey>': ... */
    }
  },
  DryRun: true || false,
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  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)

    Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

    Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

  • GranteePrincipal — (String)

    The identity that gets the permissions specified in the grant.

    To specify the grantee principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

  • RetiringPrincipal — (String)

    The principal that has permission to use the RetireGrant operation to retire the grant.

    To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

    The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

  • Operations — (Array<String>)

    A list of operations that the grant permits.

    This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

  • Constraints — (map)

    Specifies a grant constraint.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints, which allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in the constraint.

    The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

    You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. Operations with these keys don't support an encryption context.

    Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide .

    • EncryptionContextSubset — (map<String>)

      A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

    • EncryptionContextEquals — (map<String>)

      A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • Name — (String)

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

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    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 for the same grant ID can be used interchangeably.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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:

    • GrantToken — (String)

      The grant token.

      Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

    • GrantId — (String)

      The unique identifier for the grant.

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

Returns:

• (AWS.Request) —

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

/* The following example creates a symmetric KMS key for encryption and decryption. No parameters are required for this operation. */

 var params = {
 };
 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>, 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "AWS_KMS"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a KMS key that contains an asymmetric RSA key pair for encryption and decryption. The key spec and key usage can't be changed after the key is created. */

 var params = {
  KeySpec: "RSA_4096", // Describes the type of key material in the KMS key.
  KeyUsage: "ENCRYPT_DECRYPT"// The cryptographic operations for which you can use the KMS key.
 };
 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>, 
     CustomerMasterKeySpec: "RSA_4096", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "RSAES_OAEP_SHA_1", 
        "RSAES_OAEP_SHA_256"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "RSA_4096", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "AWS_KMS"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a KMS key that contains an asymmetric elliptic curve (ECC) key pair for signing and verification. The key usage is required even though "SIGN_VERIFY" is the only valid value for ECC KMS keys. The key spec and key usage can't be changed after the key is created. */

 var params = {
  KeySpec: "ECC_NIST_P521", // Describes the type of key material in the KMS key.
  KeyUsage: "SIGN_VERIFY"// The cryptographic operations for which you can use the KMS key.
 };
 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>, 
     CustomerMasterKeySpec: "ECC_NIST_P521", 
     Description: "", 
     Enabled: true, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "ECC_NIST_P521", 
     KeyState: "Enabled", 
     KeyUsage: "SIGN_VERIFY", 
     MultiRegion: false, 
     Origin: "AWS_KMS", 
     SigningAlgorithms: [
        "ECDSA_SHA_512"
     ]
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a 384-bit symmetric HMAC KMS key. The GENERATE_VERIFY_MAC key usage value is required even though it's the only valid value for HMAC KMS keys. The key spec and key usage can't be changed after the key is created. */

 var params = {
  KeySpec: "HMAC_384", // Describes the type of key material in the KMS key.
  KeyUsage: "GENERATE_VERIFY_MAC"// The cryptographic operations for which you can use the KMS key.
 };
 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>, 
     CustomerMasterKeySpec: "HMAC_384", 
     Description: "", 
     Enabled: true, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "HMAC_384", 
     KeyState: "Enabled", 
     KeyUsage: "GENERATE_VERIFY_MAC", 
     MacAlgorithms: [
        "HMAC_SHA_384"
     ], 
     MultiRegion: false, 
     Origin: "AWS_KMS"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a multi-Region primary symmetric encryption key. Because the default values for all parameters create a symmetric encryption key, only the MultiRegion parameter is required for this KMS key. */

 var params = {
  MultiRegion: true// Indicates whether the KMS key is a multi-Region (True) or regional (False) key.
 };
 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-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab", 
     CreationDate: <Date Representation>, 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "mrk-1234abcd12ab34cd56ef12345678990ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: true, 
     MultiRegionConfiguration: {
      MultiRegionKeyType: "PRIMARY", 
      PrimaryKey: {
       Arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef12345678990ab", 
       Region: "us-west-2"
      }, 
      ReplicaKeys: [
      ]
     }, 
     Origin: "AWS_KMS"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a symmetric KMS key with no key material. When the operation is complete, you can import your own key material into the KMS key. To create this KMS key, set the Origin parameter to EXTERNAL. */

 var params = {
  Origin: "EXTERNAL"// The source of the key material for the KMS key.
 };
 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>, 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: false, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "PendingImport", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "EXTERNAL"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a KMS key in the specified AWS CloudHSM key store. The operation creates the KMS key and its metadata in AWS KMS and creates the key material in the AWS CloudHSM cluster associated with the custom key store. This example requires the CustomKeyStoreId  and Origin parameters. */

 var params = {
  CustomKeyStoreId: "cks-1234567890abcdef0", // Identifies the custom key store that hosts the KMS key.
  Origin: "AWS_CLOUDHSM"// Indicates the source of the key material for the KMS key.
 };
 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", 
     CloudHsmClusterId: "cluster-234abcdefABC", 
     CreationDate: <Date Representation>, 
     CustomKeyStoreId: "cks-1234567890abcdef0", 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "AWS_CLOUDHSM"
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

/* This example creates a KMS key in the specified external key store. It uses the XksKeyId parameter to associate the KMS key with an existing symmetric encryption key in your external key manager. This CustomKeyStoreId, Origin, and XksKeyId parameters are required in this operation. */

 var params = {
  CustomKeyStoreId: "cks-9876543210fedcba9", // Identifies the custom key store that hosts the KMS key.
  Origin: "EXTERNAL_KEY_STORE", // Indicates the source of the key material for the KMS key.
  XksKeyId: "bb8562717f809024"// Identifies the encryption key in your external key manager that is associated with the KMS key
 };
 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/0987dcba-09fe-87dc-65ba-ab0987654321", 
     CreationDate: <Date Representation>, 
     CustomKeyStoreId: "cks-9876543210fedcba9", 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "0987dcba-09fe-87dc-65ba-ab0987654321", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "EXTERNAL_KEY_STORE", 
     XksKeyConfiguration: {
      Id: "bb8562717f809024"
     }
    }// Detailed information about the KMS key that this operation creates.
   }
   */
 });

var params = {
  BypassPolicyLockoutSafetyCheck: true || false,
  CustomKeyStoreId: 'STRING_VALUE',
  CustomerMasterKeySpec: RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | SYMMETRIC_DEFAULT | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | SM2,
  Description: 'STRING_VALUE',
  KeySpec: RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | SYMMETRIC_DEFAULT | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | SM2,
  KeyUsage: SIGN_VERIFY | ENCRYPT_DECRYPT | GENERATE_VERIFY_MAC | KEY_AGREEMENT,
  MultiRegion: true || false,
  Origin: AWS_KMS | EXTERNAL | AWS_CLOUDHSM | EXTERNAL_KEY_STORE,
  Policy: 'STRING_VALUE',
  Tags: [
    {
      TagKey: 'STRING_VALUE', /* required */
      TagValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  XksKeyId: 'STRING_VALUE'
};
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 KMS key.

    If you provide a key policy, it must meet the following criteria:

    • The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)

    • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

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

    The key policy size quota is 32 kilobytes (32768 bytes).

    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

  • Description — (String)

    A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    To set or change the description after the key is created, use UpdateKeyDescription.

  • KeyUsage — (String)

    Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.

    Select only one valid value.

    • For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.

    • For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

    • For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.

    • For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.

    • For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.

    • For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.

    Possible values include:
    • "SIGN_VERIFY"
    • "ENCRYPT_DECRYPT"
    • "GENERATE_VERIFY_MAC"
    • "KEY_AGREEMENT"
  • CustomerMasterKeySpec — (String)

    Instead, use the KeySpec parameter.

    The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS supports both parameters.

    Possible values include:
    • "RSA_2048"
    • "RSA_3072"
    • "RSA_4096"
    • "ECC_NIST_P256"
    • "ECC_NIST_P384"
    • "ECC_NIST_P521"
    • "ECC_SECG_P256K1"
    • "SYMMETRIC_DEFAULT"
    • "HMAC_224"
    • "HMAC_256"
    • "HMAC_384"
    • "HMAC_512"
    • "SM2"
  • KeySpec — (String)

    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .

    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .

    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

    KMS supports the following key specs for KMS keys:

    • Symmetric encryption key (default)

      • SYMMETRIC_DEFAULT

    • HMAC keys (symmetric)

      • HMAC_224

      • HMAC_256

      • HMAC_384

      • HMAC_512

    • Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)

      • RSA_2048

      • RSA_3072

      • RSA_4096

    • Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)

      • ECC_NIST_P256 (secp256r1)

      • ECC_NIST_P384 (secp384r1)

      • ECC_NIST_P521 (secp521r1)

    • Other asymmetric elliptic curve key pairs (signing and verification)

      • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

    • SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)

      • SM2 (China Regions only)

    Possible values include:
    • "RSA_2048"
    • "RSA_3072"
    • "RSA_4096"
    • "ECC_NIST_P256"
    • "ECC_NIST_P384"
    • "ECC_NIST_P521"
    • "ECC_SECG_P256K1"
    • "SYMMETRIC_DEFAULT"
    • "HMAC_224"
    • "HMAC_256"
    • "HMAC_384"
    • "HMAC_512"
    • "SM2"
  • Origin — (String)

    The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that KMS creates the key material.

    To create a KMS key with no key material (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.

    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.

    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.

    Possible values include:
    • "AWS_KMS"
    • "EXTERNAL"
    • "AWS_CLOUDHSM"
    • "EXTERNAL_KEY_STORE"
  • CustomKeyStoreId — (String)

    Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.

    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.

    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.

  • BypassPolicyLockoutSafetyCheck — (Boolean)

    Skips ("bypasses") the key policy lockout safety check. The default value is false.

    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

    For more information, see Default key policy in the 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 KMS key.

  • Tags — (Array<map>)

    Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    Note: Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

    To use this parameter, you must have kms:TagResource permission in an IAM policy.

    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

    • TagKey — required — (String)

      The key of the tag.

    • TagValue — required — (String)

      The value of the tag.

  • MultiRegion — (Boolean)

    Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

    For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False.

    This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.

    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.

  • XksKeyId — (String)

    Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.

    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.

    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.

    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the 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 KMS key.

      • AWSAccountId — (String)

        The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

      • KeyId — required — (String)

        The globally unique identifier for the KMS key.

      • Arn — (String)

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

      • CreationDate — (Date)

        The date and time when the KMS key was created.

      • Enabled — (Boolean)

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

      • Description — (String)

        The description of the KMS key.

      • KeyUsage — (String)

        The cryptographic operations for which you can use the KMS key.

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

        The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Possible values include:
        • "Creating"
        • "Enabled"
        • "Disabled"
        • "PendingDeletion"
        • "PendingImport"
        • "PendingReplicaDeletion"
        • "Unavailable"
        • "Updating"
      • DeletionDate — (Date)

        The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

        When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

      • ValidTo — (Date)

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

      • Origin — (String)

        The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

        Possible values include:
        • "AWS_KMS"
        • "EXTERNAL"
        • "AWS_CLOUDHSM"
        • "EXTERNAL_KEY_STORE"
      • CustomKeyStoreId — (String)

        A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.

      • CloudHsmClusterId — (String)

        The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.

      • ExpirationModel — (String)

        Specifies whether the KMS key'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"
      • KeyManager — (String)

        The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.

        Possible values include:
        • "AWS"
        • "CUSTOMER"
      • CustomerMasterKeySpec — (String)

        Instead, use the KeySpec field.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

        Possible values include:
        • "RSA_2048"
        • "RSA_3072"
        • "RSA_4096"
        • "ECC_NIST_P256"
        • "ECC_NIST_P384"
        • "ECC_NIST_P521"
        • "ECC_SECG_P256K1"
        • "SYMMETRIC_DEFAULT"
        • "HMAC_224"
        • "HMAC_256"
        • "HMAC_384"
        • "HMAC_512"
        • "SM2"
      • KeySpec — (String)

        Describes the type of key material in the KMS key.

        Possible values include:
        • "RSA_2048"
        • "RSA_3072"
        • "RSA_4096"
        • "ECC_NIST_P256"
        • "ECC_NIST_P384"
        • "ECC_NIST_P521"
        • "ECC_SECG_P256K1"
        • "SYMMETRIC_DEFAULT"
        • "HMAC_224"
        • "HMAC_256"
        • "HMAC_384"
        • "HMAC_512"
        • "SM2"
      • EncryptionAlgorithms — (Array<String>)

        The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

        This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.

      • SigningAlgorithms — (Array<String>)

        The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

        This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.

      • KeyAgreementAlgorithms — (Array<String>)

        The key agreement algorithm used to derive a shared secret.

      • MultiRegion — (Boolean)

        Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

        For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

      • MultiRegionConfiguration — (map)

        Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

        For more information about any listed KMS key, use the DescribeKey operation.

        • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

        • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

        • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

        • MultiRegionKeyType — (String)

          Indicates whether the KMS key is a PRIMARY or REPLICA key.

          Possible values include:
          • "PRIMARY"
          • "REPLICA"
        • PrimaryKey — (map)

          Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

          • Arn — (String)

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region — (String)

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

        • ReplicaKeys — (Array<map>)

          displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

          • Arn — (String)

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region — (String)

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

      • PendingDeletionWindowInDays — (Integer)

        The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

        When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

      • MacAlgorithms — (Array<String>)

        The message authentication code (MAC) algorithm that the HMAC KMS key supports.

        This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.

      • XksKeyConfiguration — (map)

        Information about the external key that is associated with a KMS key in an external key store.

        For more information, see External key in the Key Management Service Developer Guide.

        • Id — (String)

          The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Returns:

• (AWS.Request) —

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

/* The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required when decrypting with a symmetric encryption key, but it is a best practice. */

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

/* The following example decrypts data that was encrypted with an asymmetric encryption KMS key. When the KMS encryption key is asymmetric, you must specify the KMS key ID and the encryption algorithm that was used to encrypt the data. */

 var params = {
  CiphertextBlob: <Binary String>, // The encrypted data (ciphertext).
  EncryptionAlgorithm: "RSAES_OAEP_SHA_256", // The encryption algorithm that was used to encrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
  KeyId: "0987dcba-09fe-87dc-65ba-ab0987654321"// A key identifier for the KMS key to use to decrypt the data. This parameter is required to decrypt with an asymmetric KMS key.
 };
 kms.decrypt(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    EncryptionAlgorithm: "RSAES_OAEP_SHA_256", // The encryption algorithm that was used to decrypt the ciphertext.
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", // The Amazon Resource Name (ARN) of the KMS key that was used to decrypt the data.
    Plaintext: <Binary String>// The decrypted (plaintext) data.
   }
   */
 });

/* The following Decrypt example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning the decrypted data in plaintext (Plaintext), the operation returns the decrypted data encrypted by the public key from the attestation document (CiphertextForRecipient). */

 var params = {
  CiphertextBlob: <Binary String>, // The encrypted data. This ciphertext was encrypted with the KMS key
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The KMS key to use to decrypt the ciphertext
  Recipient: {
   AttestationDocument: <Binary String>, 
   KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256"
  }// Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
 };
 kms.decrypt(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextForRecipient: <Binary String>, // The decrypted CiphertextBlob encrypted with the public key from the attestation document
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The KMS key that was used to decrypt the encrypted data (CiphertextBlob)
    Plaintext: <Binary String>// This field is null or empty
   }
   */
 });

var params = {
  CiphertextBlob: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  DryRun: true || false,
  EncryptionAlgorithm: SYMMETRIC_DEFAULT | RSAES_OAEP_SHA_1 | RSAES_OAEP_SHA_256 | SM2PKE,
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  KeyId: 'STRING_VALUE',
  Recipient: {
    AttestationDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    KeyEncryptionAlgorithm: RSAES_OAEP_SHA_256
  }
};
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>)

    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • KeyId — (String)

    Specifies the KMS key that KMS uses to decrypt the ciphertext.

    Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • EncryptionAlgorithm — (String)

    Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

    This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

    Possible values include:
    • "SYMMETRIC_DEFAULT"
    • "RSAES_OAEP_SHA_1"
    • "RSAES_OAEP_SHA_256"
    • "SM2PKE"
  • Recipient — (map)

    A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

    This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

    When you use this parameter, instead of returning the plaintext data, KMS encrypts the plaintext data with the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

    For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyEncryptionAlgorithm — (String)

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

      Possible values include:
      • "RSAES_OAEP_SHA_256"
    • AttestationDocument — (Buffer, Typed Array, Blob, String)

      The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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)

      The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

    • Plaintext — (Buffer(Node.js), Typed Array(Browser))

      Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

    • EncryptionAlgorithm — (String)

      The encryption algorithm that was used to decrypt the ciphertext.

      Possible values include:
      • "SYMMETRIC_DEFAULT"
      • "RSAES_OAEP_SHA_1"
      • "RSAES_OAEP_SHA_256"
      • "SM2PKE"
    • CiphertextForRecipient — (Buffer(Node.js), Typed Array(Browser))

      The plaintext data encrypted with the public key in the attestation document.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

• (AWS.Request) —

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

/* 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
 });

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 alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

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.

/* This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation. */

 var params = {
  CustomKeyStoreId: "cks-1234567890abcdef0"// The ID of the custom key store to be deleted.
 };
 kms.deleteCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  CustomKeyStoreId: 'STRING_VALUE' /* required */
};
kms.deleteCustomKeyStore(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: {}) —
  • CustomKeyStoreId — (String)

    Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

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.

/* The following example deletes the imported key material from the specified KMS key. */

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

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)

    Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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.

Returns:

• (AWS.Request) —

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

/* The following example derives a shared secret using a key agreement algorithm. */

 var params = {
  KeyAgreementAlgorithm: "ECDH", // The key agreement algorithm used to derive the shared secret. The only valid value is ECDH.
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The key identifier for an asymmetric KMS key pair. The private key in the specified key pair is used to derive the shared secret.
  PublicKey: <Binary String>// The public key in your peer's asymmetric key pair.
 };
 kms.deriveSharedSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyAgreementAlgorithm: "ECDH", // The key agreement algorithm used to derive the shared secret.
    KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The asymmetric KMS key pair used to derive the shared secret.
    KeyOrigin: "AWS_KMS", // The source of the key material for the specified KMS key.
    SharedSecret: <Binary String>// The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.
   }
   */
 });

var params = {
  KeyAgreementAlgorithm: ECDH, /* required */
  KeyId: 'STRING_VALUE', /* required */
  PublicKey: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  DryRun: true || false,
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  Recipient: {
    AttestationDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    KeyEncryptionAlgorithm: RSAES_OAEP_SHA_256
  }
};
kms.deriveSharedSecret(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)

    Identifies an asymmetric NIST-recommended ECC or SM2 (China Regions only) KMS key. KMS uses the private key in the specified key pair to derive the shared secret. The key usage of the KMS key must be KEY_AGREEMENT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • KeyAgreementAlgorithm — (String)

    Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ECDH.

    Possible values include:
    • "ECDH"
  • PublicKey — (Buffer, Typed Array, Blob, String)

    Specifies the public key in your peer's NIST-recommended elliptic curve (ECC) or SM2 (China Regions only) key pair.

    The public key must be a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280.

    GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.

    Note: If you use Amazon Web Services CLI version 1, you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services CLI Base64-encodes the public key a second time, resulting in a ValidationException.

    You can specify the public key as binary data in a file using fileb (fileb://<path-to-file>) or in-line using a Base64 encoded string.

  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

  • Recipient — (map)

    A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

    This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the enclave.

    When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains the encrypted shared secret derived from the KMS key specified by the KeyId parameter and public key specified by the PublicKey parameter. The SharedSecret field in the response is null or empty.

    For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyEncryptionAlgorithm — (String)

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

      Possible values include:
      • "RSAES_OAEP_SHA_256"
    • AttestationDocument — (Buffer, Typed Array, Blob, String)

      The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

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)

      Identifies the KMS key used to derive the shared secret.

    • SharedSecret — (Buffer(Node.js), Typed Array(Browser))

      The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

      If the response includes the CiphertextForRecipient field, the SharedSecret field is null or empty.

    • CiphertextForRecipient — (Buffer(Node.js), Typed Array(Browser))

      The plaintext shared secret encrypted with the public key in the attestation document.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyAgreementAlgorithm — (String)

      Identifies the key agreement algorithm used to derive the shared secret.

      Possible values include:
      • "ECDH"
    • KeyOrigin — (String)

      The source of the key material for the specified KMS key.

      When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material.

      The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

      Possible values include:
      • "AWS_KMS"
      • "EXTERNAL"
      • "AWS_CLOUDHSM"
      • "EXTERNAL_KEY_STORE"

Returns:

• (AWS.Request) —

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

/* This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID. */

 var params = {
 };
 kms.describeCustomKeyStores(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStores: [
    ]// Details about each custom key store in the account and Region.
   }
   */
 });

/* This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. */

 var params = {
  CustomKeyStoreName: "ExampleKeyStore"// The friendly name of the custom key store.
 };
 kms.describeCustomKeyStores(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStores: [
       {
      CloudHsmClusterId: "cluster-234abcdefABC", 
      ConnectionState: "CONNECTED", 
      CreationDate: <Date Representation>, 
      CustomKeyStoreId: "cks-1234567890abcdef0", 
      CustomKeyStoreName: "ExampleKeyStore", 
      CustomKeyStoreType: "AWS_CLOUDHSM", 
      TrustAnchorCertificate: "<certificate appears here>"
     }
    ]// Detailed information about the specified custom key store.
   }
   */
 });

/* This example gets detailed information about an external key store by specifying its ID.  The example external key store proxy uses public endpoint connectivity. */

 var params = {
  CustomKeyStoreId: "cks-9876543210fedcba9"// The ID of the custom key store.
 };
 kms.describeCustomKeyStores(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStores: [
       {
      ConnectionState: "CONNECTED", 
      CreationDate: <Date Representation>, 
      CustomKeyStoreId: "cks-9876543210fedcba9", 
      CustomKeyStoreName: "ExampleExternalKeyStore", 
      CustomKeyStoreType: "EXTERNAL_KEY_STORE", 
      XksProxyConfiguration: {
       AccessKeyId: "ABCDE12345670EXAMPLE", 
       Connectivity: "PUBLIC_ENDPOINT", 
       UriEndpoint: "https://myproxy.xks.example.com", 
       UriPath: "/kms/xks/v1"
      }
     }
    ]// Detailed information about the specified custom key store.
   }
   */
 });

/* This example gets detailed information about a particular external key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint connectivity, the response includes the associated VPC endpoint service name. */

 var params = {
  CustomKeyStoreName: "VPCExternalKeystore"
 };
 kms.describeCustomKeyStores(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CustomKeyStores: [
       {
      ConnectionState: "CONNECTED", 
      CreationDate: <Date Representation>, 
      CustomKeyStoreId: "cks-876543210fedcba98", 
      CustomKeyStoreName: "ExampleVPCExternalKeyStore", 
      CustomKeyStoreType: "EXTERNAL_KEY_STORE", 
      XksProxyConfiguration: {
       AccessKeyId: "ABCDE12345670EXAMPLE", 
       Connectivity: "VPC_ENDPOINT_SERVICE", 
       UriEndpoint: "https://myproxy-private.xks.example.com", 
       UriPath: "/example-prefix/kms/xks/v1", 
       VpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example1"
      }
     }
    ]// Detailed information about the specified custom key store.
   }
   */
 });

var params = {
  CustomKeyStoreId: 'STRING_VALUE',
  CustomKeyStoreName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Marker: 'STRING_VALUE'
};
kms.describeCustomKeyStores(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: {}) —
  • CustomKeyStoreId — (String)

    Gets only information about the specified custom key store. Enter the key store ID.

    By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

  • CustomKeyStoreName — (String)

    Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

    By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

  • Limit — (Integer)

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

  • 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:

    • CustomKeyStores — (Array<map>)

      Contains metadata about each custom key store.

      • CustomKeyStoreId — (String)

        A unique identifier for the custom key store.

      • CustomKeyStoreName — (String)

        The user-specified friendly name for the custom key store.

      • CloudHsmClusterId — (String)

        A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

      • TrustAnchorCertificate — (String)

        The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

        This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

      • ConnectionState — (String)

        Indicates whether the custom key store is connected to its backing key store. For an CloudHSM key store, the ConnectionState indicates whether it is connected to its CloudHSM cluster. For an external key store, the ConnectionState indicates whether it is connected to the external key store proxy that communicates with your external key manager.

        You can create and use KMS keys in your custom key stores only when its ConnectionState is CONNECTED.

        The ConnectionState value is DISCONNECTED only if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that the backing key store is reachable and active. For an CloudHSM key store, verify that its associated CloudHSM cluster is active and contains at least one active HSM. For an external key store, verify that the external key store proxy and external key manager are connected and enabled.

        A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a custom key store in the Key Management Service Developer Guide.

        Possible values include:
        • "CONNECTED"
        • "CONNECTING"
        • "FAILED"
        • "DISCONNECTED"
        • "DISCONNECTING"
      • ConnectionErrorCode — (String)

        Describes the connection error. This field appears in the response only when the ConnectionState is FAILED.

        Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.

        All custom key stores:

        • INTERNAL_ERROR — KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.

        • NETWORK_ERRORS — Network errors are preventing KMS from connecting the custom key store to its backing key store.

        CloudHSM key stores:

        • CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM cluster with the specified cluster ID.

        • INSUFFICIENT_CLOUDHSM_HSMS — The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.

        • INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.

        • INVALID_CREDENTIALS — The KeyStorePassword for the custom key store doesn't match the current password of the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the KeyStorePassword value for the custom key store.

        • SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.

        • USER_LOCKED_OUT — The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.

        • USER_LOGGED_IN — The kmsuser CU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.

        • USER_NOT_FOUND — KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.

        External key stores:

        • INVALID_CREDENTIALS — One or both of the XksProxyAuthenticationCredential values is not valid on the specified external key store proxy.

        • XKS_PROXY_ACCESS_DENIED — KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.

        • XKS_PROXY_INVALID_CONFIGURATION — A configuration error is preventing the external key store from connecting to its proxy. Verify the value of the XksProxyUriPath.

        • XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.

        • XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in the XksProxyUriEndpoint value, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.

        • XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key store proxy. Verify that the XksProxyUriEndpoint and XksProxyUriPath are correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.

        • XKS_PROXY_TIMED_OUT — KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.

        • XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.

          • The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.

          • It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.

          • The Allow principals list must include the KMS service principal for the Region, cks.kms.<region>.amazonaws.com, such as cks.kms.us-east-1.amazonaws.com.

          • It must not require acceptance of connection requests.

          • It must have a private DNS name. The private DNS name for an external key store with VPC_ENDPOINT_SERVICE connectivity must be unique in its Amazon Web Services Region.

          • The domain of the private DNS name must have a verification status of verified.

          • The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.

        • XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that the XksProxyVpcEndpointServiceName is correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.

        Possible values include:
        • "INVALID_CREDENTIALS"
        • "CLUSTER_NOT_FOUND"
        • "NETWORK_ERRORS"
        • "INTERNAL_ERROR"
        • "INSUFFICIENT_CLOUDHSM_HSMS"
        • "USER_LOCKED_OUT"
        • "USER_NOT_FOUND"
        • "USER_LOGGED_IN"
        • "SUBNET_NOT_FOUND"
        • "INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET"
        • "XKS_PROXY_ACCESS_DENIED"
        • "XKS_PROXY_NOT_REACHABLE"
        • "XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND"
        • "XKS_PROXY_INVALID_RESPONSE"
        • "XKS_PROXY_INVALID_CONFIGURATION"
        • "XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION"
        • "XKS_PROXY_TIMED_OUT"
        • "XKS_PROXY_INVALID_TLS_CONFIGURATION"
      • CreationDate — (Date)

        The date and time when the custom key store was created.

      • CustomKeyStoreType — (String)

        Indicates the type of the custom key store. AWS_CLOUDHSM indicates a custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE indicates a custom key store backed by an external key store proxy and external key manager outside of Amazon Web Services.

        Possible values include:
        • "AWS_CLOUDHSM"
        • "EXTERNAL_KEY_STORE"
      • XksProxyConfiguration — (map)

        Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.

        This field appears only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

        • Connectivity — (String)

          Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

          Possible values include:
          • "PUBLIC_ENDPOINT"
          • "VPC_ENDPOINT_SERVICE"
        • AccessKeyId — (String)

          The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

        • UriEndpoint — (String)

          The URI endpoint for the external key store proxy.

          If the external key store proxy has a public endpoint, it is displayed here.

          If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

        • UriPath — (String)

          The path to the external key store proxy APIs.

        • VpcEndpointServiceName — (String)

          The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

    • 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 get 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.

/* The following example gets metadata for a symmetric encryption KMS key. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CreationDate: <Date Representation>, 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "AWS_KMS"
    }// An object that contains information about the specified KMS key.
   }
   */
 });

/* The following example gets metadata for an asymmetric RSA KMS key used for signing and verification. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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>, 
     CustomerMasterKeySpec: "RSA_2048", 
     Description: "", 
     Enabled: false, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "RSA_2048", 
     KeyState: "Disabled", 
     KeyUsage: "SIGN_VERIFY", 
     MultiRegion: false, 
     Origin: "AWS_KMS", 
     SigningAlgorithms: [
        "RSASSA_PKCS1_V1_5_SHA_256", 
        "RSASSA_PKCS1_V1_5_SHA_384", 
        "RSASSA_PKCS1_V1_5_SHA_512", 
        "RSASSA_PSS_SHA_256", 
        "RSASSA_PSS_SHA_384", 
        "RSASSA_PSS_SHA_512"
     ]
    }// An object that contains information about the specified KMS key.
   }
   */
 });

/* The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key. DescribeKey returns information about the primary key and all of its replicas. */

 var params = {
  KeyId: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", 
     CreationDate: <Date Representation>, 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "mrk-1234abcd12ab34cd56ef1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: true, 
     MultiRegionConfiguration: {
      MultiRegionKeyType: "PRIMARY", 
      PrimaryKey: {
       Arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", 
       Region: "us-west-2"
      }, 
      ReplicaKeys: [
         {
        Arn: "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", 
        Region: "eu-west-1"
       }, 
         {
        Arn: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", 
        Region: "ap-northeast-1"
       }, 
         {
        Arn: "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", 
        Region: "sa-east-1"
       }
      ]
     }, 
     Origin: "AWS_KMS"
    }// An object that contains information about the specified KMS key.
   }
   */
 });

/* The following example gets the metadata of an HMAC KMS key. */

 var params = {
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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: "123456789012", 
     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CreationDate: <Date Representation>, 
     CustomerMasterKeySpec: "HMAC_256", 
     Description: "Development test key", 
     Enabled: true, 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeyState: "Enabled", 
     KeyUsage: "GENERATE_VERIFY_MAC", 
     MacAlgorithms: [
        "HMAC_SHA_256"
     ], 
     MultiRegion: false, 
     Origin: "AWS_KMS"
    }// An object that contains information about the specified KMS key.
   }
   */
 });

/* The following example gets the metadata of a KMS key in an AWS CloudHSM key store. */

 var params = {
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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: "123456789012", 
     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CloudHsmClusterId: "cluster-234abcdefABC", 
     CreationDate: <Date Representation>, 
     CustomKeyStoreId: "cks-1234567890abcdef0", 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "CloudHSM key store test key", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "AWS_CLOUDHSM"
    }// An object that contains information about the specified KMS key.
   }
   */
 });

/* The following example gets the metadata of a KMS key in an external key store. */

 var params = {
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// An identifier for the KMS key. You can use the key ID, key ARN, alias name, alias ARN of the KMS key.
 };
 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: "123456789012", 
     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", 
     CreationDate: <Date Representation>, 
     CustomKeyStoreId: "cks-1234567890abcdef0", 
     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT", 
     Description: "External key store test key", 
     Enabled: true, 
     EncryptionAlgorithms: [
        "SYMMETRIC_DEFAULT"
     ], 
     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", 
     KeyManager: "CUSTOMER", 
     KeySpec: "SYMMETRIC_DEFAULT", 
     KeyState: "Enabled", 
     KeyUsage: "ENCRYPT_DECRYPT", 
     MultiRegion: false, 
     Origin: "EXTERNAL_KEY_STORE", 
     XksKeyConfiguration: {
      Id: "bb8562717f809024"
     }
    }// An object that contains information about the specified KMS key.
   }
   */
 });

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)

    Describes the specified KMS key.

    If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the 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 Amazon Web Services account that owns the KMS key.

      • KeyId — required — (String)

        The globally unique identifier for the KMS key.

      • Arn — (String)

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

      • CreationDate — (Date)

        The date and time when the KMS key was created.

      • Enabled — (Boolean)

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

      • Description — (String)

        The description of the KMS key.

      • KeyUsage — (String)

        The cryptographic operations for which you can use the KMS key.

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

        The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Possible values include:
        • "Creating"
        • "Enabled"
        • "Disabled"
        • "PendingDeletion"
        • "PendingImport"
        • "PendingReplicaDeletion"
        • "Unavailable"
        • "Updating"
      • DeletionDate — (Date)

        The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

        When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

      • ValidTo — (Date)

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

      • Origin — (String)

        The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

        Possible values include:
        • "AWS_KMS"
        • "EXTERNAL"
        • "AWS_CLOUDHSM"
        • "EXTERNAL_KEY_STORE"
      • CustomKeyStoreId — (String)

        A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.

      • CloudHsmClusterId — (String)

        The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.

      • ExpirationModel — (String)

        Specifies whether the KMS key'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"
      • KeyManager — (String)

        The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.

        Possible values include:
        • "AWS"
        • "CUSTOMER"
      • CustomerMasterKeySpec — (String)

        Instead, use the KeySpec field.

        The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

        Possible values include:
        • "RSA_2048"
        • "RSA_3072"
        • "RSA_4096"
        • "ECC_NIST_P256"
        • "ECC_NIST_P384"
        • "ECC_NIST_P521"
        • "ECC_SECG_P256K1"
        • "SYMMETRIC_DEFAULT"
        • "HMAC_224"
        • "HMAC_256"
        • "HMAC_384"
        • "HMAC_512"
        • "SM2"
      • KeySpec — (String)

        Describes the type of key material in the KMS key.

        Possible values include:
        • "RSA_2048"
        • "RSA_3072"
        • "RSA_4096"
        • "ECC_NIST_P256"
        • "ECC_NIST_P384"
        • "ECC_NIST_P521"
        • "ECC_SECG_P256K1"
        • "SYMMETRIC_DEFAULT"
        • "HMAC_224"
        • "HMAC_256"
        • "HMAC_384"
        • "HMAC_512"
        • "SM2"
      • EncryptionAlgorithms — (Array<String>)

        The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

        This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.

      • SigningAlgorithms — (Array<String>)

        The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

        This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.

      • KeyAgreementAlgorithms — (Array<String>)

        The key agreement algorithm used to derive a shared secret.

      • MultiRegion — (Boolean)

        Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

        For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

      • MultiRegionConfiguration — (map)

        Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

        For more information about any listed KMS key, use the DescribeKey operation.

        • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

        • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

        • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

        • MultiRegionKeyType — (String)

          Indicates whether the KMS key is a PRIMARY or REPLICA key.

          Possible values include:
          • "PRIMARY"
          • "REPLICA"
        • PrimaryKey — (map)

          Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

          • Arn — (String)

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region — (String)

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

        • ReplicaKeys — (Array<map>)

          displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

          • Arn — (String)

            Displays the key ARN of a primary or replica key of a multi-Region key.

          • Region — (String)

            Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

      • PendingDeletionWindowInDays — (Integer)

        The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

        When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

      • MacAlgorithms — (Array<String>)

        The message authentication code (MAC) algorithm that the HMAC KMS key supports.

        This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.

      • XksKeyConfiguration — (map)

        Information about the external key that is associated with a KMS key in an external key store.

        For more information, see External key in the Key Management Service Developer Guide.

        • Id — (String)

          The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Returns:

• (AWS.Request) —

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

/* The following example disables the specified KMS key. */

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

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)

    Identifies the KMS key to disable.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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.

Returns:

• (AWS.Request) —

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

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

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

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)

    Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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.

Returns:

• (AWS.Request) —

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

/* This example disconnects an AWS KMS custom key store from its backing key store. For an AWS CloudHSM key store, it disconnects the key store from its AWS CloudHSM cluster. For an external key store, it disconnects the key store from the external key store proxy that communicates with your external key manager. This operation doesn't return any data. To verify that the custom key store is disconnected, use the <code>DescribeCustomKeyStores</code> operation. */

 var params = {
  CustomKeyStoreId: "cks-1234567890abcdef0"// The ID of the custom key store.
 };
 kms.disconnectCustomKeyStore(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  CustomKeyStoreId: 'STRING_VALUE' /* required */
};
kms.disconnectCustomKeyStore(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: {}) —
  • CustomKeyStoreId — (String)

    Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

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.

/* The following example enables the specified KMS key. */

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

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)

    Identifies the KMS key to enable.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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.

Returns:

• (AWS.Request) —

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

/* The following example enables automatic rotation with a rotation period of 365 days for the specified KMS key. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key whose key material will be automatically rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
  RotationPeriodInDays: 365// The number of days between each rotation date. Specify a value between 9 and 2560. If no value is specified, the default value is 365 days.
 };
 kms.enableKeyRotation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  RotationPeriodInDays: 'NUMBER_VALUE'
};
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)

    Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

  • RotationPeriodInDays — (Integer)

    Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the default value is 365 days.

    The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter.

    You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can specify in the RotationPeriodInDays parameter.

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.

/* The following example encrypts data with the specified symmetric encryption KMS key. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
  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).
    EncryptionAlgorithm: "SYMMETRIC_DEFAULT", // The encryption algorithm that was used in the operation. For symmetric encryption keys, the encryption algorithm is always SYMMETRIC_DEFAULT.
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"// The ARN of the KMS key that was used to encrypt the data.
   }
   */
 });

/* The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key, you must specify the encryption algorithm. */

 var params = {
  EncryptionAlgorithm: "RSAES_OAEP_SHA_256", // The encryption algorithm to use in the operation.
  KeyId: "0987dcba-09fe-87dc-65ba-ab0987654321", // The identifier of the KMS key to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
  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).
    EncryptionAlgorithm: "RSAES_OAEP_SHA_256", // The encryption algorithm that was used in the operation.
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321"// The ARN of the KMS key that was used to encrypt the data.
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  Plaintext: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  DryRun: true || false,
  EncryptionAlgorithm: SYMMETRIC_DEFAULT | RSAES_OAEP_SHA_1 | RSAES_OAEP_SHA_256 | SM2PKE,
  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)

    Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

    Data to be encrypted.

  • EncryptionContext — (map<String>)

    Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • EncryptionAlgorithm — (String)

    Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.

    This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

    The SM2PKE algorithm is only available in China Regions.

    Possible values include:
    • "SYMMETRIC_DEFAULT"
    • "RSAES_OAEP_SHA_1"
    • "RSAES_OAEP_SHA_256"
    • "SM2PKE"
  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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(Node.js), Typed Array(Browser))

      The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • KeyId — (String)

      The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

    • EncryptionAlgorithm — (String)

      The encryption algorithm that was used to encrypt the plaintext.

      Possible values include:
      • "SYMMETRIC_DEFAULT"
      • "RSAES_OAEP_SHA_1"
      • "RSAES_OAEP_SHA_256"
      • "SM2PKE"

Returns:

• (AWS.Request) —

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

/* 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 KMS key. */

 var params = {
  KeyId: "alias/ExampleAlias", // The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
  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 KMS key that was used to encrypt the data key.
    Plaintext: <Binary String>// The unencrypted (plaintext) data key.
   }
   */
 });

/* The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a copy of the data key encrypted by the KMS key and a plaintext copy of the data key, GenerateDataKey returns one copy of the data key encrypted by the KMS key (CiphertextBlob) and one copy of the data key encrypted by the public key from the attestation document (CiphertextForRecipient). The operation doesn't return a plaintext data key.  */

 var params = {
  KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // Identifies the KMS key used to encrypt the encrypted data key (CiphertextBlob)
  KeySpec: "AES_256", // Specifies the type of data key to return
  Recipient: {
   AttestationDocument: <Binary String>, 
   KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256"
  }// Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
 };
 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 data key encrypted by the specified KMS key
    CiphertextForRecipient: <Binary String>, // The plaintext data key encrypted by the public key from the attestation document
    KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The KMS key used to encrypt the CiphertextBlob (encrypted data key)
    Plaintext: <Binary String>// This field is null or empty
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  KeySpec: AES_256 | AES_128,
  NumberOfBytes: 'NUMBER_VALUE',
  Recipient: {
    AttestationDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    KeyEncryptionAlgorithm: RSAES_OAEP_SHA_256
  }
};
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)

    Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • EncryptionContext — (map<String>)

    Specifies the encryption context that will be used when encrypting the data key.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • NumberOfBytes — (Integer)

    Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

    You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

  • KeySpec — (String)

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

    You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

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

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • Recipient — (map)

    A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

    This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

    When you use this parameter, instead of returning the plaintext data key, KMS encrypts the plaintext data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the data key encrypted under the KMS key specified by the KeyId parameter. The Plaintext field in the response is null or empty.

    For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyEncryptionAlgorithm — (String)

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

      Possible values include:
      • "RSAES_OAEP_SHA_256"
    • AttestationDocument — (Buffer, Typed Array, Blob, String)

      The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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(Node.js), Typed Array(Browser))

      The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • Plaintext — (Buffer(Node.js), Typed Array(Browser))

      The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

      If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

    • KeyId — (String)

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

    • CiphertextForRecipient — (Buffer(Node.js), Typed Array(Browser))

      The plaintext data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

• (AWS.Request) —

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

/* This example generates an RSA data key pair for encryption and decryption. The operation returns a plaintext public key and private key, and a copy of the private key that is encrypted under a symmetric encryption KMS key that you specify. */

 var params = {
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
  KeyPairSpec: "RSA_3072"// The requested key spec of the RSA data key pair.
 };
 kms.generateDataKeyPair(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 key ARN of the symmetric encryption KMS key that was used to encrypt the private key.
    KeyPairSpec: "RSA_3072", // The actual key spec of the RSA data key pair.
    PrivateKeyCiphertextBlob: <Binary String>, // The encrypted private key of the RSA data key pair.
    PrivateKeyPlaintext: <Binary String>, // The plaintext private key of the RSA data key pair.
    PublicKey: <Binary String>// The public key (plaintext) of the RSA data key pair.
   }
   */
 });

/* The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext copy of the private data key, GenerateDataKeyPair returns a copy of the private data key encrypted by the public key from the attestation document (CiphertextForRecipient). It returns the public data key (PublicKey) and a copy of private data key encrypted under the specified KMS key (PrivateKeyCiphertextBlob), as usual, but plaintext private data key field (PrivateKeyPlaintext) is null or empty.  */

 var params = {
  KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The key ID of the symmetric encryption KMS key that encrypts the private RSA key in the data key pair.
  KeyPairSpec: "RSA_3072", // The requested key spec of the RSA data key pair.
  Recipient: {
   AttestationDocument: <Binary String>, 
   KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256"
  }// Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document.
 };
 kms.generateDataKeyPair(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextForRecipient: <Binary String>, // The private key of the RSA data key pair encrypted by the public key from the attestation document
    KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The key ARN of the symmetric encryption KMS key that was used to encrypt the PrivateKeyCiphertextBlob.
    KeyPairSpec: "RSA_3072", // The actual key spec of the RSA data key pair.
    PrivateKeyCiphertextBlob: <Binary String>, // The private key of the RSA data key pair encrypted by the KMS key.
    PrivateKeyPlaintext: <Binary String>, // This field is null or empty
    PublicKey: <Binary String>// The public key (plaintext) of the RSA data key pair.
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  KeyPairSpec: RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | SM2, /* required */
  DryRun: true || false,
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  Recipient: {
    AttestationDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    KeyEncryptionAlgorithm: RSAES_OAEP_SHA_256
  }
};
kms.generateDataKeyPair(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: {}) —
  • EncryptionContext — (map<String>)

    Specifies the encryption context that will be used when encrypting the private key in the data key pair.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • KeyId — (String)

    Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • KeyPairSpec — (String)

    Determines the type of data key pair that is generated.

    The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

    Possible values include:
    • "RSA_2048"
    • "RSA_3072"
    • "RSA_4096"
    • "ECC_NIST_P256"
    • "ECC_NIST_P384"
    • "ECC_NIST_P521"
    • "ECC_SECG_P256K1"
    • "SM2"
  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • Recipient — (map)

    A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

    This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To call DeriveSharedSecret for an Amazon Web Services Nitro Enclaves, use the Amazon Web Services Nitro Enclaves SDK to generate the attestation document and then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the enclave.

    When you use this parameter, instead of returning a plaintext copy of the private data key, KMS encrypts the plaintext private data key under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The CiphertextBlob field in the response contains a copy of the private data key encrypted under the KMS key specified by the KeyId parameter. The PrivateKeyPlaintext field in the response is null or empty.

    For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyEncryptionAlgorithm — (String)

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

      Possible values include:
      • "RSAES_OAEP_SHA_256"
    • AttestationDocument — (Buffer, Typed Array, Blob, String)

      The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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:

    • PrivateKeyCiphertextBlob — (Buffer(Node.js), Typed Array(Browser))

      The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • PrivateKeyPlaintext — (Buffer(Node.js), Typed Array(Browser))

      The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the PrivateKeyPlaintext field is null or empty.

    • PublicKey — (Buffer(Node.js), Typed Array(Browser))

      The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • KeyId — (String)

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

    • KeyPairSpec — (String)

      The type of data key pair that was generated.

      Possible values include:
      • "RSA_2048"
      • "RSA_3072"
      • "RSA_4096"
      • "ECC_NIST_P256"
      • "ECC_NIST_P384"
      • "ECC_NIST_P521"
      • "ECC_SECG_P256K1"
      • "SM2"
    • CiphertextForRecipient — (Buffer(Node.js), Typed Array(Browser))

      The plaintext private data key encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

• (AWS.Request) —

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

/* This example returns an asymmetric elliptic curve (ECC) data key pair. The private key is encrypted under the symmetric encryption KMS key that you specify. This operation doesn't return a plaintext (unencrypted) private key. */

 var params = {
  KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", // The symmetric encryption KMS key that encrypts the private key of the ECC data key pair.
  KeyPairSpec: "ECC_NIST_P521"// The requested key spec of the ECC asymmetric data key pair.
 };
 kms.generateDataKeyPairWithoutPlaintext(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 key ARN of the symmetric encryption KMS key that encrypted the private key in the ECC asymmetric data key pair.
    KeyPairSpec: "ECC_NIST_P521", // The actual key spec of the ECC asymmetric data key pair.
    PrivateKeyCiphertextBlob: <Binary String>, // The encrypted private key of the asymmetric ECC data key pair.
    PublicKey: <Binary String>// The public key (plaintext).
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  KeyPairSpec: RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | SM2, /* required */
  DryRun: true || false,
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ]
};
kms.generateDataKeyPairWithoutPlaintext(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: {}) —
  • EncryptionContext — (map<String>)

    Specifies the encryption context that will be used when encrypting the private key in the data key pair.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • KeyId — (String)

    Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • KeyPairSpec — (String)

    Determines the type of data key pair that is generated.

    The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

    Possible values include:
    • "RSA_2048"
    • "RSA_3072"
    • "RSA_4096"
    • "ECC_NIST_P256"
    • "ECC_NIST_P384"
    • "ECC_NIST_P521"
    • "ECC_SECG_P256K1"
    • "SM2"
  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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:

    • PrivateKeyCiphertextBlob — (Buffer(Node.js), Typed Array(Browser))

      The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • PublicKey — (Buffer(Node.js), Typed Array(Browser))

      The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • KeyId — (String)

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

    • KeyPairSpec — (String)

      The type of data key pair that was generated.

      Possible values include:
      • "RSA_2048"
      • "RSA_3072"
      • "RSA_4096"
      • "ECC_NIST_P256"
      • "ECC_NIST_P384"
      • "ECC_NIST_P521"
      • "ECC_SECG_P256K1"
      • "SM2"

Returns:

• (AWS.Request) —

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

/* 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 KMS key. */

 var params = {
  KeyId: "alias/ExampleAlias", // The identifier of the KMS key to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the KMS key, or the name or ARN of an alias that refers to the KMS key.
  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 KMS key that was used to encrypt the data key.
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  DryRun: true || false,
  EncryptionContext: {
    '<EncryptionContextKey>': 'STRING_VALUE',
    /* '<EncryptionContextKey>': ... */
  },
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ],
  KeySpec: AES_256 | AES_128,
  NumberOfBytes: 'NUMBER_VALUE'
};
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)

    Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

    To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

    For example:

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

    • Key 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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

  • EncryptionContext — (map<String>)

    Specifies the encryption context that will be used when encrypting the data key.

    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

    An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

  • KeySpec — (String)

    The length of the data 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 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.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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(Node.js), Typed Array(Browser))

      The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • KeyId — (String)

      The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

Returns:

• (AWS.Request) —

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

/* This example generates an HMAC for a message, an HMAC KMS key, and a MAC algorithm. The algorithm must be supported by the specified HMAC KMS key. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The HMAC KMS key input to the HMAC algorithm.
  MacAlgorithm: "HMAC_SHA_384", // The HMAC algorithm requested for the operation.
  Message: <Binary String>// The message input to the HMAC algorithm.
 };
 kms.generateMac(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 key ARN of the HMAC KMS key used in the operation.
    Mac: <Binary String>, // The HMAC tag that results from this operation.
    MacAlgorithm: "HMAC_SHA_384"// The HMAC algorithm used in the operation.
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  MacAlgorithm: HMAC_SHA_224 | HMAC_SHA_256 | HMAC_SHA_384 | HMAC_SHA_512, /* required */
  Message: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  DryRun: true || false,
  GrantTokens: [
    'STRING_VALUE',
    /* more items */
  ]
};
kms.generateMac(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: {}) —
  • Message — (Buffer, Typed Array, Blob, String)

    The message to be hashed. Specify a message of up to 4,096 bytes.

    GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

  • KeyId — (String)

    The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

    To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

  • MacAlgorithm — (String)

    The MAC algorithm used in the operation.

    The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

    Possible values include:
    • "HMAC_SHA_224"
    • "HMAC_SHA_256"
    • "HMAC_SHA_384"
    • "HMAC_SHA_512"
  • GrantTokens — (Array<String>)

    A list of grant tokens.

    Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

  • DryRun — (Boolean)

    Checks if your request will succeed. DryRun is an optional parameter.

    To learn more about how to use this parameter, see Testing your KMS API calls in the 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:

    • Mac — (Buffer(Node.js), Typed Array(Browser))

      The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

      This is the standard, raw HMAC defined in RFC 2104.

    • MacAlgorithm — (String)

      The MAC algorithm that was used to generate the HMAC.

      Possible values include:
      • "HMAC_SHA_224"
      • "HMAC_SHA_256"
      • "HMAC_SHA_384"
      • "HMAC_SHA_512"
    • KeyId — (String)

      The HMAC KMS key used in the operation.

Returns:

• (AWS.Request) —

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

/* The following example generates 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.
   }
   */
 });

/* The following example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning a plaintext (unencrypted) byte string, GenerateRandom returns the byte string encrypted by the public key from the enclave's attestation document. */

 var params = {
  NumberOfBytes: 1024, // The length of the random byte string
  Recipient: {
   AttestationDocument: <Binary String>, 
   KeyEncryptionAlgorithm: "RSAES_OAEP_SHA_256"
  }// Specifies the attestation document from the Nitro enclave and the encryption algorithm to use with the public key from the attestation document
 };
 kms.generateRandom(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CiphertextForRecipient: <Binary String>, // The random data encrypted under the public key from the attestation document
    Plaintext: <Binary String>// This field is null or empty
   }
   */
 });

var params = {
  CustomKeyStoreId: 'STRING_VALUE',
  NumberOfBytes: 'NUMBER_VALUE',
  Recipient: {
    AttestationDocument: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
    KeyEncryptionAlgorithm: RSAES_OAEP_SHA_256
  }
};
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 random byte string. This parameter is required.

  • CustomKeyStoreId — (String)

    Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

    External key store IDs are not valid for this parameter. If you specify the ID of an external key store, GenerateRandom throws an UnsupportedOperationException.

  • Recipient — (map)

    A signed attestation document from an Amazon Web Services Nitro enclave and the encryption algorithm to use with the enclave's public key. The only valid encryption algorithm is RSAES_OAEP_SHA_256.

    This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves. To include this parameter, use the Amazon Web Services Nitro Enclaves SDK or any Amazon Web Services SDK.

    When you use this parameter, instead of returning plaintext bytes, KMS encrypts the plaintext bytes under the public key in the attestation document, and returns the resulting ciphertext in the CiphertextForRecipient field in the response. This ciphertext can be decrypted only with the private key in the enclave. The Plaintext field in the response is null or empty.

    For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

    • KeyEncryptionAlgorithm — (String)

      The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

      Possible values include:
      • "RSAES_OAEP_SHA_256"
    • AttestationDocument — (Buffer, Typed Array, Blob, String)

      The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

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(Node.js), Typed Array(Browser))

      The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

    • CiphertextForRecipient — (Buffer(Node.js), Typed Array(Browser))

      The plaintext random bytes encrypted with the public key from the Nitro enclave. This ciphertext can be decrypted only by using a private key in the Nitro enclave.

      This field is included in the response only when the Recipient parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

Returns:

• (AWS.Request) —

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

/* The following example retrieves the key policy for the specified KMS key. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
  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.
   }
   */
 });

var params = {
  KeyId: 'STRING_VALUE', /* required */
  PolicyName: 'STRING_VALUE'
};
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)

    Gets the key policy for the specified KMS key.

    Specify the key ID or key ARN of the KMS key.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

  • PolicyName — (String)

    Specifies the name of the key policy. If no policy name is specified, the default value is default. The only valid name is default. To get the names of key policies, use 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 key policy document in JSON format.

    • PolicyName — (String)

      The name of the key policy. The only valid value is default.

Returns:

• (AWS.Request) —

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

/* The following example retrieves detailed information about the rotation status for a KMS key, including whether automatic key rotation is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date. */

 var params = {
  KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"// The identifier of the KMS key whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
 };
 kms.getKeyRotationStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab", // Identifies the specified symmetric encryption KMS key.
    KeyRotationEnabled: true, // A boolean that indicates the key material rotation status. Returns true when automatic rotation of the key material is enabled, or false when it is not.
    NextRotationDate: <Date Representation>, // The next date that the key material will be automatically rotated.
    OnDemandRotationStartDate: <Date Representation>, // Identifies the date and time that an in progress on-demand rotation was initiated.
    RotationPeriodInDays: 365// The number of days between each automatic rotation. The default value is 365 days.
   }
   */
 });

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)

    Gets the rotation status for the specified KMS key.

    Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

    For example:

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

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

    To get the key ID and key ARN for a KMS key, 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:

    • KeyRotationEnabled — (Boolean)

      A Boolean value that specifies whether key rotation is enabled.

    • KeyId — (String)

      Identifies the specified symmetric encryption KMS key.

    • RotationPeriodInDays — (Integer)

      The number of days between each automatic rotation. The default value is 365 days.

    • NextRotationDate — (Date)

      The next date that KMS will automatically rotate the key material.

    • OnDemandRotationStartDate — (Date)

      Identifies the date and time that an in progress on-demand rotation was initiated.

      The KMS API follows an eventual consistency model due to the distributed nature of the system. As a result, there might be a slight delay between initiating on-demand key rotation and the rotation's completion. Once the on-demand rotation is complete, use ListKeyRotations to view the details of the on-demand rotation.

Returns:

• (AWS.Request) —

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