AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
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:
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginImportKeyMaterial and EndImportKeyMaterial.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual Task<ImportKeyMaterialResponse> ImportKeyMaterialAsync( ImportKeyMaterialRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ImportKeyMaterial service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. You can retry the request. |
| ExpiredImportTokenException | 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. |
| IncorrectKeyMaterialException | 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. |
| InvalidArnException | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| InvalidCiphertextException | 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. |
| InvalidImportTokenException | The request was rejected because the provided import token is invalid or is associated with a different KMS key. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | 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. |
| NotFoundException | The request was rejected because the specified entity or resource could not be found. |
| UnsupportedOperationException | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer