paws.security.identity (version 0.1.12)

kms_get_parameters_for_import: Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK)

Description

Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS 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 import_key_material request.

You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's 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 CMK or on any CMK in a different AWS 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 get_parameters_for_import response. You cannot use an expired token in an import_key_material request. If your key and token expire, send another get_parameters_for_import request.

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:GetParametersForImport (key policy)

Related operations:

• import_key_material

• delete_imported_key_material

Usage

kms_get_parameters_for_import(KeyId, WrappingAlgorithm, WrappingKeySpec)

Value

A list with the following syntax:

list(
  KeyId = "string",
  ImportToken = raw,
  PublicKey = raw,
  ParametersValidTo = as.POSIXct(
    "2015-01-01"
  )
)

Arguments

KeyId

[required] The identifier of the symmetric CMK into which you will import key material. The Origin of the CMK must be EXTERNAL.

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.

WrappingAlgorithm

[required] The algorithm you will use to encrypt the key material before importing it with import_key_material. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

WrappingKeySpec

[required] The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Request syntax

svc$get_parameters_for_import(
  KeyId = "string",
  WrappingAlgorithm = "RSAES_PKCS1_V1_5"|"RSAES_OAEP_SHA_1"|"RSAES_OAEP_SHA_256",
  WrappingKeySpec = "RSA_2048"
)

Examples

if (FALSE) {
# The following example retrieves the public key and import token for the
# specified CMK.
svc$get_parameters_for_import(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
  WrappingAlgorithm = "RSAES_OAEP_SHA_1",
  WrappingKeySpec = "RSA_2048"
)
}