AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Payment Cryptography Control Plane ExportKey API operation.

Syntax

Export-PAYCCKey
-ExportKeyIdentifier <String>
-DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
-KeyCryptogram_CertificateAuthorityPublicKeyIdentifier <String>
-Tr34KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt <Boolean>
-KeyModesOfUse_Decrypt <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt <Boolean>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey <Boolean>
-KeyModesOfUse_DeriveKey <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey <Boolean>
-DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm <SymmetricKeyAlgorithm>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt <Boolean>
-KeyModesOfUse_Encrypt <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt <Boolean>
-Tr34KeyBlock_ExportToken <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate <Boolean>
-KeyModesOfUse_Generate <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate <Boolean>
-Tr34KeyBlock_KeyBlockFormat <Tr34KeyBlockFormat>
-ExportAttributes_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-DiffieHellmanTr31KeyBlock_KeyDerivationFunction <KeyDerivationFunction>
-DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyExportability <KeyExportability>
-KeyBlockHeaders_KeyExportability <KeyExportability>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyExportability <KeyExportability>
-ExportDukptInitialKey_KeySerialNumber <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyVersion <String>
-KeyBlockHeaders_KeyVersion <String>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyVersion <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions <Boolean>
-KeyModesOfUse_NoRestriction <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions <Boolean>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_OptionalBlocks <Hashtable>
-KeyBlockHeaders_OptionalBlock <Hashtable>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_OptionalBlocks <Hashtable>
-DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier <String>
-DiffieHellmanTr31KeyBlock_PublicKeyCertificate <String>
-Tr34KeyBlock_RandomNonce <String>
-DerivationData_SharedInformation <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign <Boolean>
-KeyModesOfUse_Sign <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign <Boolean>
-Tr34KeyBlock_SigningKeyCertificate <String>
-Tr34KeyBlock_SigningKeyIdentifier <String>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap <Boolean>
-KeyModesOfUse_Unwrap <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap <Boolean>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify <Boolean>
-KeyModesOfUse_Verify <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify <Boolean>
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap <Boolean>
-KeyModesOfUse_Wrap <Boolean>
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap <Boolean>
-KeyCryptogram_WrappingKeyCertificate <String>
-Tr34KeyBlock_WrappingKeyCertificate <String>
-Tr31KeyBlock_WrappingKeyIdentifier <String>
-KeyCryptogram_WrappingSpec <WrappingKeySpec>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyConfig>

Description

Exports a key from Amazon Web Services Payment Cryptography. Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography. PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see Importing and exporting keys in the Amazon Web Services Payment Cryptography User Guide. You can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export. For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography. The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022. Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type. To export initial keys (KEK) or IPEK using TR-34 Using this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key. To initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 30 days. Next the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide. Set the following parameters:
  • ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
  • ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
  • KeyMaterial: Use Tr34KeyBlock parameters.
  • CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
  • ExportToken: Obtained from KDH by calling GetParametersForImport.
  • WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock. To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap Using this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. Next call ExportKey and set the following parameters:
  • CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
  • KeyMaterial: Set to KeyCryptogram.
  • WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram. To export working keys or IPEK using TR-31 Using this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. Set the following parameters:
  • ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
  • ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
  • KeyMaterial: Use Tr31KeyBlock parameters.
To export working keys using ECDH You can also use ECDH key agreement to export working keys in a TR-31 keyblock, where the wrapping key is an ECDH derived key. To initiate a TR-31 key export using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling CreateKey. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ImportKey with input RootCertificatePublicKey for root CA or TrustedPublicKey for intermediate CA. You can then complete a TR-31 key export by deriving a shared wrapping key using the service ECC key pair, public certificate of your ECC key pair outside of Amazon Web Services Payment Cryptography, and the key derivation parameters including key derivation function, hash algorithm, derivation data, key algorithm.
  • KeyMaterial: Use DiffieHellmanTr31KeyBlock parameters.
  • PrivateKeyIdentifier: The KeyArn of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.
  • PublicKeyCertificate: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.
  • CertificateAuthorityPublicKeyIdentifier: The keyARN of the CA that signed the public key certificate of the receiving ECC key pair.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key as a TR-31 WrappedKeyBlock, where the wrapping key is the ECDH derived key. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations:

Parameters

