aws_sdk_cognitoidentityprovider/operation/admin_update_device_status/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::admin_update_device_status::_admin_update_device_status_output::AdminUpdateDeviceStatusOutputBuilder;
3
4pub use crate::operation::admin_update_device_status::_admin_update_device_status_input::AdminUpdateDeviceStatusInputBuilder;
5
6impl crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusInputBuilder {
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::admin_update_device_status::AdminUpdateDeviceStatusOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.admin_update_device_status();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `AdminUpdateDeviceStatus`.
24///
25/// <p>Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p><note>
26/// <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p>
27/// <p class="title"><b>Learn more</b></p>
28/// <ul>
29/// <li>
30/// <p><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a></p></li>
31/// <li>
32/// <p><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></li>
33/// </ul>
34/// </note>
35#[derive(::std::clone::Clone, ::std::fmt::Debug)]
36pub struct AdminUpdateDeviceStatusFluentBuilder {
37    handle: ::std::sync::Arc<crate::client::Handle>,
38    inner: crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusInputBuilder,
39    config_override: ::std::option::Option<crate::config::Builder>,
40}
41impl
42    crate::client::customize::internal::CustomizableSend<
43        crate::operation::admin_update_device_status::AdminUpdateDeviceStatusOutput,
44        crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError,
45    > for AdminUpdateDeviceStatusFluentBuilder
46{
47    fn send(
48        self,
49        config_override: crate::config::Builder,
50    ) -> crate::client::customize::internal::BoxFuture<
51        crate::client::customize::internal::SendResult<
52            crate::operation::admin_update_device_status::AdminUpdateDeviceStatusOutput,
53            crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError,
54        >,
55    > {
56        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
57    }
58}
59impl AdminUpdateDeviceStatusFluentBuilder {
60    /// Creates a new `AdminUpdateDeviceStatusFluentBuilder`.
61    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
62        Self {
63            handle,
64            inner: ::std::default::Default::default(),
65            config_override: ::std::option::Option::None,
66        }
67    }
68    /// Access the AdminUpdateDeviceStatus as a reference.
69    pub fn as_input(&self) -> &crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusInputBuilder {
70        &self.inner
71    }
72    /// Sends the request and returns the response.
73    ///
74    /// If an error occurs, an `SdkError` will be returned with additional details that
75    /// can be matched against.
76    ///
77    /// By default, any retryable failures will be retried twice. Retry behavior
78    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
79    /// set when configuring the client.
80    pub async fn send(
81        self,
82    ) -> ::std::result::Result<
83        crate::operation::admin_update_device_status::AdminUpdateDeviceStatusOutput,
84        ::aws_smithy_runtime_api::client::result::SdkError<
85            crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError,
86            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
87        >,
88    > {
89        let input = self
90            .inner
91            .build()
92            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
93        let runtime_plugins = crate::operation::admin_update_device_status::AdminUpdateDeviceStatus::operation_runtime_plugins(
94            self.handle.runtime_plugins.clone(),
95            &self.handle.conf,
96            self.config_override,
97        );
98        crate::operation::admin_update_device_status::AdminUpdateDeviceStatus::orchestrate(&runtime_plugins, input).await
99    }
100
101    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
102    pub fn customize(
103        self,
104    ) -> crate::client::customize::CustomizableOperation<
105        crate::operation::admin_update_device_status::AdminUpdateDeviceStatusOutput,
106        crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError,
107        Self,
108    > {
109        crate::client::customize::CustomizableOperation::new(self)
110    }
111    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
112        self.set_config_override(::std::option::Option::Some(config_override.into()));
113        self
114    }
115
116    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
117        self.config_override = config_override;
118        self
119    }
120    /// <p>The ID of the user pool where you want to change a user's device status.</p>
121    pub fn user_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.user_pool_id(input.into());
123        self
124    }
125    /// <p>The ID of the user pool where you want to change a user's device status.</p>
126    pub fn set_user_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_user_pool_id(input);
128        self
129    }
130    /// <p>The ID of the user pool where you want to change a user's device status.</p>
131    pub fn get_user_pool_id(&self) -> &::std::option::Option<::std::string::String> {
132        self.inner.get_user_pool_id()
133    }
134    /// <p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>
135    pub fn username(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
136        self.inner = self.inner.username(input.into());
137        self
138    }
139    /// <p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>
140    pub fn set_username(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
141        self.inner = self.inner.set_username(input);
142        self
143    }
144    /// <p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>
145    pub fn get_username(&self) -> &::std::option::Option<::std::string::String> {
146        self.inner.get_username()
147    }
148    /// <p>The unique identifier, or device key, of the device that you want to update the status for.</p>
149    pub fn device_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.inner = self.inner.device_key(input.into());
151        self
152    }
153    /// <p>The unique identifier, or device key, of the device that you want to update the status for.</p>
154    pub fn set_device_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155        self.inner = self.inner.set_device_key(input);
156        self
157    }
158    /// <p>The unique identifier, or device key, of the device that you want to update the status for.</p>
159    pub fn get_device_key(&self) -> &::std::option::Option<::std::string::String> {
160        self.inner.get_device_key()
161    }
162    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
163    pub fn device_remembered_status(mut self, input: crate::types::DeviceRememberedStatusType) -> Self {
164        self.inner = self.inner.device_remembered_status(input);
165        self
166    }
167    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
168    pub fn set_device_remembered_status(mut self, input: ::std::option::Option<crate::types::DeviceRememberedStatusType>) -> Self {
169        self.inner = self.inner.set_device_remembered_status(input);
170        self
171    }
172    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
173    pub fn get_device_remembered_status(&self) -> &::std::option::Option<crate::types::DeviceRememberedStatusType> {
174        self.inner.get_device_remembered_status()
175    }
176}
aws_sdk_cognitoidentityprovider/operation/admin_update_device_status/builders.rs

aws_sdk_cognitoidentityprovider/operation/admin_update_device_status/
builders.rs
