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#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: DecryptDataInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "CipherText": ...,
    "DecryptionAttributes": ...,
}

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

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: EncryptDataInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "PlainText": ...,
    "EncryptionAttributes": ...,
}

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

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: GenerateCardValidationDataInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "PrimaryAccountNumber": ...,
    "GenerationAttributes": ...,
}

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

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: GenerateMacInputRequestTypeDef = {  # (1)
    "KeyIdentifier": ...,
    "MessageData": ...,
    "GenerationAttributes": ...,
}

parent.generate_mac(**kwargs)
  1. See