Container for the parameters to the GetParametersForImport operation. Returns the items you need to import key material into a symmetric encryption KMS key. For more information about importing key material into KMS, see Importing key material in the Key Management Service Developer Guide.
This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
You must specify the key ID of the symmetric encryption KMS key into which you will
import key material. The KMS key Origin must be EXTERNAL.
You must also specify the wrapping algorithm and type of wrapping key (public key)
that you will use to encrypt the key material. You cannot perform this operation on
an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web
Services account.
To import key material, you must use the public key and import token from the same
response. These items are valid for 24 hours. The expiration date and time appear
in the GetParametersForImport response. You cannot use an expired token
in an ImportKeyMaterial request. If your key and token expire, send another
GetParametersForImport request.
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:
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.GetParametersForImportRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class GetParametersForImportRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The GetParametersForImportRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetParametersForImportRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId.
The identifier of the symmetric encryption KMS key into which you will import key
material. The 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. |
|
|
WrappingAlgorithm | Amazon.KeyManagementService.AlgorithmSpec |
Gets and sets the property WrappingAlgorithm. The algorithm you will use to encrypt the key material before using the ImportKeyMaterial operation to import it. For more information, see Encrypt the key material in the Key Management Service Developer Guide.
The |
|
|
WrappingKeySpec | Amazon.KeyManagementService.WrappingKeySpec |
Gets and sets the property WrappingKeySpec. The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported. |
Examples
The following example retrieves the public key and import token for the specified KMS key.
To retrieve the public key and import token for a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.GetParametersForImport(new GetParametersForImportRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
WrappingAlgorithm = "RSAES_OAEP_SHA_1", // The algorithm that you will use to encrypt the key material before importing it.
WrappingKeySpec = "RSA_2048" // The type of wrapping key (public key) to return in the response.
});
MemoryStream importToken = response.ImportToken; // The import token to send with a subsequent ImportKeyMaterial request.
string keyId = response.KeyId; // The ARN of the KMS key for which you are retrieving the public key and import token. This is the same KMS key specified in the request.
DateTime parametersValidTo = response.ParametersValidTo; // The time at which the import token and public key are no longer valid.
MemoryStream publicKey = response.PublicKey; // The public key to use to encrypt the key material before importing it.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5