Class ImportKeyMaterialCommandProtected

Imports or reimports key material into an existing KMS key that was created without key material. ImportKeyMaterial also sets the expiration model and expiration date of the imported key material.

By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.

After you successfully import key material into a KMS key, you can reimport the same key material into that KMS key, but you cannot import different key material. You might reimport key material to replace key material that expired or key material that you deleted. You might also reimport key material to change the expiration model or expiration date of the key material. Before reimporting key material, if necessary, call DeleteImportedKeyMaterial to delete the current imported key material.

Each time you import key material into KMS, you can determine whether (ExpirationModel) and when (ValidTo) the key material expires. To change the expiration of your key material, you must import it again, either by calling ImportKeyMaterial or using the import features of the KMS console.

Before calling ImportKeyMaterial:

• Create or identify a KMS key with no key material. The KMS key must have an Origin value of EXTERNAL, which indicates that the KMS key is designed for imported key material.

  To create an new KMS key for imported key material, call the CreateKey operation with an Origin value of EXTERNAL. You can create a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material into a multi-Region key of any supported type. However, you can't import key material into a KMS key in a custom key store.

• Use the DescribeKey operation to verify that the KeyState of the KMS key is PendingImport, which indicates that the KMS key has no key material.

  If you are reimporting the same key material into an existing KMS key, you might need to call the DeleteImportedKeyMaterial to delete its existing key material.

• Call the GetParametersForImport operation to get a public key and import token set for importing key material.

• Use the public key in the GetParametersForImport response to encrypt your key material.

Then, in an ImportKeyMaterial request, you submit your encrypted key material and import token. When calling this operation, you must specify the following values:

• The key ID or key ARN of the KMS key to associate with the imported key material. Its Origin must be EXTERNAL and its KeyState must be PendingImport. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account. To get the Origin and KeyState of a KMS key, call DescribeKey.

• The encrypted key material.

• The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response.

• Whether the key material expires (ExpirationModel) and, if so, when (ValidTo). For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.

  If you set an expiration date, KMS deletes the key material from the KMS key on the specified date, making the KMS key unusable. To use the KMS key in cryptographic operations again, you must reimport the same key material. However, you can delete and reimport the key material at any time, including before the key material expires. Each time you reimport, you can eliminate or reset the expiration time.

When this operation is successful, the key state of the KMS key changes from PendingImport to Enabled, and you can use the KMS key in cryptographic operations.

If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and repeat the import procedure. For help, see How To Import Key Material in the Key Management Service Developer Guide.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ImportKeyMaterial (key policy)

Related operations:

• DeleteImportedKeyMaterial

• GetParametersForImport

Example

Use a bare-bones client and the command you need to make an API call.

import { KMSClient, ImportKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, ImportKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // ImportKeyMaterialRequest
  KeyId: "STRING_VALUE", // required
  ImportToken: "BLOB_VALUE", // required
  EncryptedKeyMaterial: "BLOB_VALUE", // required
  ValidTo: new Date("TIMESTAMP"),
  ExpirationModel: "KEY_MATERIAL_EXPIRES" || "KEY_MATERIAL_DOES_NOT_EXPIRE",
};
const command = new ImportKeyMaterialCommand(input);
const response = await client.send(command);
// {};

Param

ImportKeyMaterialCommandInput

Returns

ImportKeyMaterialCommandOutput

See

• ImportKeyMaterialCommandInput for command's input shape.
• ImportKeyMaterialCommandOutput for command's response shape.
• config for KMSClient's config shape.

Throws

DependencyTimeoutException (server fault)

The system timed out while trying to fulfill the request. You can retry the request.

Throws

ExpiredImportTokenException (client fault)

The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

Throws

IncorrectKeyMaterialException (client fault)

The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.

Throws

InvalidArnException (client fault)

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

Throws

InvalidCiphertextException (client fault)

From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because KMS could not decrypt the encrypted (wrapped) key material.

Throws

InvalidImportTokenException (client fault)

The request was rejected because the provided import token is invalid or is associated with a different KMS key.

Throws

KMSInternalException (server fault)

The request was rejected because an internal exception occurred. The request can be retried.

Throws

KMSInvalidStateException (client fault)

The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:

• The key state of the KMS key is not compatible with the operation.

  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .

• For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.

Throws

NotFoundException (client fault)

The request was rejected because the specified entity or resource could not be found.

Throws

UnsupportedOperationException (client fault)

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Throws

KMSServiceException

Base exception class for all service exceptions from KMS service.

Example

To import key material into a KMS key

// The following example imports key material into the specified KMS key.
const input = {
  "EncryptedKeyMaterial": "<binary data>",
  "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
  "ImportToken": "<binary data>",
  "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
};
const command = new ImportKeyMaterialCommand(input);
await client.send(command);
// example id: to-import-key-material-into-a-cmk-1480630551969

Example

To import key material into a KMS key

// The following example imports key material into the specified KMS key.
const input = {
  "EncryptedKeyMaterial": "<binary data>",
  "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
  "ImportToken": "<binary data>",
  "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
};
const command = new ImportKeyMaterialCommand(input);
await client.send(command);
// example id: to-import-key-material-into-a-kms-key-1

Example

To import key material into a KMS key

// The following example imports key material that expires in 3 days. It might be part of an application that frequently reimports the same key material to comply with business rules or regulations.
const input = {
  "EncryptedKeyMaterial": "<binary data>",
  "ExpirationModel": "KEY_MATERIAL_EXPIRES",
  "ImportToken": "<binary data>",
  "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
  "ValidTo": "2023-09-30T00:00:00-00:00"
};
const command = new ImportKeyMaterialCommand(input);
await client.send(command);
// example id: to-import-key-material-into-a-kms-key-2