You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass ChangePasswordRequest data as a hash:

{
  previous_password: "PasswordType", # required
  proposed_password: "PasswordType", # required
  access_token: "TokenModelType", # required
}

Represents the request to change a user password.

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token in the change password request.

Returns:

  • (String)


1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1448

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

#previous_passwordString

The old password in the change password request.

Returns:

  • (String)


1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1448

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

#proposed_passwordString

The new password in the change password request.

Returns:

  • (String)


1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1448

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