KMS / Client / get_parameters_for_import

get_parameters_for_import#

KMS.Client.get_parameters_for_import(**kwargs)#

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:

  • ImportKeyMaterial

  • DeleteImportedKeyMaterial

See also: AWS API Documentation

Request Syntax

response = client.get_parameters_for_import(
    KeyId='string',
    WrappingAlgorithm='RSAES_PKCS1_V1_5'|'RSAES_OAEP_SHA_1'|'RSAES_OAEP_SHA_256',
    WrappingKeySpec='RSA_2048'
)
Parameters:

  • KeyId (string) –

    [REQUIRED]

    The identifier of the symmetric encryption KMS key into which you will import key material. The Origin of the KMS key must be EXTERNAL.

    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 ListKeys or DescribeKey.

  • WrappingAlgorithm (string) –

    [REQUIRED]

    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.

    Warning

    The RSAES_PKCS1_V1_5 wrapping algorithm is deprecated. We recommend that you begin using a different wrapping algorithm immediately. KMS will end support for RSAES_PKCS1_V1_5 by October 1, 2023 pursuant to cryptographic key management guidance from the National Institute of Standards and Technology (NIST).

  • WrappingKeySpec (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'KeyId': 'string',
    'ImportToken': b'bytes',
    'PublicKey': b'bytes',
    'ParametersValidTo': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • KeyId (string) –

      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 GetParametersForImport request.

    • ImportToken (bytes) –

      The import token to send in a subsequent ImportKeyMaterial request.

    • PublicKey (bytes) –

      The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

    • ParametersValidTo (datetime) –

      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 GetParametersForImport request to get new ones.

Exceptions

  • KMS.Client.exceptions.InvalidArnException

  • KMS.Client.exceptions.UnsupportedOperationException

  • KMS.Client.exceptions.DependencyTimeoutException

  • KMS.Client.exceptions.NotFoundException

  • KMS.Client.exceptions.KMSInternalException

  • KMS.Client.exceptions.KMSInvalidStateException

Examples

The following example retrieves the public key and import token for the specified KMS key.

response = client.get_parameters_for_import(
    # 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.
    KeyId='1234abcd-12ab-34cd-56ef-1234567890ab',
    # The algorithm that you will use to encrypt the key material before importing it.
    WrappingAlgorithm='RSAES_OAEP_SHA_1',
    # The type of wrapping key (public key) to return in the response.
    WrappingKeySpec='RSA_2048',
)

print(response)

Expected Output:

{
    # The import token to send with a subsequent ImportKeyMaterial request.
    'ImportToken': '<binary data>',
    # 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.
    'KeyId': 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
    # The time at which the import token and public key are no longer valid.
    'ParametersValidTo': datetime(2016, 12, 1, 14, 52, 17, 3, 336, 0),
    # The public key to use to encrypt the key material before importing it.
    'PublicKey': '<binary data>',
    'ResponseMetadata': {
        '...': '...',
    },
}