Skip to content

Get Parameters For Export

paymentcryptographycontrolplane_get_parameters_for_export R Documentation

Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography

Description

Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.

The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling export_key. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.

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

Related operations:

  • export_key

  • get_parameters_for_import

Usage

paymentcryptographycontrolplane_get_parameters_for_export(
  KeyMaterialType, SigningKeyAlgorithm)

Arguments

KeyMaterialType

[required] The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.

SigningKeyAlgorithm

[required] The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is the only signing key algorithm allowed.

Value

A list with the following syntax: 

list(
  SigningKeyCertificate = "string",
  SigningKeyCertificateChain = "string",
  SigningKeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096",
  ExportToken = "string",
  ParametersValidUntilTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_parameters_for_export(
  KeyMaterialType = "TR34_KEY_BLOCK"|"TR31_KEY_BLOCK"|"ROOT_PUBLIC_KEY_CERTIFICATE"|"TRUSTED_PUBLIC_KEY_CERTIFICATE"|"KEY_CRYPTOGRAM",
  SigningKeyAlgorithm = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256"|"RSA_2048"|"RSA_3072"|"RSA_4096"
)