Class: Aws::CognitoIdentityProvider::Types::ChangePasswordRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the request to change a user password.

See Also:

Constant Summary collapse

SENSITIVE = 
[:previous_password, :proposed_password, :access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

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

Returns:

  • (String) 


2916
2917
2918
2919
2920
2921
2922
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2916

class ChangePasswordRequest < Struct.new(
  :previous_password,
  :proposed_password,
  :access_token)
  SENSITIVE = [:previous_password, :proposed_password, :access_token]
  include Aws::Structure
end

#previous_password ⇒ String

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:

  • (String) 


2916
2917
2918
2919
2920
2921
2922
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2916

class ChangePasswordRequest < Struct.new(
  :previous_password,
  :proposed_password,
  :access_token)
  SENSITIVE = [:previous_password, :proposed_password, :access_token]
  include Aws::Structure
end

#proposed_password ⇒ String

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

Returns:

  • (String) 


2916
2917
2918
2919
2920
2921
2922
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 2916

class ChangePasswordRequest < Struct.new(
  :previous_password,
  :proposed_password,
  :access_token)
  SENSITIVE = [:previous_password, :proposed_password, :access_token]
  include Aws::Structure
end