Import Key Material
kms_import_key_material | R Documentation |
Imports or reimports key material into an existing KMS key that was created without key material¶
Description¶
Imports or reimports key material into an existing KMS key that was
created without key material. import_key_material
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.
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 import_key_material
or using the import
features
of the KMS console.
Before calling import_key_material
:
-
Create or identify a KMS key with no key material. The KMS key must have an
Origin
value ofEXTERNAL
, which indicates that the KMS key is designed for imported key material.To create an new KMS key for imported key material, call the
create_key
operation with anOrigin
value ofEXTERNAL
. 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
describe_key
operation to verify that theKeyState
of the KMS key isPendingImport
, 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
delete_imported_key_material
to delete its existing key material. -
Call the
get_parameters_for_import
operation to get a public key and import token set for importing key material. -
Use the public key in the
get_parameters_for_import
response to encrypt your key material.
Then, in an import_key_material
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 beEXTERNAL
and itsKeyState
must bePendingImport
. 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 theOrigin
andKeyState
of a KMS key, calldescribe_key
. -
The encrypted key material.
-
The import token that
get_parameters_for_import
returned. You must use a public key and token from the sameget_parameters_for_import
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 get_parameters_for_import
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:
-
delete_imported_key_material
-
get_parameters_for_import
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Usage¶
Arguments¶
KeyId
[required] The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the
KeyID
parameter of the correspondingget_parameters_for_import
request. TheOrigin
of the KMS key must beEXTERNAL
and itsKeyState
must bePendingImport
.The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. 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.
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
list_keys
ordescribe_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 under the public wrapping key that
get_parameters_for_import
returned, using the wrapping algorithm that you specified in the sameget_parameters_for_import
request.ValidTo
The date and time when the imported key material expires. This parameter is required when the value of the
ExpirationModel
parameter isKEY_MATERIAL_EXPIRES
. Otherwise it is not valid.The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must delete (delete_imported_key_material
) and reimport the key material.ExpirationModel
Specifies whether the key material expires. The default is
KEY_MATERIAL_EXPIRES
. For help with this choice, see Setting an expiration time in the Key Management Service Developer Guide.When the value of
ExpirationModel
isKEY_MATERIAL_EXPIRES
, you must specify a value for theValidTo
parameter. When value isKEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit theValidTo
parameter.You cannot change the
ExpirationModel
orValidTo
values for the current import after the request completes. To change either value, you must reimport the key material.
Value¶
An empty list.
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¶
## Not run:
# The following example imports key material into the specified KMS key.
svc$import_key_material(
EncryptedKeyMaterial = "<binary data>",
ExpirationModel = "KEY_MATERIAL_DOES_NOT_EXPIRE",
ImportToken = "<binary data>",
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)
# 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.
svc$import_key_material(
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"
)
## End(Not run)