- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetParametersForImportCommand
Returns the public key and an import token you need to import or reimport key material for a KMS key.
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.
Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for 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 . You can also use GetParametersForImport to get a public key and import token to reimport the original key material into a KMS key whose key material expired or was deleted.
GetParametersForImport returns the items that you need to import your key material.
-
The public key (or "wrapping key") of an RSA key pair that KMS generates.
You will use this public key to encrypt ("wrap") your key material while it's in transit to KMS.
-
A import token that ensures that KMS can decrypt your key material and associate it with the correct KMS key.
The public key and its import token are permanently linked and must be used together. Each public key and import token set is valid for 24 hours. The expiration date and time appear in the ParametersValidTo field in the GetParametersForImport response. You cannot use an expired public key or import token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.
GetParametersForImport requires the following information:
-
The key ID of the KMS key for which you are importing the key material.
-
The key spec of the public key ("wrapping key") that you will use to encrypt your key material during import.
-
The wrapping algorithm that you will use with the public key to encrypt your key material.
You can use the same or a different public key spec and wrapping algorithm each time you import or reimport the same key material.
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:GetParametersForImport (key policy)
Related operations:
-
ImportKeyMaterial
-
DeleteImportedKeyMaterial
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KMSClient, GetParametersForImportCommand } from "@aws-sdk/client-kms"; // ES Modules import
// const { KMSClient, GetParametersForImportCommand } = require("@aws-sdk/client-kms"); // CommonJS import
const client = new KMSClient(config);
const input = { // GetParametersForImportRequest
KeyId: "STRING_VALUE", // required
WrappingAlgorithm: "RSAES_PKCS1_V1_5" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "RSA_AES_KEY_WRAP_SHA_1" || "RSA_AES_KEY_WRAP_SHA_256" || "SM2PKE", // required
WrappingKeySpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "SM2", // required
};
const command = new GetParametersForImportCommand(input);
const response = await client.send(command);
// { // GetParametersForImportResponse
// KeyId: "STRING_VALUE",
// ImportToken: new Uint8Array(),
// PublicKey: new Uint8Array(),
// ParametersValidTo: new Date("TIMESTAMP"),
// };
GetParametersForImportCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
KeyIdRequired | string | undefined | The identifier of the KMS key that will be associated with the imported key material. The All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS key in a custom key store. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
WrappingAlgorithmRequired | AlgorithmSpec | undefined | The algorithm you will use with the RSA public key ( For RSA_AES wrapping algorithms, you encrypt your key material with an AES key that you generate, then encrypt your AES key with the RSA public key from KMS. For RSAES wrapping algorithms, you encrypt your key material directly with the RSA public key from KMS. The wrapping algorithms that you can use depend on the type of key material that you are importing. To import an RSA private key, you must use an RSA_AES wrapping algorithm.
|
WrappingKeySpecRequired | WrappingKeySpec | undefined | The type of RSA public key to return in the response. You will use this wrapping key with the specified wrapping algorithm to protect your key material during import. Use the longest RSA wrapping key that is practical. You cannot use an RSA_2048 public key to directly wrap an ECC_NIST_P521 private key. Instead, use an RSA_AES wrapping algorithm or choose a longer RSA public key. |
GetParametersForImportCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
ImportToken | Uint8Array | undefined | The import token to send in a subsequent ImportKeyMaterial request. |
KeyId | string | undefined | The Amazon Resource Name (key ARN ) of the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the |
ParametersValidTo | Date | undefined | The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another |
PublicKey | Uint8Array | undefined | The public key to use to encrypt the key material before importing it with ImportKeyMaterial. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| DependencyTimeoutException | server | The system timed out while trying to fulfill the request. You can retry the request. |
| InvalidArnException | client | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| KMSInternalException | server | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | client | The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following:
|
| NotFoundException | client | The request was rejected because the specified entity or resource could not be found. |
| UnsupportedOperationException | client | The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. |
| KMSServiceException | Base exception class for all service exceptions from KMS service. |