paws.security.identity (version 0.1.12)

kms_import_key_material: Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material

Description

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.

Before using this operation, call get_parameters_for_import. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same get_parameters_for_import response.

When calling this operation, you must specify the following values:

• The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.

  To create a CMK with no key material, call create_key and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call describe_key.)

• The encrypted key material. To get the public key to encrypt the key material, call get_parameters_for_import.

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

• Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.

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

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 get_parameters_for_import to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:ImportKeyMaterial (key policy)

Related operations:

• delete_imported_key_material

• get_parameters_for_import

Usage

kms_import_key_material(KeyId, ImportToken, EncryptedKeyMaterial,
  ValidTo, ExpirationModel)

Value

An empty list.

Arguments

KeyId

[required] The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding get_parameters_for_import request.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use list_keys or describe_key.

ImportToken

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

EncryptedKeyMaterial

[required] The encrypted key material to import. The key material must be encrypted with the public wrapping key that get_parameters_for_import returned, using the wrapping algorithm that you specified in the same get_parameters_for_import request.

ValidTo

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

ExpirationModel

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

Request syntax

svc$import_key_material(
  KeyId = "string",
  ImportToken = raw,
  EncryptedKeyMaterial = raw,
  ValidTo = as.POSIXct(
    "2015-01-01"
  ),
  ExpirationModel = "KEY_MATERIAL_EXPIRES"|"KEY_MATERIAL_DOES_NOT_EXPIRE"
)

Examples

if (FALSE) {
# The following example imports key material into the specified CMK.
svc$import_key_material(
  EncryptedKeyMaterial = "",
  ExpirationModel = "KEY_MATERIAL_DOES_NOT_EXPIRE",
  ImportToken = "",
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
}