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 ReEncryptData API operation.

Syntax

Update-PAYCDEncryptData
-CipherText <String>
-IncomingEncryptionAttributes_Dukpt_DukptKeyDerivationType <DukptDerivationType>
-OutgoingEncryptionAttributes_Dukpt_DukptKeyDerivationType <DukptDerivationType>
-IncomingEncryptionAttributes_Dukpt_DukptKeyVariant <DukptKeyVariant>
-OutgoingEncryptionAttributes_Dukpt_DukptKeyVariant <DukptKeyVariant>
-IncomingKeyIdentifier <String>
-IncomingEncryptionAttributes_Dukpt_InitializationVector <String>
-IncomingEncryptionAttributes_Symmetric_InitializationVector <String>
-OutgoingEncryptionAttributes_Dukpt_InitializationVector <String>
-OutgoingEncryptionAttributes_Symmetric_InitializationVector <String>
-IncomingWrappedKey_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-OutgoingWrappedKey_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-IncomingEncryptionAttributes_Dukpt_KeySerialNumber <String>
-OutgoingEncryptionAttributes_Dukpt_KeySerialNumber <String>
-IncomingEncryptionAttributes_Dukpt_Mode <DukptEncryptionMode>
-IncomingEncryptionAttributes_Symmetric_Mode <EncryptionMode>
-OutgoingEncryptionAttributes_Dukpt_Mode <DukptEncryptionMode>
-OutgoingEncryptionAttributes_Symmetric_Mode <EncryptionMode>
-OutgoingKeyIdentifier <String>
-IncomingEncryptionAttributes_Symmetric_PaddingType <PaddingType>
-OutgoingEncryptionAttributes_Symmetric_PaddingType <PaddingType>
-IncomingWrappedKey_WrappedKeyMaterial_Tr31KeyBlock <String>
-OutgoingWrappedKey_WrappedKeyMaterial_Tr31KeyBlock <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

Description

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys. You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt. For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey. 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

-CipherText <String>
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonPaymentCryptographyDataConfig>
Amazon.PowerShell.Cmdlets.PAYCD.AmazonPaymentCryptographyDataClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (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)
-IncomingEncryptionAttributes_Dukpt_DukptKeyDerivationType <DukptDerivationType>
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Dukpt_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Dukpt_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Dukpt_KeySerialNumber <String>
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Dukpt_Mode <DukptEncryptionMode>
The block cipher method to use for encryption.The default is CBC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Symmetric_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Symmetric_Mode <EncryptionMode>
The block cipher method to use for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingEncryptionAttributes_Symmetric_PaddingType <PaddingType>
The padding to be included with the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingKeyIdentifier <String>
The keyARN of the encryption key of incoming ciphertext data.When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-IncomingWrappedKey_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.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)
-IncomingWrappedKey_WrappedKeyMaterial_Tr31KeyBlock <String>
The TR-31 wrapped key block.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Dukpt_DukptKeyDerivationType <DukptDerivationType>
The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Dukpt_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Dukpt_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Dukpt_KeySerialNumber <String>
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Dukpt_Mode <DukptEncryptionMode>
The block cipher method to use for encryption.The default is CBC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Symmetric_InitializationVector <String>
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Symmetric_Mode <EncryptionMode>
The block cipher method to use for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingEncryptionAttributes_Symmetric_PaddingType <PaddingType>
The padding to be included with the data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingKeyIdentifier <String>
The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutgoingWrappedKey_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.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)
-OutgoingWrappedKey_WrappedKeyMaterial_Tr31KeyBlock <String>
The TR-31 wrapped key block.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptographyData.Model.ReEncryptDataResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.ReEncryptDataResponse 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)

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.ReEncryptDataResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.ReEncryptDataResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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