reset_user_password async ¶

async def reset_user_password(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    user_name: "capo_directory_service.types.customer_user_name.CustomerUserName",
    new_password: "capo_directory_service.types.user_password.UserPassword",
    *,
    config_overrides: Optional[AsyncDirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.reset_user_password_result.ResetUserPasswordResult":
    """<p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.</p> <p>You can reset the password for any user in your directory with the following exceptions:</p> <ul> <li> <p>For Simple AD, you cannot reset the password for any user that is a member of either the <b>Domain Admins</b> or <b>Enterprise Admins</b> group except for the administrator user.</p> </li> <li> <p>For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the <b>Amazon Web Services Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD directory, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html">What Gets Created</a> in the <i>Directory Service Administration Guide</i>.</p> </li> </ul>

    Args:
        directory_id: <p>Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.</p>
        user_name: <p>The user name of the user whose password will be reset.</p>
        new_password: <p>The new password that will be reset.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The specified directory is unavailable.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</p>
        capo_directory_service.errors.invalid_password_exception.InvalidPasswordException: <p>The new password provided by the user does not meet the password complexity requirements defined in your directory.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.user_does_not_exist_exception.UserDoesNotExistException: <p>The user provided a username that does not exist in your directory.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_directory_service.types.reset_user_password_request.ResetUserPasswordRequest]",
    ) -> AsyncOperationResponse[
        "capo_directory_service.types.reset_user_password_result.ResetUserPasswordResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.reset_user_password

        (
            output,
            http_response,
        ) = await capo_directory_service._operations.directory_service_20150416.reset_user_password.async_reset_user_password(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_directory_service.types.reset_user_password_request.ResetUserPasswordRequest",
    ) -> dict[str, Any]:
        import capo_directory_service.types.reset_user_password_request

        return capo_directory_service.types.reset_user_password_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ResetUserPassword", redact_input=_redact_input),
    )
    input_: capo_directory_service.types.reset_user_password_request.ResetUserPasswordRequest = {
        "directory_id": directory_id,
        "user_name": user_name,
        "new_password": new_password,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output