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.

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token.

Returns:

  • (String)


2434
2435
2436
2437
2438
2439
2440
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2434

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

#previous_passwordString

The old password.

Returns:

  • (String)


2434
2435
2436
2437
2438
2439
2440
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2434

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

#proposed_passwordString

The new password.

Returns:

  • (String)


2434
2435
2436
2437
2438
2439
2440
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2434

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