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 Data TranslateKeyMaterial API operation.

Syntax

Convert-PAYCDKeyMaterial
-KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
-DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm <SymmetricKeyAlgorithm>
-DiffieHellmanTr31KeyBlock_KeyDerivationFunction <KeyDerivationFunction>
-DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
-DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier <String>
-DiffieHellmanTr31KeyBlock_PublicKeyCertificate <String>
-DerivationData_SharedInformation <String>
-DiffieHellmanTr31KeyBlock_WrappedKeyBlock <String>
-Tr31KeyBlock_WrappingKeyIdentifier <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

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:

Parameters

-ClientConfig <AmazonPaymentCryptographyDataConfig>
Amazon.PowerShell.Cmdlets.PAYCD.AmazonPaymentCryptographyDataClientCmdlet.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)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_DerivationData_SharedInformation
-DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier <String>
The keyArn of the certificate that signed the client's PublicKeyCertificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_CertificateAuthorityPublicKeyIdentifier
-DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm <SymmetricKeyAlgorithm>
The key algorithm of the derived ECDH key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_DeriveKeyAlgorithm
-DiffieHellmanTr31KeyBlock_KeyDerivationFunction <KeyDerivationFunction>
The key derivation function to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_KeyDerivationFunction
-DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
The hash type to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_KeyDerivationHashAlgorithm
-DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier <String>
The keyARN of the asymmetric ECC key pair.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_PrivateKeyIdentifier
-DiffieHellmanTr31KeyBlock_PublicKeyCertificate <String>
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_PublicKeyCertificate
-DiffieHellmanTr31KeyBlock_WrappedKeyBlock <String>
The WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIncomingKeyMaterial_DiffieHellmanTr31KeyBlock_WrappedKeyBlock
-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)
-KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
The key check value (KCV) algorithm used for calculating the KCV.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KeyCheckValueAlgorithm parameter. The -PassThru parameter is deprecated, use -Select '^KeyCheckValueAlgorithm' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.PaymentCryptographyData.Model.TranslateKeyMaterialResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.TranslateKeyMaterialResponse 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 KEK used to wrap the transaction key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOutgoingKeyMaterial_Tr31KeyBlock_WrappingKeyIdentifier

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.PaymentCryptographyData.Model.WrappedWorkingKey or Amazon.PaymentCryptographyData.Model.TranslateKeyMaterialResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.WrappedWorkingKey object. The service call response (type Amazon.PaymentCryptographyData.Model.TranslateKeyMaterialResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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