aws_sdk_cognitoidentityprovider/operation/update_device_status/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_device_status::_update_device_status_output::UpdateDeviceStatusOutputBuilder;
3
4pub use crate::operation::update_device_status::_update_device_status_input::UpdateDeviceStatusInputBuilder;
5
6impl crate::operation::update_device_status::builders::UpdateDeviceStatusInputBuilder {
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::update_device_status::UpdateDeviceStatusOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_device_status::UpdateDeviceStatusError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_device_status();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateDeviceStatus`.
24///
25/// <p>Updates the status of a the currently signed-in 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>
26/// <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>
27/// <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>
28/// </note>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct UpdateDeviceStatusFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::update_device_status::builders::UpdateDeviceStatusInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::update_device_status::UpdateDeviceStatusOutput,
38        crate::operation::update_device_status::UpdateDeviceStatusError,
39    > for UpdateDeviceStatusFluentBuilder
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::update_device_status::UpdateDeviceStatusOutput,
47            crate::operation::update_device_status::UpdateDeviceStatusError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl UpdateDeviceStatusFluentBuilder {
54    /// Creates a new `UpdateDeviceStatusFluentBuilder`.
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 UpdateDeviceStatus as a reference.
63    pub fn as_input(&self) -> &crate::operation::update_device_status::builders::UpdateDeviceStatusInputBuilder {
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::update_device_status::UpdateDeviceStatusOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::update_device_status::UpdateDeviceStatusError,
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::update_device_status::UpdateDeviceStatus::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::update_device_status::UpdateDeviceStatus::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::update_device_status::UpdateDeviceStatusOutput,
100        crate::operation::update_device_status::UpdateDeviceStatusError,
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    pub fn access_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.access_token(input.into());
117        self
118    }
119    /// <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>
120    pub fn set_access_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_access_token(input);
122        self
123    }
124    /// <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>
125    pub fn get_access_token(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_access_token()
127    }
128    /// <p>The device key of the device you want to update, for example <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
129    pub fn device_key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
130        self.inner = self.inner.device_key(input.into());
131        self
132    }
133    /// <p>The device key of the device you want to update, for example <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
134    pub fn set_device_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
135        self.inner = self.inner.set_device_key(input);
136        self
137    }
138    /// <p>The device key of the device you want to update, for example <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
139    pub fn get_device_key(&self) -> &::std::option::Option<::std::string::String> {
140        self.inner.get_device_key()
141    }
142    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
143    pub fn device_remembered_status(mut self, input: crate::types::DeviceRememberedStatusType) -> Self {
144        self.inner = self.inner.device_remembered_status(input);
145        self
146    }
147    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
148    pub fn set_device_remembered_status(mut self, input: ::std::option::Option<crate::types::DeviceRememberedStatusType>) -> Self {
149        self.inner = self.inner.set_device_remembered_status(input);
150        self
151    }
152    /// <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
153    pub fn get_device_remembered_status(&self) -> &::std::option::Option<crate::types::DeviceRememberedStatusType> {
154        self.inner.get_device_remembered_status()
155    }
156}
aws_sdk_cognitoidentityprovider/operation/update_device_status/builders.rs

aws_sdk_cognitoidentityprovider/operation/update_device_status/
builders.rs
