aws_sdk_cognitoidentityprovider/client/

verify_software_token.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`VerifySoftwareToken`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`access_token(impl Into<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::set_access_token):<br>required: **false**<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>
    ///   - [`session(impl Into<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::session) / [`set_session(Option<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::set_session):<br>required: **false**<br><p>The session ID from an <code>AssociateSoftwareToken</code> request.</p><br>
    ///   - [`user_code(impl Into<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::user_code) / [`set_user_code(Option<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::set_user_code):<br>required: **true**<br><p>A TOTP that the user generated in their configured authenticator app.</p><br>
    ///   - [`friendly_device_name(impl Into<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::friendly_device_name) / [`set_friendly_device_name(Option<String>)`](crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::set_friendly_device_name):<br>required: **false**<br><p>A friendly name for the device that's running the TOTP authenticator.</p><br>
    /// - On success, responds with [`VerifySoftwareTokenOutput`](crate::operation::verify_software_token::VerifySoftwareTokenOutput) with field(s):
    ///   - [`status(Option<VerifySoftwareTokenResponseType>)`](crate::operation::verify_software_token::VerifySoftwareTokenOutput::status): <p>Amazon Cognito can accept or reject the code that you provide. This response parameter indicates the success of TOTP verification. Some reasons that this operation might return an error are clock skew on the user's device and excessive retries.</p>
    ///   - [`session(Option<String>)`](crate::operation::verify_software_token::VerifySoftwareTokenOutput::session): <p>This session ID satisfies an <code>MFA_SETUP</code> challenge. Supply the session ID in your challenge response.</p>
    /// - On failure, responds with [`SdkError<VerifySoftwareTokenError>`](crate::operation::verify_software_token::VerifySoftwareTokenError)
    pub fn verify_software_token(&self) -> crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder {
        crate::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder::new(self.handle.clone())
    }
}