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 symmetric, asymmetric, or DUKPT data encryption key.
Type annotations and code completion for boto3.client("payment-cryptography-data").decrypt_data
method.
boto3 documentation
# decrypt_data method definition
def decrypt_data(
self,
*,
CipherText: str,
DecryptionAttributes: EncryptionDecryptionAttributesTypeDef, # (1)
KeyIdentifier: str,
) -> DecryptDataOutputTypeDef: # (2)
...
# decrypt_data method usage example with argument unpacking
kwargs: DecryptDataInputRequestTypeDef = { # (1)
"CipherText": ...,
"DecryptionAttributes": ...,
"KeyIdentifier": ...,
}
parent.decrypt_data(**kwargs)
encrypt_data#
Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key.
Type annotations and code completion for boto3.client("payment-cryptography-data").encrypt_data
method.
boto3 documentation
# encrypt_data method definition
def encrypt_data(
self,
*,
EncryptionAttributes: EncryptionDecryptionAttributesTypeDef, # (1)
KeyIdentifier: str,
PlainText: str,
) -> EncryptDataOutputTypeDef: # (2)
...
# encrypt_data method usage example with argument unpacking
kwargs: EncryptDataInputRequestTypeDef = { # (1)
"EncryptionAttributes": ...,
"KeyIdentifier": ...,
"PlainText": ...,
}
parent.encrypt_data(**kwargs)
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,
*,
GenerationAttributes: CardGenerationAttributesTypeDef, # (1)
KeyIdentifier: str,
PrimaryAccountNumber: str,
ValidationDataLength: int = ...,
) -> GenerateCardValidationDataOutputTypeDef: # (2)
...
# generate_card_validation_data method usage example with argument unpacking
kwargs: GenerateCardValidationDataInputRequestTypeDef = { # (1)
"GenerationAttributes": ...,
"KeyIdentifier": ...,
"PrimaryAccountNumber": ...,
}
parent.generate_card_validation_data(**kwargs)
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,
*,
GenerationAttributes: MacAttributesTypeDef, # (1)
KeyIdentifier: str,
MessageData: str,
MacLength: int = ...,
) -> GenerateMacOutputTypeDef: # (2)
...
# generate_mac method usage example with argument unpacking
kwargs: GenerateMacInputRequestTypeDef = { # (1)
"GenerationAttributes": ...,
"KeyIdentifier": ...,
"MessageData": ...,
}
parent.generate_mac(**kwargs)
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,
*,
EncryptionKeyIdentifier: str,
GenerationAttributes: PinGenerationAttributesTypeDef, # (1)
GenerationKeyIdentifier: str,
PinBlockFormat: PinBlockFormatForPinDataType, # (2)
PrimaryAccountNumber: str,
PinDataLength: int = ...,
) -> GeneratePinDataOutputTypeDef: # (3)
...
- See PinGenerationAttributesTypeDef
- See PinBlockFormatForPinDataType
- See GeneratePinDataOutputTypeDef
# generate_pin_data method usage example with argument unpacking
kwargs: GeneratePinDataInputRequestTypeDef = { # (1)
"EncryptionKeyIdentifier": ...,
"GenerationAttributes": ...,
"GenerationKeyIdentifier": ...,
"PinBlockFormat": ...,
"PrimaryAccountNumber": ...,
}
parent.generate_pin_data(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
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:
...
re_encrypt_data#
Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric 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,
*,
CipherText: str,
IncomingEncryptionAttributes: ReEncryptionAttributesTypeDef, # (1)
IncomingKeyIdentifier: str,
OutgoingEncryptionAttributes: ReEncryptionAttributesTypeDef, # (1)
OutgoingKeyIdentifier: str,
) -> ReEncryptDataOutputTypeDef: # (3)
...
# re_encrypt_data method usage example with argument unpacking
kwargs: ReEncryptDataInputRequestTypeDef = { # (1)
"CipherText": ...,
"IncomingEncryptionAttributes": ...,
"IncomingKeyIdentifier": ...,
"OutgoingEncryptionAttributes": ...,
"OutgoingKeyIdentifier": ...,
}
parent.re_encrypt_data(**kwargs)
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,
*,
EncryptedPinBlock: str,
IncomingKeyIdentifier: str,
IncomingTranslationAttributes: TranslationIsoFormatsTypeDef, # (1)
OutgoingKeyIdentifier: str,
OutgoingTranslationAttributes: TranslationIsoFormatsTypeDef, # (1)
IncomingDukptAttributes: DukptDerivationAttributesTypeDef = ..., # (3)
OutgoingDukptAttributes: DukptDerivationAttributesTypeDef = ..., # (3)
) -> TranslatePinDataOutputTypeDef: # (5)
...
- See TranslationIsoFormatsTypeDef
- See TranslationIsoFormatsTypeDef
- See DukptDerivationAttributesTypeDef
- See DukptDerivationAttributesTypeDef
- See TranslatePinDataOutputTypeDef
# translate_pin_data method usage example with argument unpacking
kwargs: TranslatePinDataInputRequestTypeDef = { # (1)
"EncryptedPinBlock": ...,
"IncomingKeyIdentifier": ...,
"IncomingTranslationAttributes": ...,
"OutgoingKeyIdentifier": ...,
"OutgoingTranslationAttributes": ...,
}
parent.translate_pin_data(**kwargs)
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,
*,
AuthRequestCryptogram: str,
KeyIdentifier: str,
MajorKeyDerivationMode: MajorKeyDerivationModeType, # (1)
SessionKeyDerivationAttributes: SessionKeyDerivationTypeDef, # (2)
TransactionData: str,
AuthResponseAttributes: CryptogramAuthResponseTypeDef = ..., # (3)
) -> VerifyAuthRequestCryptogramOutputTypeDef: # (4)
...
- See MajorKeyDerivationModeType
- See SessionKeyDerivationTypeDef
- See CryptogramAuthResponseTypeDef
- See VerifyAuthRequestCryptogramOutputTypeDef
# verify_auth_request_cryptogram method usage example with argument unpacking
kwargs: VerifyAuthRequestCryptogramInputRequestTypeDef = { # (1)
"AuthRequestCryptogram": ...,
"KeyIdentifier": ...,
"MajorKeyDerivationMode": ...,
"SessionKeyDerivationAttributes": ...,
"TransactionData": ...,
}
parent.verify_auth_request_cryptogram(**kwargs)
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,
ValidationData: str,
VerificationAttributes: CardVerificationAttributesTypeDef, # (1)
) -> VerifyCardValidationDataOutputTypeDef: # (2)
...
# verify_card_validation_data method usage example with argument unpacking
kwargs: VerifyCardValidationDataInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
"PrimaryAccountNumber": ...,
"ValidationData": ...,
"VerificationAttributes": ...,
}
parent.verify_card_validation_data(**kwargs)
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,
Mac: str,
MessageData: str,
VerificationAttributes: MacAttributesTypeDef, # (1)
MacLength: int = ...,
) -> VerifyMacOutputTypeDef: # (2)
...
# verify_mac method usage example with argument unpacking
kwargs: VerifyMacInputRequestTypeDef = { # (1)
"KeyIdentifier": ...,
"Mac": ...,
"MessageData": ...,
"VerificationAttributes": ...,
}
parent.verify_mac(**kwargs)
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,
*,
EncryptedPinBlock: str,
EncryptionKeyIdentifier: str,
PinBlockFormat: PinBlockFormatForPinDataType, # (1)
PrimaryAccountNumber: str,
VerificationAttributes: PinVerificationAttributesTypeDef, # (2)
VerificationKeyIdentifier: str,
DukptAttributes: DukptAttributesTypeDef = ..., # (3)
PinDataLength: int = ...,
) -> VerifyPinDataOutputTypeDef: # (4)
...
- See PinBlockFormatForPinDataType
- See PinVerificationAttributesTypeDef
- See DukptAttributesTypeDef
- See VerifyPinDataOutputTypeDef
# verify_pin_data method usage example with argument unpacking
kwargs: VerifyPinDataInputRequestTypeDef = { # (1)
"EncryptedPinBlock": ...,
"EncryptionKeyIdentifier": ...,
"PinBlockFormat": ...,
"PrimaryAccountNumber": ...,
"VerificationAttributes": ...,
"VerificationKeyIdentifier": ...,
}
parent.verify_pin_data(**kwargs)