aws_sdk_cognitoidentityprovider/client/
associate_software_token.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`AssociateSoftwareToken`](crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`access_token(impl Into<String>)`](crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder::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> <p>You can provide either an access token or a session ID in the request.</p><br>
7    ///   - [`session(impl Into<String>)`](crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder::session) / [`set_session(Option<String>)`](crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder::set_session):<br>required: **false**<br><p>The session identifier that maintains the state of authentication requests and challenge responses. In <code>AssociateSoftwareToken</code>, this is the session ID from a successful sign-in. You can provide either an access token or a session ID in the request.</p><br>
8    /// - On success, responds with [`AssociateSoftwareTokenOutput`](crate::operation::associate_software_token::AssociateSoftwareTokenOutput) with field(s):
9    ///   - [`secret_code(Option<String>)`](crate::operation::associate_software_token::AssociateSoftwareTokenOutput::secret_code): <p>A unique generated shared secret code that is used by the TOTP algorithm to generate a one-time code.</p>
10    ///   - [`session(Option<String>)`](crate::operation::associate_software_token::AssociateSoftwareTokenOutput::session): <p>The session identifier that maintains the state of authentication requests and challenge responses.</p>
11    /// - On failure, responds with [`SdkError<AssociateSoftwareTokenError>`](crate::operation::associate_software_token::AssociateSoftwareTokenError)
12    pub fn associate_software_token(&self) -> crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder {
13        crate::operation::associate_software_token::builders::AssociateSoftwareTokenFluentBuilder::new(self.handle.clone())
14    }
15}