list_users ¶

def list_users(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    user_email: Optional["capo_chime.types.email_address.EmailAddress"] = None,
    user_type: Optional["capo_chime.types.user_type.UserType"] = None,
    max_results: Optional[
        "capo_chime.types.profile_service_max_results.ProfileServiceMaxResults"
    ] = None,
    next_token: Optional["capo_chime.types.string.String"] = None,
) -> "capo_chime.types.list_users_response.ListUsersResponse":
    """<p>Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        user_email: <p>Optional. The user email address used to filter results. Maximum 1.</p>
        user_type: <p>The user type.</p>
        max_results: <p>The maximum number of results to return in a single call. Defaults to 100.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime.types.list_users_request.ListUsersRequest]",
    ) -> OperationResponse[
        "capo_chime.types.list_users_response.ListUsersResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.list_users

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.list_users.list_users(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime.types.list_users_request.ListUsersRequest",
    ) -> dict[str, Any]:
        import capo_chime.types.list_users_request

        return capo_chime.types.list_users_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_chime.types.list_users_response.ListUsersResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.list_users_response

        return capo_chime.types.list_users_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListUsers", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_chime.types.list_users_request.ListUsersRequest = {
        "account_id": account_id
    }
    if user_email is not None:
        input_["user_email"] = user_email
    if user_type is not None:
        input_["user_type"] = user_type
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output