-ClientConfig <AmazonPaymentCryptographyConfig>
Amazon.PowerShell.Cmdlets.PAYCC.AmazonPaymentCryptographyClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DerivationData_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_DerivationData_SharedInformation
-DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier
-DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm <SymmetricKeyAlgorithm>
The key algorithm of the shared derived ECDH key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm
-DiffieHellmanTr31KeyBlock_KeyDerivationFunction <KeyDerivationFunction>
The key derivation function to use when deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_KeyDerivationFunction
-DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
The hash type to use when deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm
-DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier <String>
The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier
-DiffieHellmanTr31KeyBlock_PublicKeyCertificate <String>
The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_DiffieHellmanTr31KeyBlock_PublicKeyCertificate
-ExportAttributes_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only.For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExportDukptInitialKey_KeySerialNumber <String>
The KSN for IPEK generation using DUKPT. KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExportAttributes_ExportDukptInitialKey_KeySerialNumber
-ExportKeyIdentifier <String>
The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyBlockHeaders_KeyExportability <KeyExportability>
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyExportability
-KeyBlockHeaders_KeyVersion <String>
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyVersion
-KeyBlockHeaders_OptionalBlock <Hashtable>
Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_OptionalBlocks
-KeyCryptogram_CertificateAuthorityPublicKeyIdentifier <String>
The KeyARN of the certificate chain that signs the wrapping key certificate during RSA wrap and unwrap key export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_KeyCryptogram_CertificateAuthorityPublicKeyIdentifier
-KeyCryptogram_WrappingKeyCertificate <String>
The wrapping key certificate in PEM format (base64 encoded). Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_KeyCryptogram_WrappingKeyCertificate
-KeyCryptogram_WrappingSpec <WrappingKeySpec>
The wrapping spec for the key under export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_KeyCryptogram_WrappingSpec
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyExportability <KeyExportability>
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyExportability
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyVersion <String>
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_KeyVersion
-KeyMaterial_DiffieHellmanTr31KeyBlock_KeyBlockHeaders_OptionalBlocks <Hashtable>
Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDiffieHellmanTr31KeyBlock_KeyBlockHeaders_OptionalBlocks
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyExportability <KeyExportability>
Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyExportability
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_KeyVersion <String>
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_KeyVersion
-KeyMaterial_Tr34KeyBlock_KeyBlockHeaders_OptionalBlocks <Hashtable>
Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTr34KeyBlock_KeyBlockHeaders_OptionalBlocks
-KeyModesOfUse_Decrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Decrypt
-KeyModesOfUse_DeriveKey <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_DeriveKey
-KeyModesOfUse_Encrypt <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Encrypt
-KeyModesOfUse_Generate <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Generate
-KeyModesOfUse_NoRestriction <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_NoRestrictions
-KeyModesOfUse_Sign <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Sign
-KeyModesOfUse_Unwrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Unwrap
-KeyModesOfUse_Verify <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Verify
-KeyModesOfUse_Wrap <Boolean>
Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_KeyBlockHeaders_KeyModesOfUse_Wrap
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'WrappedKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptography.Model.ExportKeyResponse). Specifying the name of a property of type Amazon.PaymentCryptography.Model.ExportKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tr31KeyBlock_WrappingKeyIdentifier <String>
The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr31KeyBlock_WrappingKeyIdentifier
-Tr34KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_CertificateAuthorityPublicKeyIdentifier
-Tr34KeyBlock_ExportToken <String>
The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 30 days. You can use the same export token to export multiple keys from the same service account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_ExportToken
-Tr34KeyBlock_KeyBlockFormat <Tr34KeyBlockFormat>
The format of key block that Amazon Web Services Payment Cryptography will use during key export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_KeyBlockFormat
-Tr34KeyBlock_RandomNonce <String>
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_RandomNonce
-Tr34KeyBlock_SigningKeyCertificate <String>
The certificate used to sign the TR-34 key block.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_SigningKeyCertificate
-Tr34KeyBlock_SigningKeyIdentifier <String>
Key Identifier used for signing the export key
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_SigningKeyIdentifier
-Tr34KeyBlock_WrappingKeyCertificate <String>
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesKeyMaterial_Tr34KeyBlock_WrappingKeyCertificate

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PaymentCryptography.Model.WrappedKey or Amazon.PaymentCryptography.Model.ExportKeyResponse
This cmdlet returns an Amazon.PaymentCryptography.Model.WrappedKey object. The service call response (type Amazon.PaymentCryptography.Model.ExportKeyResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z