Struct aws_sdk_cognitoidentityprovider::operation::verify_software_token::builders::VerifySoftwareTokenFluentBuilder

pub struct VerifySoftwareTokenFluentBuilder { /* private fields */ }

Fluent builder constructing a request to VerifySoftwareToken.

Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

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 Using the Amazon Cognito user pools API and user pool endpoints.

Implementations

impl VerifySoftwareTokenFluentBuilder

pub fn as_input(&self) -> &VerifySoftwareTokenInputBuilder

Access the VerifySoftwareToken as a reference.

pub async fn send( self ) -> Result<VerifySoftwareTokenOutput, SdkError<VerifySoftwareTokenError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<VerifySoftwareTokenOutput, VerifySoftwareTokenError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn access_token(self, input: impl Into<String>) -> Self

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

pub fn set_access_token(self, input: Option<String>) -> Self

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

pub fn get_access_token(&self) -> &Option<String>

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

pub fn session(self, input: impl Into<String>) -> Self

The session that should be passed both ways in challenge-response calls to the service.

pub fn set_session(self, input: Option<String>) -> Self

The session that should be passed both ways in challenge-response calls to the service.

pub fn get_session(&self) -> &Option<String>

The session that should be passed both ways in challenge-response calls to the service.

pub fn user_code(self, input: impl Into<String>) -> Self

The one- time password computed using the secret code returned by AssociateSoftwareToken.

pub fn set_user_code(self, input: Option<String>) -> Self

The one- time password computed using the secret code returned by AssociateSoftwareToken.

pub fn get_user_code(&self) -> &Option<String>

The one- time password computed using the secret code returned by AssociateSoftwareToken.

pub fn friendly_device_name(self, input: impl Into<String>) -> Self

The friendly device name.

pub fn set_friendly_device_name(self, input: Option<String>) -> Self

The friendly device name.

pub fn get_friendly_device_name(&self) -> &Option<String>

The friendly device name.

Trait Implementations

impl Clone for VerifySoftwareTokenFluentBuilder

fn clone(&self) -> VerifySoftwareTokenFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VerifySoftwareTokenFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.