AWS CLI Command Reference

[ aws . payment-cryptography-data ]

translate-key-material

Description

Translates an encryption key between different wrapping keys without importing the key into Amazon Web Services Payment Cryptography.

This operation can be used when key material is frequently rotated, such as during every card transaction, and there is a need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. It translates short-lived transaction keys such as Pin Encryption Key (PEK) generated for each transaction and wrapped with an ECDH (Elliptic Curve Diffie-Hellman) derived wrapping key to another KEK (Key Encryption Key) wrapping key.

Before using this operation, you must first request the public key certificate of the ECC key pair generated within Amazon Web Services Payment Cryptography to establish an ECDH key agreement. In TranslateKeyData , the service uses its own ECC key pair, public certificate of receiving ECC key pair, and the key derivation parameters to generate a derived key. The service uses this derived key to unwrap the incoming transaction key received as a TR31WrappedKeyBlock and re-wrap using a user provided KEK to generate an outgoing Tr31WrappedKeyBlock. For more information on establishing ECDH derived keys, see the Creating keys in the Amazon Web Services Payment Cryptography User Guide .

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide .

Cross-account use : This operation can’t be used across different Amazon Web Services accounts.

Related operations:

See also: AWS API Documentation

Synopsis

  translate-key-material
--incoming-key-material <value>
--outgoing-key-material <value>
[--key-check-value-algorithm <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--incoming-key-material (tagged union structure) [required]

Parameter information of the TR31WrappedKeyBlock containing the transaction key.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DiffieHellmanTr31KeyBlock.

DiffieHellmanTr31KeyBlock -> (structure)

Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.

PrivateKeyIdentifier -> (string) [required]

The keyARN of the asymmetric ECC key pair.

Constraints:

  • min: 7
  • max: 322
  • pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

CertificateAuthorityPublicKeyIdentifier -> (string) [required]

The keyArn of the certificate that signed the client’s PublicKeyCertificate .

Constraints:

  • min: 7
  • max: 322
  • pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

PublicKeyCertificate -> (string) [required]

The client’s public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.

Constraints:

  • min: 1
  • max: 32768
  • pattern: [^\[;\]<>]+

DeriveKeyAlgorithm -> (string) [required]

The key algorithm of the derived ECDH key.

Possible values:

  • TDES_2KEY
  • TDES_3KEY
  • AES_128
  • AES_192
  • AES_256
  • HMAC_SHA256
  • HMAC_SHA384
  • HMAC_SHA512
  • HMAC_SHA224

KeyDerivationFunction -> (string) [required]

The key derivation function to use for deriving a key using ECDH.

Possible values:

  • NIST_SP800
  • ANSI_X963

KeyDerivationHashAlgorithm -> (string) [required]

The hash type to use for deriving a key using ECDH.

Possible values:

  • SHA_256
  • SHA_384
  • SHA_512

DerivationData -> (tagged union structure) [required]

The shared information used when deriving a key using ECDH.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: SharedInformation.

SharedInformation -> (string)

A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

Constraints:

  • min: 2
  • max: 2048
  • pattern: (?:[0-9a-fA-F][0-9a-fA-F])+

WrappedKeyBlock -> (string) [required]

The WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.

Constraints:

  • min: 56
  • max: 9984
  • pattern: [0-9a-zA-Z]+

Shorthand Syntax:

DiffieHellmanTr31KeyBlock={PrivateKeyIdentifier=string,CertificateAuthorityPublicKeyIdentifier=string,PublicKeyCertificate=string,DeriveKeyAlgorithm=string,KeyDerivationFunction=string,KeyDerivationHashAlgorithm=string,DerivationData={SharedInformation=string},WrappedKeyBlock=string}

JSON Syntax:

{
  "DiffieHellmanTr31KeyBlock": {
    "PrivateKeyIdentifier": "string",
    "CertificateAuthorityPublicKeyIdentifier": "string",
    "PublicKeyCertificate": "string",
    "DeriveKeyAlgorithm": "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"HMAC_SHA256"|"HMAC_SHA384"|"HMAC_SHA512"|"HMAC_SHA224",
    "KeyDerivationFunction": "NIST_SP800"|"ANSI_X963",
    "KeyDerivationHashAlgorithm": "SHA_256"|"SHA_384"|"SHA_512",
    "DerivationData": {
      "SharedInformation": "string"
    },
    "WrappedKeyBlock": "string"
  }
}

--outgoing-key-material (tagged union structure) [required]

Parameter information of the wrapping key used to wrap the transaction key in the outgoing TR31WrappedKeyBlock.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Tr31KeyBlock.

Tr31KeyBlock -> (structure)

Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using a KEK.

WrappingKeyIdentifier -> (string) [required]

The keyARN of the KEK used to wrap the transaction key.

Constraints:

  • min: 7
  • max: 322
  • pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

Shorthand Syntax:

Tr31KeyBlock={WrappingKeyIdentifier=string}

JSON Syntax:

{
  "Tr31KeyBlock": {
    "WrappingKeyIdentifier": "string"
  }
}

--key-check-value-algorithm (string)

The key check value (KCV) algorithm used for calculating the KCV.

Possible values:

  • CMAC
  • ANSI_X9_24
  • HMAC
  • SHA_1

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

WrappedKey -> (structure)

The outgoing KEK wrapped TR31WrappedKeyBlock.

WrappedKeyMaterial -> (string) [required]

The wrapped key block of the outgoing transaction key.

Constraints:

  • min: 48
  • max: 16384

KeyCheckValue -> (string) [required]

The key check value (KCV) of the key contained within the outgoing TR31WrappedKeyBlock.

The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. For more information on KCV, see KCV in the Amazon Web Services Payment Cryptography User Guide .

Constraints:

  • min: 4
  • max: 16
  • pattern: [0-9a-fA-F]+

WrappedKeyMaterialFormat -> (string) [required]

The key block format of the wrapped key.

Possible values:

  • KEY_CRYPTOGRAM
  • TR31_KEY_BLOCK
  • TR34_KEY_BLOCK
© Copyright 2025, Amazon Web Services. Created using Sphinx.