Skip to content

PaymentCryptographyDataPlaneClient#

Index > PaymentCryptographyDataPlane > PaymentCryptographyDataPlaneClient

Auto-generated documentation for PaymentCryptographyDataPlane type annotations stubs module mypy-boto3-payment-cryptography-data.

PaymentCryptographyDataPlaneClient#

Type annotations and code completion for boto3.client("payment-cryptography-data"). boto3 documentation

# PaymentCryptographyDataPlaneClient usage example

from boto3.session import Session
from mypy_boto3_payment_cryptography_data.client import PaymentCryptographyDataPlaneClient

def get_payment-cryptography-data_client() -> PaymentCryptographyDataPlaneClient:
    return Session().client("payment-cryptography-data")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("payment-cryptography-data").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("payment-cryptography-data")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
    client.exceptions.VerificationFailedException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_payment_cryptography_data.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("payment-cryptography-data").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("payment-cryptography-data").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

decrypt_data#

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme.

Type annotations and code completion for boto3.client("payment-cryptography-data").decrypt_data method. boto3 documentation

# decrypt_data method definition

def decrypt_data(
    self,
    *,
    KeyIdentifier: str,
    CipherText: str,
    DecryptionAttributes: EncryptionDecryptionAttributesTypeDef,  # (1)
    WrappedKey: WrappedKeyTypeDef = ...,  # (2)
) -> DecryptDataOutputTypeDef:  # (3)
    ...
  1. See EncryptionDecryptionAttributesTypeDef
  2. See WrappedKeyTypeDef
  3. See DecryptDataOutputTypeDef
# decrypt_data method usage example with argument unpacking

kwargs: DecryptDataInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "CipherText": ...,
    "DecryptionAttributes": ...,
}

parent.decrypt_data(**kwargs)
  1. See DecryptDataInputTypeDef

encrypt_data#

Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme.

Type annotations and code completion for boto3.client("payment-cryptography-data").encrypt_data method. boto3 documentation

# encrypt_data method definition

def encrypt_data(
    self,
    *,
    KeyIdentifier: str,
    PlainText: str,
    EncryptionAttributes: EncryptionDecryptionAttributesTypeDef,  # (1)
    WrappedKey: WrappedKeyTypeDef = ...,  # (2)
) -> EncryptDataOutputTypeDef:  # (3)
    ...
  1. See EncryptionDecryptionAttributesTypeDef
  2. See WrappedKeyTypeDef
  3. See EncryptDataOutputTypeDef
# encrypt_data method usage example with argument unpacking

kwargs: EncryptDataInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "PlainText": ...,
    "EncryptionAttributes": ...,
}

parent.encrypt_data(**kwargs)
  1. See EncryptDataInputTypeDef

generate_card_validation_data#

Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).

Type annotations and code completion for boto3.client("payment-cryptography-data").generate_card_validation_data method. boto3 documentation

# generate_card_validation_data method definition

def generate_card_validation_data(
    self,
    *,
    KeyIdentifier: str,
    PrimaryAccountNumber: str,
    GenerationAttributes: CardGenerationAttributesTypeDef,  # (1)
    ValidationDataLength: int = ...,
) -> GenerateCardValidationDataOutputTypeDef:  # (2)
    ...
  1. See CardGenerationAttributesTypeDef
  2. See GenerateCardValidationDataOutputTypeDef
# generate_card_validation_data method usage example with argument unpacking

kwargs: GenerateCardValidationDataInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "PrimaryAccountNumber": ...,
    "GenerationAttributes": ...,
}

parent.generate_card_validation_data(**kwargs)
  1. See GenerateCardValidationDataInputTypeDef

generate_mac#

Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.

Type annotations and code completion for boto3.client("payment-cryptography-data").generate_mac method. boto3 documentation

# generate_mac method definition

def generate_mac(
    self,
    *,
    KeyIdentifier: str,
    MessageData: str,
    GenerationAttributes: MacAttributesTypeDef,  # (1)
    MacLength: int = ...,
) -> GenerateMacOutputTypeDef:  # (2)
    ...
  1. See MacAttributesTypeDef
  2. See GenerateMacOutputTypeDef
# generate_mac method usage example with argument unpacking

kwargs: GenerateMacInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "MessageData": ...,
    "GenerationAttributes": ...,
}

parent.generate_mac(**kwargs)
  1. See GenerateMacInputTypeDef

generate_mac_emv_pin_change#

Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM).

Type annotations and code completion for boto3.client("payment-cryptography-data").generate_mac_emv_pin_change method. boto3 documentation

# generate_mac_emv_pin_change method definition

def generate_mac_emv_pin_change(
    self,
    *,
    NewPinPekIdentifier: str,
    NewEncryptedPinBlock: str,
    PinBlockFormat: PinBlockFormatForEmvPinChangeType,  # (1)
    SecureMessagingIntegrityKeyIdentifier: str,
    SecureMessagingConfidentialityKeyIdentifier: str,
    MessageData: str,
    DerivationMethodAttributes: DerivationMethodAttributesTypeDef,  # (2)
) -> GenerateMacEmvPinChangeOutputTypeDef:  # (3)
    ...
  1. See PinBlockFormatForEmvPinChangeType
  2. See DerivationMethodAttributesTypeDef
  3. See GenerateMacEmvPinChangeOutputTypeDef
