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

Syntax

New-PAYCDMac
-KeyIdentifier <String>
-GenerationAttributes_Algorithm <MacAlgorithm>
-SessionKeyDerivationValue_ApplicationCryptogram <String>
-SessionKeyDerivationValue_ApplicationTransactionCounter <String>
-DukptCmac_DukptDerivationType <DukptDerivationType>
-DukptIso9797Algorithm1_DukptDerivationType <DukptDerivationType>
-DukptIso9797Algorithm3_DukptDerivationType <DukptDerivationType>
-DukptCmac_DukptKeyVariant <DukptKeyVariant>
-DukptIso9797Algorithm1_DukptKeyVariant <DukptKeyVariant>
-DukptIso9797Algorithm3_DukptKeyVariant <DukptKeyVariant>
-DukptCmac_KeySerialNumber <String>
-DukptIso9797Algorithm1_KeySerialNumber <String>
-DukptIso9797Algorithm3_KeySerialNumber <String>
-MacLength <Int32>
-EmvMac_MajorKeyDerivationMode <MajorKeyDerivationMode>
-MessageData <String>
-EmvMac_PanSequenceNumber <String>
-EmvMac_PrimaryAccountNumber <String>
-EmvMac_SessionKeyDerivationMode <SessionKeyDerivationMode>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

Description

Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography. You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision. You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify. 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)
-DukptCmac_DukptDerivationType <DukptDerivationType>
The key type derived 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)
AliasesGenerationAttributes_DukptCmac_DukptDerivationType
-DukptCmac_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_DukptCmac_DukptKeyVariant
-DukptCmac_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)
AliasesGenerationAttributes_DukptCmac_KeySerialNumber
-DukptIso9797Algorithm1_DukptDerivationType <DukptDerivationType>
The key type derived 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)
AliasesGenerationAttributes_DukptIso9797Algorithm1_DukptDerivationType
-DukptIso9797Algorithm1_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_DukptIso9797Algorithm1_DukptKeyVariant
-DukptIso9797Algorithm1_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)
AliasesGenerationAttributes_DukptIso9797Algorithm1_KeySerialNumber
-DukptIso9797Algorithm3_DukptDerivationType <DukptDerivationType>
The key type derived 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)
AliasesGenerationAttributes_DukptIso9797Algorithm3_DukptDerivationType
-DukptIso9797Algorithm3_DukptKeyVariant <DukptKeyVariant>
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_DukptIso9797Algorithm3_DukptKeyVariant
-DukptIso9797Algorithm3_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)
AliasesGenerationAttributes_DukptIso9797Algorithm3_KeySerialNumber
-EmvMac_MajorKeyDerivationMode <MajorKeyDerivationMode>
The method to use when deriving the master key for EMV MAC generation or verification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_MajorKeyDerivationMode
-EmvMac_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_PanSequenceNumber
-EmvMac_PrimaryAccountNumber <String>
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_PrimaryAccountNumber
-EmvMac_SessionKeyDerivationMode <SessionKeyDerivationMode>
The method of deriving a session key for EMV MAC generation or verification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_SessionKeyDerivationMode
-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)
-GenerationAttributes_Algorithm <MacAlgorithm>
The encryption algorithm for MAC generation or verification.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyIdentifier <String>
The keyARN of the MAC generation encryption key.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MacLength <Int32>
The length of a MAC under generation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MessageData <String>
The data for which a MAC is under generation. This value must be hexBinary.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KeyIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^KeyIdentifier' 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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptographyData.Model.GenerateMacResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.GenerateMacResponse 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)
-SessionKeyDerivationValue_ApplicationCryptogram <String>
The cryptogram provided by the terminal during transaction processing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_SessionKeyDerivationValue_ApplicationCryptogram
-SessionKeyDerivationValue_ApplicationTransactionCounter <String>
The transaction counter that is provided by the terminal during transaction processing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGenerationAttributes_EmvMac_SessionKeyDerivationValue_ApplicationTransactionCounter

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.GenerateMacResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.GenerateMacResponse 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