aws_sdk_cognitoidentityprovider/operation/verify_user_attribute/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::verify_user_attribute::_verify_user_attribute_output::VerifyUserAttributeOutputBuilder;
3
4pub use crate::operation::verify_user_attribute::_verify_user_attribute_input::VerifyUserAttributeInputBuilder;
5
6impl crate::operation::verify_user_attribute::builders::VerifyUserAttributeInputBuilder {
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_user_attribute::VerifyUserAttributeOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::verify_user_attribute::VerifyUserAttributeError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.verify_user_attribute();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `VerifyUserAttribute`.
24///
25/// <p>Submits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute. When successful, the user's attribute becomes verified and the attribute <code>email_verified</code> or <code>phone_number_verified</code> becomes <code>true</code>.</p>
26/// <p>If your user pool requires verification before Amazon Cognito updates the attribute value, this operation updates the affected attribute to its pending value.</p>
27/// <p>Authorize this action with a signed-in user's access token. It must include the scope <code>aws.cognito.signin.user.admin</code>.</p><note>
28/// <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct VerifyUserAttributeFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::verify_user_attribute::builders::VerifyUserAttributeInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::verify_user_attribute::VerifyUserAttributeOutput,
39        crate::operation::verify_user_attribute::VerifyUserAttributeError,
40    > for VerifyUserAttributeFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::verify_user_attribute::VerifyUserAttributeOutput,
48            crate::operation::verify_user_attribute::VerifyUserAttributeError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl VerifyUserAttributeFluentBuilder {
55    /// Creates a new `VerifyUserAttributeFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the VerifyUserAttribute as a reference.
64    pub fn as_input(&self) -> &crate::operation::verify_user_attribute::builders::VerifyUserAttributeInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::verify_user_attribute::VerifyUserAttributeOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::verify_user_attribute::VerifyUserAttributeError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::verify_user_attribute::VerifyUserAttribute::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::verify_user_attribute::VerifyUserAttribute::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::verify_user_attribute::VerifyUserAttributeOutput,
101        crate::operation::verify_user_attribute::VerifyUserAttributeError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p>
116    pub fn access_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.access_token(input.into());
118        self
119    }
120    /// <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p>
121    pub fn set_access_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_access_token(input);
123        self
124    }
125    /// <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p>
126    pub fn get_access_token(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_access_token()
128    }
129    /// <p>The name of the attribute that you want to verify.</p>
130    pub fn attribute_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131        self.inner = self.inner.attribute_name(input.into());
132        self
133    }
134    /// <p>The name of the attribute that you want to verify.</p>
135    pub fn set_attribute_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136        self.inner = self.inner.set_attribute_name(input);
137        self
138    }
139    /// <p>The name of the attribute that you want to verify.</p>
140    pub fn get_attribute_name(&self) -> &::std::option::Option<::std::string::String> {
141        self.inner.get_attribute_name()
142    }
143    /// <p>The verification code that your user pool sent to the added or changed attribute, for example the user's email address.</p>
144    pub fn code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
145        self.inner = self.inner.code(input.into());
146        self
147    }
148    /// <p>The verification code that your user pool sent to the added or changed attribute, for example the user's email address.</p>
149    pub fn set_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150        self.inner = self.inner.set_code(input);
151        self
152    }
153    /// <p>The verification code that your user pool sent to the added or changed attribute, for example the user's email address.</p>
154    pub fn get_code(&self) -> &::std::option::Option<::std::string::String> {
155        self.inner.get_code()
156    }
157}
aws_sdk_cognitoidentityprovider/operation/verify_user_attribute/builders.rs

aws_sdk_cognitoidentityprovider/operation/verify_user_attribute/
builders.rs
