aws_sdk_cognitoidentityprovider/client/

confirm_device.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ConfirmDevice`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`access_token(impl Into<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::set_access_token):<br>required: **true**<br><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><br>
    ///   - [`device_key(impl Into<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::device_key) / [`set_device_key(Option<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::set_device_key):<br>required: **true**<br><p>The unique identifier, or device key, of the device that you want to update the status for.</p><br>
    ///   - [`device_secret_verifier_config(DeviceSecretVerifierConfigType)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::device_secret_verifier_config) / [`set_device_secret_verifier_config(Option<DeviceSecretVerifierConfigType>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::set_device_secret_verifier_config):<br>required: **false**<br><p>The configuration of the device secret verifier.</p><br>
    ///   - [`device_name(impl Into<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::device_name) / [`set_device_name(Option<String>)`](crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::set_device_name):<br>required: **false**<br><p>A friendly name for the device, for example <code>MyMobilePhone</code>.</p><br>
    /// - On success, responds with [`ConfirmDeviceOutput`](crate::operation::confirm_device::ConfirmDeviceOutput) with field(s):
    ///   - [`user_confirmation_necessary(bool)`](crate::operation::confirm_device::ConfirmDeviceOutput::user_confirmation_necessary): <p>When <code>true</code>, your user must confirm that they want to remember the device. Prompt the user for an answer.</p> <p>When <code>false</code>, immediately sets the device as remembered and eligible for device authentication.</p> <p>You can configure your user pool to always remember devices, in which case this response is <code>false</code>, or to allow users to opt in, in which case this response is <code>true</code>. Configure this option under <i>Device tracking</i> in the <i>Sign-in</i> menu of your user pool.</p>
    /// - On failure, responds with [`SdkError<ConfirmDeviceError>`](crate::operation::confirm_device::ConfirmDeviceError)
    pub fn confirm_device(&self) -> crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder {
        crate::operation::confirm_device::builders::ConfirmDeviceFluentBuilder::new(self.handle.clone())
    }
}