Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ChangePasswordRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.ChangePasswordRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ChangePasswordRequest.Builder,ChangePasswordRequest>
@Generated("software.amazon.awssdk:codegen") public final class ChangePasswordRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<ChangePasswordRequest.Builder,ChangePasswordRequest>

Represents the request to change a user password.

  • Method Details

    • previousPassword

      public final String previousPassword()

      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.

      Returns:
      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.

    • proposedPassword

      public final String proposedPassword()

      A new password that you prompted the user to enter in your application.

      Returns:
      A new password that you prompted the user to enter in your application.

    • accessToken

      public final String accessToken()

      A valid access token that Amazon Cognito issued to the user whose password you want to change.

      Returns:
      A valid access token that Amazon Cognito issued to the user whose password you want to change.

    • toBuilder

      public ChangePasswordRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ChangePasswordRequest.Builder,ChangePasswordRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static ChangePasswordRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ChangePasswordRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo