[ aws . cognito-idp ]

change-password

Description

Changes the password for a specified user in a user pool.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  change-password
--previous-password <value>
--proposed-password <value>
--access-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--previous-password (string)

The old password.

--proposed-password (string)

The new password.

--access-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To change a password

This example changes a password.

Command:

aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN

Output

None