# generate_mac_emv_pin_change method usage example with argument unpacking

kwargs: GenerateMacEmvPinChangeInputTypeDef = {  # (1)
    "NewPinPekIdentifier": ...,
    "NewEncryptedPinBlock": ...,
    "PinBlockFormat": ...,
    "SecureMessagingIntegrityKeyIdentifier": ...,
    "SecureMessagingConfidentialityKeyIdentifier": ...,
    "MessageData": ...,
    "DerivationMethodAttributes": ...,
}

parent.generate_mac_emv_pin_change(**kwargs)
  1. See GenerateMacEmvPinChangeInputTypeDef

generate_pin_data#

Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance.

Type annotations and code completion for boto3.client("payment-cryptography-data").generate_pin_data method. boto3 documentation

# generate_pin_data method definition

def generate_pin_data(
    self,
    *,
    GenerationKeyIdentifier: str,
    EncryptionKeyIdentifier: str,
    GenerationAttributes: PinGenerationAttributesTypeDef,  # (1)
    PrimaryAccountNumber: str,
    PinBlockFormat: PinBlockFormatForPinDataType,  # (2)
    PinDataLength: int = ...,
    EncryptionWrappedKey: WrappedKeyTypeDef = ...,  # (3)
) -> GeneratePinDataOutputTypeDef:  # (4)
    ...
  1. See PinGenerationAttributesTypeDef
  2. See PinBlockFormatForPinDataType
  3. See WrappedKeyTypeDef
  4. See GeneratePinDataOutputTypeDef
# generate_pin_data method usage example with argument unpacking

kwargs: GeneratePinDataInputTypeDef = {  # (1)
    "GenerationKeyIdentifier": ...,
    "EncryptionKeyIdentifier": ...,
    "GenerationAttributes": ...,
    "PrimaryAccountNumber": ...,
    "PinBlockFormat": ...,
}

parent.generate_pin_data(**kwargs)
  1. See GeneratePinDataInputTypeDef

re_encrypt_data#

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.

Type annotations and code completion for boto3.client("payment-cryptography-data").re_encrypt_data method. boto3 documentation

# re_encrypt_data method definition

def re_encrypt_data(
    self,
    *,
    IncomingKeyIdentifier: str,
    OutgoingKeyIdentifier: str,
    CipherText: str,
    IncomingEncryptionAttributes: ReEncryptionAttributesTypeDef,  # (1)
    OutgoingEncryptionAttributes: ReEncryptionAttributesTypeDef,  # (1)
    IncomingWrappedKey: WrappedKeyTypeDef = ...,  # (3)
    OutgoingWrappedKey: WrappedKeyTypeDef = ...,  # (3)
) -> ReEncryptDataOutputTypeDef:  # (5)
    ...
  1. See ReEncryptionAttributesTypeDef
  2. See ReEncryptionAttributesTypeDef
  3. See WrappedKeyTypeDef
  4. See WrappedKeyTypeDef
  5. See ReEncryptDataOutputTypeDef
# re_encrypt_data method usage example with argument unpacking

kwargs: ReEncryptDataInputTypeDef = {  # (1)
    "IncomingKeyIdentifier": ...,
    "OutgoingKeyIdentifier": ...,
    "CipherText": ...,
    "IncomingEncryptionAttributes": ...,
    "OutgoingEncryptionAttributes": ...,
}

parent.re_encrypt_data(**kwargs)
  1. See ReEncryptDataInputTypeDef

translate_pin_data#

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4.

Type annotations and code completion for boto3.client("payment-cryptography-data").translate_pin_data method. boto3 documentation

# translate_pin_data method definition

def translate_pin_data(
    self,
    *,
    IncomingKeyIdentifier: str,
    OutgoingKeyIdentifier: str,
    IncomingTranslationAttributes: TranslationIsoFormatsTypeDef,  # (1)
    OutgoingTranslationAttributes: TranslationIsoFormatsTypeDef,  # (1)
    EncryptedPinBlock: str,
    IncomingDukptAttributes: DukptDerivationAttributesTypeDef = ...,  # (3)
    OutgoingDukptAttributes: DukptDerivationAttributesTypeDef = ...,  # (3)
    IncomingWrappedKey: WrappedKeyTypeDef = ...,  # (5)
    OutgoingWrappedKey: WrappedKeyTypeDef = ...,  # (5)
) -> TranslatePinDataOutputTypeDef:  # (7)
    ...
  1. See TranslationIsoFormatsTypeDef
  2. See TranslationIsoFormatsTypeDef
  3. See DukptDerivationAttributesTypeDef
  4. See DukptDerivationAttributesTypeDef
  5. See WrappedKeyTypeDef
  6. See WrappedKeyTypeDef
  7. See TranslatePinDataOutputTypeDef
# translate_pin_data method usage example with argument unpacking

