WorkMail / Client / reset_password

reset_password

WorkMail.Client.reset_password(**kwargs)

Allows the administrator to reset the password for a user.

See also: AWS API Documentation

Request Syntax

response = client.reset_password(
    OrganizationId='string',
    UserId='string',
    Password='string'
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier of the organization that contains the user for which the password is reset.

• UserId (string) –

  [REQUIRED]

  The identifier of the user for whom the password is reset.

• Password (string) –

  [REQUIRED]

  The new password for the user.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

• WorkMail.Client.exceptions.DirectoryUnavailableException

• WorkMail.Client.exceptions.EntityNotFoundException

• WorkMail.Client.exceptions.EntityStateException

• WorkMail.Client.exceptions.InvalidParameterException

• WorkMail.Client.exceptions.InvalidPasswordException

• WorkMail.Client.exceptions.OrganizationNotFoundException

• WorkMail.Client.exceptions.OrganizationStateException

• WorkMail.Client.exceptions.UnsupportedOperationException