aws_sdk_paymentcryptographydata/operation/verify_pin_data/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::verify_pin_data::_verify_pin_data_output::VerifyPinDataOutputBuilder;
3
4pub use crate::operation::verify_pin_data::_verify_pin_data_input::VerifyPinDataInputBuilder;
5
6impl crate::operation::verify_pin_data::builders::VerifyPinDataInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::verify_pin_data::VerifyPinDataOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::verify_pin_data::VerifyPinDataError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.verify_pin_data();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `VerifyPinData`.
24///
25/// <p>Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html">Verify PIN data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
26/// <p>This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an <code>EncryptedPinBlock</code> for transmission from Amazon Web Services Payment Cryptography.</p>
27/// <p>For information about valid keys for this operation, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html">Understanding key attributes</a> and <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
28/// <p><b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p>
29/// <p><b>Related operations:</b></p>
30/// <ul>
31/// <li>
32/// <p><code>GeneratePinData</code></p></li>
33/// <li>
34/// <p><code>TranslatePinData</code></p></li>
35/// </ul>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct VerifyPinDataFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::verify_pin_data::builders::VerifyPinDataInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::verify_pin_data::VerifyPinDataOutput,
45        crate::operation::verify_pin_data::VerifyPinDataError,
46    > for VerifyPinDataFluentBuilder
47{
48    fn send(
49        self,
50        config_override: crate::config::Builder,
51    ) -> crate::client::customize::internal::BoxFuture<
52        crate::client::customize::internal::SendResult<
53            crate::operation::verify_pin_data::VerifyPinDataOutput,
54            crate::operation::verify_pin_data::VerifyPinDataError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl VerifyPinDataFluentBuilder {
61    /// Creates a new `VerifyPinDataFluentBuilder`.
62    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
63        Self {
64            handle,
65            inner: ::std::default::Default::default(),
66            config_override: ::std::option::Option::None,
67        }
68    }
69    /// Access the VerifyPinData as a reference.
70    pub fn as_input(&self) -> &crate::operation::verify_pin_data::builders::VerifyPinDataInputBuilder {
71        &self.inner
72    }
73    /// Sends the request and returns the response.
74    ///
75    /// If an error occurs, an `SdkError` will be returned with additional details that
76    /// can be matched against.
77    ///
78    /// By default, any retryable failures will be retried twice. Retry behavior
79    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
80    /// set when configuring the client.
81    pub async fn send(
82        self,
83    ) -> ::std::result::Result<
84        crate::operation::verify_pin_data::VerifyPinDataOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::verify_pin_data::VerifyPinDataError,
87            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
88        >,
89    > {
90        let input = self
91            .inner
92            .build()
93            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
94        let runtime_plugins = crate::operation::verify_pin_data::VerifyPinData::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::verify_pin_data::VerifyPinData::orchestrate(&runtime_plugins, input).await
100    }
101
102    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
103    pub fn customize(
104        self,
105    ) -> crate::client::customize::CustomizableOperation<
106        crate::operation::verify_pin_data::VerifyPinDataOutput,
107        crate::operation::verify_pin_data::VerifyPinDataError,
108        Self,
109    > {
110        crate::client::customize::CustomizableOperation::new(self)
111    }
112    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
113        self.set_config_override(::std::option::Option::Some(config_override.into()));
114        self
115    }
116
117    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
118        self.config_override = config_override;
119        self
120    }
121    /// <p>The <code>keyARN</code> of the PIN verification key.</p>
122    pub fn verification_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.verification_key_identifier(input.into());
124        self
125    }
126    /// <p>The <code>keyARN</code> of the PIN verification key.</p>
127    pub fn set_verification_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_verification_key_identifier(input);
129        self
130    }
131    /// <p>The <code>keyARN</code> of the PIN verification key.</p>
132    pub fn get_verification_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_verification_key_identifier()
134    }
135    /// <p>The <code>keyARN</code> of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.</p>
136    pub fn encryption_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.encryption_key_identifier(input.into());
138        self
139    }
140    /// <p>The <code>keyARN</code> of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.</p>
141    pub fn set_encryption_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_encryption_key_identifier(input);
143        self
144    }
145    /// <p>The <code>keyARN</code> of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.</p>
146    pub fn get_encryption_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_encryption_key_identifier()
148    }
149    /// <p>The attributes and values for PIN data verification.</p>
150    pub fn verification_attributes(mut self, input: crate::types::PinVerificationAttributes) -> Self {
151        self.inner = self.inner.verification_attributes(input);
152        self
153    }
154    /// <p>The attributes and values for PIN data verification.</p>
155    pub fn set_verification_attributes(mut self, input: ::std::option::Option<crate::types::PinVerificationAttributes>) -> Self {
156        self.inner = self.inner.set_verification_attributes(input);
157        self
158    }
159    /// <p>The attributes and values for PIN data verification.</p>
160    pub fn get_verification_attributes(&self) -> &::std::option::Option<crate::types::PinVerificationAttributes> {
161        self.inner.get_verification_attributes()
162    }
163    /// <p>The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.</p>
164    pub fn encrypted_pin_block(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
165        self.inner = self.inner.encrypted_pin_block(input.into());
166        self
167    }
168    /// <p>The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.</p>
169    pub fn set_encrypted_pin_block(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
170        self.inner = self.inner.set_encrypted_pin_block(input);
171        self
172    }
173    /// <p>The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.</p>
174    pub fn get_encrypted_pin_block(&self) -> &::std::option::Option<::std::string::String> {
175        self.inner.get_encrypted_pin_block()
176    }
177    /// <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
178    pub fn primary_account_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
179        self.inner = self.inner.primary_account_number(input.into());
180        self
181    }
182    /// <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
183    pub fn set_primary_account_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
184        self.inner = self.inner.set_primary_account_number(input);
185        self
186    }
187    /// <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
188    pub fn get_primary_account_number(&self) -> &::std::option::Option<::std::string::String> {
189        self.inner.get_primary_account_number()
190    }
191    /// <p>The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports <code>ISO_Format_0</code> and <code>ISO_Format_3</code>.</p>
192    /// <p>The <code>ISO_Format_0</code> 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.</p>
193    /// <p>The <code>ISO_Format_3</code> PIN block format is the same as <code>ISO_Format_0</code> except that the fill digits are random values from 10 to 15.</p>
194    pub fn pin_block_format(mut self, input: crate::types::PinBlockFormatForPinData) -> Self {
195        self.inner = self.inner.pin_block_format(input);
196        self
197    }
198    /// <p>The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports <code>ISO_Format_0</code> and <code>ISO_Format_3</code>.</p>
199    /// <p>The <code>ISO_Format_0</code> 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.</p>
200    /// <p>The <code>ISO_Format_3</code> PIN block format is the same as <code>ISO_Format_0</code> except that the fill digits are random values from 10 to 15.</p>
201    pub fn set_pin_block_format(mut self, input: ::std::option::Option<crate::types::PinBlockFormatForPinData>) -> Self {
202        self.inner = self.inner.set_pin_block_format(input);
203        self
204    }
205    /// <p>The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports <code>ISO_Format_0</code> and <code>ISO_Format_3</code>.</p>
206    /// <p>The <code>ISO_Format_0</code> 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.</p>
207    /// <p>The <code>ISO_Format_3</code> PIN block format is the same as <code>ISO_Format_0</code> except that the fill digits are random values from 10 to 15.</p>
208    pub fn get_pin_block_format(&self) -> &::std::option::Option<crate::types::PinBlockFormatForPinData> {
209        self.inner.get_pin_block_format()
210    }
211    /// <p>The length of PIN being verified.</p>
212    pub fn pin_data_length(mut self, input: i32) -> Self {
213        self.inner = self.inner.pin_data_length(input);
214        self
215    }
216    /// <p>The length of PIN being verified.</p>
217    pub fn set_pin_data_length(mut self, input: ::std::option::Option<i32>) -> Self {
218        self.inner = self.inner.set_pin_data_length(input);
219        self
220    }
221    /// <p>The length of PIN being verified.</p>
222    pub fn get_pin_data_length(&self) -> &::std::option::Option<i32> {
223        self.inner.get_pin_data_length()
224    }
225    /// <p>The attributes and values for the DUKPT encrypted PIN block data.</p>
226    pub fn dukpt_attributes(mut self, input: crate::types::DukptAttributes) -> Self {
227        self.inner = self.inner.dukpt_attributes(input);
228        self
229    }
230    /// <p>The attributes and values for the DUKPT encrypted PIN block data.</p>
231    pub fn set_dukpt_attributes(mut self, input: ::std::option::Option<crate::types::DukptAttributes>) -> Self {
232        self.inner = self.inner.set_dukpt_attributes(input);
233        self
234    }
235    /// <p>The attributes and values for the DUKPT encrypted PIN block data.</p>
236    pub fn get_dukpt_attributes(&self) -> &::std::option::Option<crate::types::DukptAttributes> {
237        self.inner.get_dukpt_attributes()
238    }
239    /// <p>Parameter information of a WrappedKeyBlock for encryption key exchange.</p>
240    pub fn encryption_wrapped_key(mut self, input: crate::types::WrappedKey) -> Self {
241        self.inner = self.inner.encryption_wrapped_key(input);
242        self
243    }
244    /// <p>Parameter information of a WrappedKeyBlock for encryption key exchange.</p>
245    pub fn set_encryption_wrapped_key(mut self, input: ::std::option::Option<crate::types::WrappedKey>) -> Self {
246        self.inner = self.inner.set_encryption_wrapped_key(input);
247        self
248    }
249    /// <p>Parameter information of a WrappedKeyBlock for encryption key exchange.</p>
250    pub fn get_encryption_wrapped_key(&self) -> &::std::option::Option<crate::types::WrappedKey> {
251        self.inner.get_encryption_wrapped_key()
252    }
253}
aws_sdk_paymentcryptographydata/operation/verify_pin_data/builders.rs

aws_sdk_paymentcryptographydata/operation/verify_pin_data/
builders.rs
