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

Syntax

New-PAYCDPinData
-GenerationKeyIdentifier <String>
-DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier <String>
-Ibm3624NaturalPin_DecimalizationTable <String>
-Ibm3624PinFromOffset_DecimalizationTable <String>
-Ibm3624PinOffset_DecimalizationTable <String>
-Ibm3624RandomPin_DecimalizationTable <String>
-Ibm3624PinOffset_EncryptedPinBlock <String>
-VisaPinVerificationValue_EncryptedPinBlock <String>
-EncryptionKeyIdentifier <String>
-DiffieHellmanSymmetricKey_KeyAlgorithm <SymmetricKeyAlgorithm>
-EncryptionWrappedKey_KeyCheckValueAlgorithm <KeyCheckValueAlgorithm>
-DiffieHellmanSymmetricKey_KeyDerivationFunction <KeyDerivationFunction>
-DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
-PinBlockFormat <PinBlockFormatForPinData>
-PinDataLength <Int32>
-Ibm3624PinFromOffset_PinOffset <String>
-Ibm3624NaturalPin_PinValidationData <String>
-Ibm3624PinFromOffset_PinValidationData <String>
-Ibm3624PinOffset_PinValidationData <String>
-Ibm3624RandomPin_PinValidationData <String>
-Ibm3624NaturalPin_PinValidationDataPadCharacter <String>
-Ibm3624PinFromOffset_PinValidationDataPadCharacter <String>
-Ibm3624PinOffset_PinValidationDataPadCharacter <String>
-Ibm3624RandomPin_PinValidationDataPadCharacter <String>
-VisaPin_PinVerificationKeyIndex <Int32>
-VisaPinVerificationValue_PinVerificationKeyIndex <Int32>
-PrimaryAccountNumber <String>
-DiffieHellmanSymmetricKey_PublicKeyCertificate <String>
-DiffieHellmanSymmetricKey_SharedInformation <String>
-WrappedKeyMaterial_Tr31KeyBlock <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

Description

Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide. PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation. Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block. You can also use it for reveal PIN, wherein the generated PIN block is protected by the ECDH derived key before transmission from Amazon Web Services Payment Cryptography. For more information on establishing ECDH derived keys, see the Generating 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)
-DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier <String>
The keyArn of the certificate that signed the client's PublicKeyCertificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_CertificateAuthorityPublicKeyIdentifier
-DiffieHellmanSymmetricKey_KeyAlgorithm <SymmetricKeyAlgorithm>
The key algorithm of the derived ECDH key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyAlgorithm
-DiffieHellmanSymmetricKey_KeyDerivationFunction <KeyDerivationFunction>
The key derivation function to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyDerivationFunction
-DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm <KeyDerivationHashAlgorithm>
The hash type to use for deriving a key using ECDH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_KeyDerivationHashAlgorithm
-DiffieHellmanSymmetricKey_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)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_PublicKeyCertificate
-DiffieHellmanSymmetricKey_SharedInformation <String>
A byte 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, and re-using shared information for multiple ECDH key derivations is not recommended.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_DiffieHellmanSymmetricKey_SharedInformation
-EncryptionKeyIdentifier <String>
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionWrappedKey_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)
-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)
-GenerationKeyIdentifier <String>
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Ibm3624NaturalPin_DecimalizationTable <String>
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624NaturalPin_DecimalizationTable
-Ibm3624NaturalPin_PinValidationData <String>
The unique data for cardholder identification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624NaturalPin_PinValidationData
-Ibm3624NaturalPin_PinValidationDataPadCharacter <String>
The padding character for validation data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624NaturalPin_PinValidationDataPadCharacter
-Ibm3624PinFromOffset_DecimalizationTable <String>
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinFromOffset_DecimalizationTable
-Ibm3624PinFromOffset_PinOffset <String>
The PIN offset value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinFromOffset_PinOffset
-Ibm3624PinFromOffset_PinValidationData <String>
The unique data for cardholder identification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinFromOffset_PinValidationData
-Ibm3624PinFromOffset_PinValidationDataPadCharacter <String>
The padding character for validation data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinFromOffset_PinValidationDataPadCharacter
-Ibm3624PinOffset_DecimalizationTable <String>
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinOffset_DecimalizationTable
-Ibm3624PinOffset_EncryptedPinBlock <String>
The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinOffset_EncryptedPinBlock
-Ibm3624PinOffset_PinValidationData <String>
The unique data for cardholder identification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinOffset_PinValidationData
-Ibm3624PinOffset_PinValidationDataPadCharacter <String>
The padding character for validation data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624PinOffset_PinValidationDataPadCharacter
-Ibm3624RandomPin_DecimalizationTable <String>
The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624RandomPin_DecimalizationTable
-Ibm3624RandomPin_PinValidationData <String>
The unique data for cardholder identification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624RandomPin_PinValidationData
-Ibm3624RandomPin_PinValidationDataPadCharacter <String>
The padding character for validation data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_Ibm3624RandomPin_PinValidationDataPadCharacter
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the GenerationKeyIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^GenerationKeyIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PinBlockFormat <PinBlockFormatForPinData>
The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0, ISO_Format_3 and ISO_Format_4.The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.The ISO_Format_4 PIN block format is the only one supporting AES encryption.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PinDataLength <Int32>
The length of PIN under generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrimaryAccountNumber <String>
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
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.GeneratePinDataResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.GeneratePinDataResponse 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)
-VisaPin_PinVerificationKeyIndex <Int32>
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_VisaPin_PinVerificationKeyIndex
-VisaPinVerificationValue_EncryptedPinBlock <String>
The encrypted PIN block data to verify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_VisaPinVerificationValue_EncryptedPinBlock
-VisaPinVerificationValue_PinVerificationKeyIndex <Int32>
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_VisaPinVerificationValue_PinVerificationKeyIndex
-WrappedKeyMaterial_Tr31KeyBlock <String>
The TR-31 wrapped key block.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionWrappedKey_WrappedKeyMaterial_Tr31KeyBlock

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.GeneratePinDataResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.GeneratePinDataResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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