aws_sdk_paymentcryptographydata/operation/generate_card_validation_data/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::generate_card_validation_data::_generate_card_validation_data_output::GenerateCardValidationDataOutputBuilder;
3
4pub use crate::operation::generate_card_validation_data::_generate_card_validation_data_input::GenerateCardValidationDataInputBuilder;
5
6impl crate::operation::generate_card_validation_data::builders::GenerateCardValidationDataInputBuilder {
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::generate_card_validation_data::GenerateCardValidationDataOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::generate_card_validation_data::GenerateCardValidationDataError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.generate_card_validation_data();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GenerateCardValidationData`.
24///
25/// <p>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). For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html">Generate card data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p>
26/// <p>This operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account Number) and expiration date of the card are required to check its validity during transaction processing. To begin this operation, a CVK (Card Verification Key) encryption key is required. You can use <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html">CreateKey</a> or <a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html">ImportKey</a> to establish a CVK within Amazon Web Services Payment Cryptography. The <code>KeyModesOfUse</code> should be set to <code>Generate</code> and <code>Verify</code> for a CVK encryption key.</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><a href="https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html">ImportKey</a></p></li>
33/// <li>
34/// <p><code>VerifyCardValidationData</code></p></li>
35/// </ul>
36#[derive(::std::clone::Clone, ::std::fmt::Debug)]
37pub struct GenerateCardValidationDataFluentBuilder {
38    handle: ::std::sync::Arc<crate::client::Handle>,
39    inner: crate::operation::generate_card_validation_data::builders::GenerateCardValidationDataInputBuilder,
40    config_override: ::std::option::Option<crate::config::Builder>,
41}
42impl
43    crate::client::customize::internal::CustomizableSend<
44        crate::operation::generate_card_validation_data::GenerateCardValidationDataOutput,
45        crate::operation::generate_card_validation_data::GenerateCardValidationDataError,
46    > for GenerateCardValidationDataFluentBuilder
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::generate_card_validation_data::GenerateCardValidationDataOutput,
54            crate::operation::generate_card_validation_data::GenerateCardValidationDataError,
55        >,
56    > {
57        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
58    }
59}
60impl GenerateCardValidationDataFluentBuilder {
61    /// Creates a new `GenerateCardValidationDataFluentBuilder`.
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 GenerateCardValidationData as a reference.
70    pub fn as_input(&self) -> &crate::operation::generate_card_validation_data::builders::GenerateCardValidationDataInputBuilder {
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::generate_card_validation_data::GenerateCardValidationDataOutput,
85        ::aws_smithy_runtime_api::client::result::SdkError<
86            crate::operation::generate_card_validation_data::GenerateCardValidationDataError,
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::generate_card_validation_data::GenerateCardValidationData::operation_runtime_plugins(
95            self.handle.runtime_plugins.clone(),
96            &self.handle.conf,
97            self.config_override,
98        );
99        crate::operation::generate_card_validation_data::GenerateCardValidationData::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::generate_card_validation_data::GenerateCardValidationDataOutput,
107        crate::operation::generate_card_validation_data::GenerateCardValidationDataError,
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 CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.</p>
122    pub fn key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
123        self.inner = self.inner.key_identifier(input.into());
124        self
125    }
126    /// <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.</p>
127    pub fn set_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
128        self.inner = self.inner.set_key_identifier(input);
129        self
130    }
131    /// <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.</p>
132    pub fn get_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
133        self.inner.get_key_identifier()
134    }
135    /// <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>
136    pub fn primary_account_number(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
137        self.inner = self.inner.primary_account_number(input.into());
138        self
139    }
140    /// <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>
141    pub fn set_primary_account_number(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
142        self.inner = self.inner.set_primary_account_number(input);
143        self
144    }
145    /// <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>
146    pub fn get_primary_account_number(&self) -> &::std::option::Option<::std::string::String> {
147        self.inner.get_primary_account_number()
148    }
149    /// <p>The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.</p>
150    pub fn generation_attributes(mut self, input: crate::types::CardGenerationAttributes) -> Self {
151        self.inner = self.inner.generation_attributes(input);
152        self
153    }
154    /// <p>The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.</p>
155    pub fn set_generation_attributes(mut self, input: ::std::option::Option<crate::types::CardGenerationAttributes>) -> Self {
156        self.inner = self.inner.set_generation_attributes(input);
157        self
158    }
159    /// <p>The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.</p>
160    pub fn get_generation_attributes(&self) -> &::std::option::Option<crate::types::CardGenerationAttributes> {
161        self.inner.get_generation_attributes()
162    }
163    /// <p>The length of the CVV or CSC to be generated. The default value is 3.</p>
164    pub fn validation_data_length(mut self, input: i32) -> Self {
165        self.inner = self.inner.validation_data_length(input);
166        self
167    }
168    /// <p>The length of the CVV or CSC to be generated. The default value is 3.</p>
169    pub fn set_validation_data_length(mut self, input: ::std::option::Option<i32>) -> Self {
170        self.inner = self.inner.set_validation_data_length(input);
171        self
172    }
173    /// <p>The length of the CVV or CSC to be generated. The default value is 3.</p>
174    pub fn get_validation_data_length(&self) -> &::std::option::Option<i32> {
175        self.inner.get_validation_data_length()
176    }
177}