Struct aws_sdk_paymentcryptographydata::Client

pub struct Client { /* private fields */ }

Client for Payment Cryptography Data Plane

Client for invoking operations on Payment Cryptography Data Plane. Each operation on Payment Cryptography Data Plane is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_paymentcryptographydata::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_paymentcryptographydata::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DecryptData operation has a Client::decrypt_data, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.decrypt_data()
    .key_identifier("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn decrypt_data(&self) -> DecryptDataFluentBuilder

Constructs a fluent builder for the DecryptData operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.

  • cipher_text(impl Into<String>) / set_cipher_text(Option<String>):

    The ciphertext to decrypt.

  • decryption_attributes(EncryptionDecryptionAttributes) / set_decryption_attributes(Option<EncryptionDecryptionAttributes>):

    The encryption key type and attributes for ciphertext decryption.

• On success, responds with DecryptDataOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • plain_text(Option<String>):

    The decrypted plaintext data.

• On failure, responds with SdkError<DecryptDataError>

impl Client

pub fn encrypt_data(&self) -> EncryptDataFluentBuilder

Constructs a fluent builder for the EncryptData operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

  • plain_text(impl Into<String>) / set_plain_text(Option<String>):

    The plaintext to be encrypted.

  • encryption_attributes(EncryptionDecryptionAttributes) / set_encryption_attributes(Option<EncryptionDecryptionAttributes>):

    The encryption key type and attributes for plaintext encryption.

• On success, responds with EncryptDataOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • cipher_text(Option<String>):

    The encrypted ciphertext.

• On failure, responds with SdkError<EncryptDataError>

impl Client

pub fn generate_card_validation_data( &self ) -> GenerateCardValidationDataFluentBuilder

Constructs a fluent builder for the GenerateCardValidationData operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.

  • primary_account_number(impl Into<String>) / set_primary_account_number(Option<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.

  • generation_attributes(CardGenerationAttributes) / set_generation_attributes(Option<CardGenerationAttributes>):

    The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.

  • validation_data_length(i32) / set_validation_data_length(Option<i32>):

    The length of the CVV or CSC to be generated. The default value is 3.

• On success, responds with GenerateCardValidationDataOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • validation_data(Option<String>):

    The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.

• On failure, responds with SdkError<GenerateCardValidationDataError>

impl Client

pub fn generate_mac(&self) -> GenerateMacFluentBuilder

Constructs a fluent builder for the GenerateMac operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the MAC generation encryption key.

  • message_data(impl Into<String>) / set_message_data(Option<String>):

    The data for which a MAC is under generation.

  • generation_attributes(MacAttributes) / set_generation_attributes(Option<MacAttributes>):

    The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.

  • mac_length(i32) / set_mac_length(Option<i32>):

    The length of a MAC under generation.

• On success, responds with GenerateMacOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • mac(Option<String>):

    The MAC cryptogram generated within Amazon Web Services Payment Cryptography.

• On failure, responds with SdkError<GenerateMacError>

impl Client

pub fn generate_pin_data(&self) -> GeneratePinDataFluentBuilder

Constructs a fluent builder for the GeneratePinData operation.

• The fluent builder is configurable:
  • generation_key_identifier(impl Into<String>) / set_generation_key_identifier(Option<String>):

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.

  • encryption_key_identifier(impl Into<String>) / set_encryption_key_identifier(Option<String>):

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.

  • generation_attributes(PinGenerationAttributes) / set_generation_attributes(Option<PinGenerationAttributes>):

    The attributes and values to use for PIN, PVV, or PIN Offset generation.

  • pin_data_length(i32) / set_pin_data_length(Option<i32>):

    The length of PIN under generation.

  • primary_account_number(impl Into<String>) / set_primary_account_number(Option<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.

  • pin_block_format(PinBlockFormatForPinData) / set_pin_block_format(Option<PinBlockFormatForPinData>):

    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

    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.

• On success, responds with GeneratePinDataOutput with field(s):
  • generation_key_arn(Option<String>):

    The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.

  • generation_key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • encryption_key_arn(Option<String>):

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.

  • encryption_key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • encrypted_pin_block(Option<String>):

    The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.

  • pin_data(Option<PinData>):

    The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.

• On failure, responds with SdkError<GeneratePinDataError>

impl Client

pub fn re_encrypt_data(&self) -> ReEncryptDataFluentBuilder

Constructs a fluent builder for the ReEncryptData operation.

• The fluent builder is configurable:
  • incoming_key_identifier(impl Into<String>) / set_incoming_key_identifier(Option<String>):

    The keyARN of the encryption key of incoming ciphertext data.

  • outgoing_key_identifier(impl Into<String>) / set_outgoing_key_identifier(Option<String>):

    The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

  • cipher_text(impl Into<String>) / set_cipher_text(Option<String>):

    Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.

  • incoming_encryption_attributes(ReEncryptionAttributes) / set_incoming_encryption_attributes(Option<ReEncryptionAttributes>):

    The attributes and values for incoming ciphertext.

  • outgoing_encryption_attributes(ReEncryptionAttributes) / set_outgoing_encryption_attributes(Option<ReEncryptionAttributes>):

    The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

• On success, responds with ReEncryptDataOutput with field(s):
  • key_arn(Option<String>):

    The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • cipher_text(Option<String>):

    The encrypted ciphertext.

• On failure, responds with SdkError<ReEncryptDataError>

impl Client

pub fn translate_pin_data(&self) -> TranslatePinDataFluentBuilder

Constructs a fluent builder for the TranslatePinData operation.

• The fluent builder is configurable:
  • incoming_key_identifier(impl Into<String>) / set_incoming_key_identifier(Option<String>):

    The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.

  • outgoing_key_identifier(impl Into<String>) / set_outgoing_key_identifier(Option<String>):

    The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.

  • incoming_translation_attributes(TranslationIsoFormats) / set_incoming_translation_attributes(Option<TranslationIsoFormats>):

    The format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.

  • outgoing_translation_attributes(TranslationIsoFormats) / set_outgoing_translation_attributes(Option<TranslationIsoFormats>):

    The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.

  • encrypted_pin_block(impl Into<String>) / set_encrypted_pin_block(Option<String>):

    The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.

  • incoming_dukpt_attributes(DukptDerivationAttributes) / set_incoming_dukpt_attributes(Option<DukptDerivationAttributes>):

    The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.

  • outgoing_dukpt_attributes(DukptDerivationAttributes) / set_outgoing_dukpt_attributes(Option<DukptDerivationAttributes>):

    The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.

• On success, responds with TranslatePinDataOutput with field(s):
  • pin_block(Option<String>):

    The ougoing encrypted PIN block data after tranlation.

  • key_arn(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

• On failure, responds with SdkError<TranslatePinDataError>

impl Client

pub fn verify_auth_request_cryptogram( &self ) -> VerifyAuthRequestCryptogramFluentBuilder

Constructs a fluent builder for the VerifyAuthRequestCryptogram operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.

  • transaction_data(impl Into<String>) / set_transaction_data(Option<String>):

    The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • auth_request_cryptogram(impl Into<String>) / set_auth_request_cryptogram(Option<String>):

    The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.

  • major_key_derivation_mode(MajorKeyDerivationMode) / set_major_key_derivation_mode(Option<MajorKeyDerivationMode>):

    The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • session_key_derivation_attributes(SessionKeyDerivation) / set_session_key_derivation_attributes(Option<SessionKeyDerivation>):

    The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.

  • auth_response_attributes(CryptogramAuthResponse) / set_auth_response_attributes(Option<CryptogramAuthResponse>):

    The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.

• On success, responds with VerifyAuthRequestCryptogramOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • auth_response_value(Option<String>):

    The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.

• On failure, responds with SdkError<VerifyAuthRequestCryptogramError>

impl Client

pub fn verify_card_validation_data( &self ) -> VerifyCardValidationDataFluentBuilder

Constructs a fluent builder for the VerifyCardValidationData operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.

  • primary_account_number(impl Into<String>) / set_primary_account_number(Option<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.

  • verification_attributes(CardVerificationAttributes) / set_verification_attributes(Option<CardVerificationAttributes>):

    The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.

  • validation_data(impl Into<String>) / set_validation_data(Option<String>):

    The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.

• On success, responds with VerifyCardValidationDataOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

• On failure, responds with SdkError<VerifyCardValidationDataError>

impl Client

pub fn verify_mac(&self) -> VerifyMacFluentBuilder

Constructs a fluent builder for the VerifyMac operation.

• The fluent builder is configurable:
  • key_identifier(impl Into<String>) / set_key_identifier(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.

  • message_data(impl Into<String>) / set_message_data(Option<String>):

    The data on for which MAC is under verification.

  • mac(impl Into<String>) / set_mac(Option<String>):

    The MAC being verified.

  • verification_attributes(MacAttributes) / set_verification_attributes(Option<MacAttributes>):

    The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.

  • mac_length(i32) / set_mac_length(Option<i32>):

    The length of the MAC.

• On success, responds with VerifyMacOutput with field(s):
  • key_arn(Option<String>):

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.

  • key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

• On failure, responds with SdkError<VerifyMacError>

impl Client

pub fn verify_pin_data(&self) -> VerifyPinDataFluentBuilder

Constructs a fluent builder for the VerifyPinData operation.

• The fluent builder is configurable:
  • verification_key_identifier(impl Into<String>) / set_verification_key_identifier(Option<String>):

    The keyARN of the PIN verification key.

  • encryption_key_identifier(impl Into<String>) / set_encryption_key_identifier(Option<String>):

    The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.

  • verification_attributes(PinVerificationAttributes) / set_verification_attributes(Option<PinVerificationAttributes>):

    The attributes and values for PIN data verification.

  • encrypted_pin_block(impl Into<String>) / set_encrypted_pin_block(Option<String>):

    The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.

  • primary_account_number(impl Into<String>) / set_primary_account_number(Option<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.

  • pin_block_format(PinBlockFormatForPinData) / set_pin_block_format(Option<PinBlockFormatForPinData>):

    The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

    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.

  • pin_data_length(i32) / set_pin_data_length(Option<i32>):

    The length of PIN being verified.

  • dukpt_attributes(DukptAttributes) / set_dukpt_attributes(Option<DukptAttributes>):

    The attributes and values for the DUKPT encrypted PIN block data.

• On success, responds with VerifyPinDataOutput with field(s):
  • verification_key_arn(Option<String>):

    The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.

  • verification_key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

  • encryption_key_arn(Option<String>):

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.

  • encryption_key_check_value(Option<String>):

    The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

• On failure, responds with SdkError<VerifyPinDataError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.