aws_sdk_cognitoidentityprovider/operation/associate_software_token/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::associate_software_token::_associate_software_token_output::AssociateSoftwareTokenOutputBuilder;
3
4pub use crate::operation::associate_software_token::_associate_software_token_input::AssociateSoftwareTokenInputBuilder;
5
6impl crate::operation::associate_software_token::builders::AssociateSoftwareTokenInputBuilder {
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::associate_software_token::AssociateSoftwareTokenOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::associate_software_token::AssociateSoftwareTokenError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.associate_software_token();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `AssociateSoftwareToken`.
24///
25/// <p>Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an <code>AssociateSoftwareToken</code> request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.</p><note>
26/// <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>
27/// </note>
28/// <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>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct AssociateSoftwareTokenFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::associate_software_token::builders::AssociateSoftwareTokenInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::associate_software_token::AssociateSoftwareTokenOutput,
38        crate::operation::associate_software_token::AssociateSoftwareTokenError,
39    > for AssociateSoftwareTokenFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::associate_software_token::AssociateSoftwareTokenOutput,
47            crate::operation::associate_software_token::AssociateSoftwareTokenError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl AssociateSoftwareTokenFluentBuilder {
54    /// Creates a new `AssociateSoftwareTokenFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the AssociateSoftwareToken as a reference.
63    pub fn as_input(&self) -> &crate::operation::associate_software_token::builders::AssociateSoftwareTokenInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::associate_software_token::AssociateSoftwareTokenOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::associate_software_token::AssociateSoftwareTokenError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::associate_software_token::AssociateSoftwareToken::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::associate_software_token::AssociateSoftwareToken::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::associate_software_token::AssociateSoftwareTokenOutput,
100        crate::operation::associate_software_token::AssociateSoftwareTokenError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <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>
115    /// <p>You can provide either an access token or a session ID in the request.</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    /// <p>You can provide either an access token or a session ID in the request.</p>
122    pub fn set_access_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_access_token(input);
124        self
125    }
126    /// <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>
127    /// <p>You can provide either an access token or a session ID in the request.</p>
128    pub fn get_access_token(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_access_token()
130    }
131    /// <p>The session identifier that maintains the state of authentication requests and challenge responses. In <code>AssociateSoftwareToken</code>, this is the session ID from a successful sign-in. You can provide either an access token or a session ID in the request.</p>
132    pub fn session(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.session(input.into());
134        self
135    }
136    /// <p>The session identifier that maintains the state of authentication requests and challenge responses. In <code>AssociateSoftwareToken</code>, this is the session ID from a successful sign-in. You can provide either an access token or a session ID in the request.</p>
137    pub fn set_session(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_session(input);
139        self
140    }
141    /// <p>The session identifier that maintains the state of authentication requests and challenge responses. In <code>AssociateSoftwareToken</code>, this is the session ID from a successful sign-in. You can provide either an access token or a session ID in the request.</p>
142    pub fn get_session(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_session()
144    }
145}
aws_sdk_cognitoidentityprovider/operation/associate_software_token/builders.rs

aws_sdk_cognitoidentityprovider/operation/associate_software_token/
builders.rs
