Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ChangePasswordCommandProtected

Changes the password of the IAM user who is calling this operation. This operation can be performed using the CLI, the Amazon Web Services API, or the My Security Credentials page in the Amazon Web Services Management Console. The Amazon Web Services account root user password is not affected by this operation.

Use UpdateLoginProfile to use the CLI, the Amazon Web Services API, or the Users page in the IAM console to change the password for any IAM user. For more information about modifying passwords, see Managing passwords in the IAM User Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, ChangePasswordCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, ChangePasswordCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // ChangePasswordRequest
OldPassword: "STRING_VALUE", // required
NewPassword: "STRING_VALUE", // required
};
const command = new ChangePasswordCommand(input);
const response = await client.send(command);
// {};

Param

ChangePasswordCommandInput

Returns

ChangePasswordCommandOutput

See

Throws

EntityTemporarilyUnmodifiableException (client fault)

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

Throws

InvalidUserTypeException (client fault)

The request was rejected because the type of user for the transaction was incorrect.

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

PasswordPolicyViolationException (client fault)

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To change the password for your IAM user

// The following command changes the password for the current IAM user.
const input = {
"NewPassword": "]35d/{pB9Fo9wJ",
"OldPassword": "3s0K_;xh4~8XXI"
};
const command = new ChangePasswordCommand(input);
await client.send(command);
// example id: 3a80c66f-bffb-46df-947c-1e8fa583b470

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods