aws_sdk_cognitoidentityprovider/client/
change_password.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 [`ChangePassword`](crate::operation::change_password::builders::ChangePasswordFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`previous_password(impl Into<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::previous_password) / [`set_previous_password(Option<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::set_previous_password):<br>required: **false**<br><p>The user's previous password. Required if the user has a password. If the user has no password and only signs in with passwordless authentication options, you can omit this parameter.</p><br>
7    ///   - [`proposed_password(impl Into<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::proposed_password) / [`set_proposed_password(Option<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::set_proposed_password):<br>required: **true**<br><p>A new password that you prompted the user to enter in your application.</p><br>
8    ///   - [`access_token(impl Into<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::access_token) / [`set_access_token(Option<String>)`](crate::operation::change_password::builders::ChangePasswordFluentBuilder::set_access_token):<br>required: **true**<br><p>A valid access token that Amazon Cognito issued to the user whose password you want to change.</p><br>
9    /// - On success, responds with [`ChangePasswordOutput`](crate::operation::change_password::ChangePasswordOutput)
10    /// - On failure, responds with [`SdkError<ChangePasswordError>`](crate::operation::change_password::ChangePasswordError)
11    pub fn change_password(&self) -> crate::operation::change_password::builders::ChangePasswordFluentBuilder {
12        crate::operation::change_password::builders::ChangePasswordFluentBuilder::new(self.handle.clone())
13    }
14}