kwargs: TranslatePinDataInputTypeDef = {  # (1)
    "IncomingKeyIdentifier": ...,
    "OutgoingKeyIdentifier": ...,
    "IncomingTranslationAttributes": ...,
    "OutgoingTranslationAttributes": ...,
    "EncryptedPinBlock": ...,
}

parent.translate_pin_data(**kwargs)
  1. See TranslatePinDataInputTypeDef

verify_auth_request_cryptogram#

Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization.

Type annotations and code completion for boto3.client("payment-cryptography-data").verify_auth_request_cryptogram method. boto3 documentation

# verify_auth_request_cryptogram method definition

def verify_auth_request_cryptogram(
    self,
    *,
    KeyIdentifier: str,
    TransactionData: str,
    AuthRequestCryptogram: str,
    MajorKeyDerivationMode: MajorKeyDerivationModeType,  # (1)
    SessionKeyDerivationAttributes: SessionKeyDerivationTypeDef,  # (2)
    AuthResponseAttributes: CryptogramAuthResponseTypeDef = ...,  # (3)
) -> VerifyAuthRequestCryptogramOutputTypeDef:  # (4)
    ...
  1. See MajorKeyDerivationModeType
  2. See SessionKeyDerivationTypeDef
  3. See CryptogramAuthResponseTypeDef
  4. See VerifyAuthRequestCryptogramOutputTypeDef
# verify_auth_request_cryptogram method usage example with argument unpacking

kwargs: VerifyAuthRequestCryptogramInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "TransactionData": ...,
    "AuthRequestCryptogram": ...,
    "MajorKeyDerivationMode": ...,
    "SessionKeyDerivationAttributes": ...,
}

parent.verify_auth_request_cryptogram(**kwargs)
  1. See VerifyAuthRequestCryptogramInputTypeDef

verify_card_validation_data#

Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC).

Type annotations and code completion for boto3.client("payment-cryptography-data").verify_card_validation_data method. boto3 documentation

# verify_card_validation_data method definition

def verify_card_validation_data(
    self,
    *,
    KeyIdentifier: str,
    PrimaryAccountNumber: str,
    VerificationAttributes: CardVerificationAttributesTypeDef,  # (1)
    ValidationData: str,
) -> VerifyCardValidationDataOutputTypeDef:  # (2)
    ...
  1. See CardVerificationAttributesTypeDef
  2. See VerifyCardValidationDataOutputTypeDef
# verify_card_validation_data method usage example with argument unpacking

kwargs: VerifyCardValidationDataInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "PrimaryAccountNumber": ...,
    "VerificationAttributes": ...,
    "ValidationData": ...,
}

parent.verify_card_validation_data(**kwargs)
  1. See VerifyCardValidationDataInputTypeDef

verify_mac#

Verifies a Message Authentication Code (MAC).

Type annotations and code completion for boto3.client("payment-cryptography-data").verify_mac method. boto3 documentation

# verify_mac method definition

def verify_mac(
    self,
    *,
    KeyIdentifier: str,
    MessageData: str,
    Mac: str,
    VerificationAttributes: MacAttributesTypeDef,  # (1)
    MacLength: int = ...,
) -> VerifyMacOutputTypeDef:  # (2)
    ...
  1. See MacAttributesTypeDef
  2. See VerifyMacOutputTypeDef
# verify_mac method usage example with argument unpacking

kwargs: VerifyMacInputTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "MessageData": ...,
    "Mac": ...,
    "VerificationAttributes": ...,
}

parent.verify_mac(**kwargs)
  1. See VerifyMacInputTypeDef

verify_pin_data#

Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624.

Type annotations and code completion for boto3.client("payment-cryptography-data").verify_pin_data method. boto3 documentation

# verify_pin_data method definition

def verify_pin_data(
    self,
    *,
    VerificationKeyIdentifier: str,
    EncryptionKeyIdentifier: str,
    VerificationAttributes: PinVerificationAttributesTypeDef,  # (1)
    EncryptedPinBlock: str,
    PrimaryAccountNumber: str,
    PinBlockFormat: PinBlockFormatForPinDataType,  # (2)
    PinDataLength: int = ...,
    DukptAttributes: DukptAttributesTypeDef = ...,  # (3)
    EncryptionWrappedKey: WrappedKeyTypeDef = ...,  # (4)
) -> VerifyPinDataOutputTypeDef:  # (5)
    ...
  1. See PinVerificationAttributesTypeDef
  2. See PinBlockFormatForPinDataType
  3. See DukptAttributesTypeDef
  4. See WrappedKeyTypeDef
  5. See VerifyPinDataOutputTypeDef
# verify_pin_data method usage example with argument unpacking

kwargs: VerifyPinDataInputTypeDef = {  # (1)
    "VerificationKeyIdentifier": ...,
    "EncryptionKeyIdentifier": ...,
    "VerificationAttributes": ...,
    "EncryptedPinBlock": ...,
    "PrimaryAccountNumber": ...,
    "PinBlockFormat": ...,
}

parent.verify_pin_data(**kwargs)
  1. See VerifyPinDataInputTypeDef