list_users ¶

def list_users(
    self,
    max_results: "capo_finspace_data.types.result_limit.ResultLimit",
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
    next_token: Optional[
        "capo_finspace_data.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_finspace_data.types.list_users_response.ListUsersResponse":
    """<p>Lists all available users in FinSpace.</p>

    Args:
        next_token: <p>A token that indicates where a results page should begin.</p>
        max_results: <p>The maximum number of results per page.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_finspace_data._operations.aws_habanero_public_api.list_users.list_users(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_finspace_data.types.list_users_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListUsers", redact_output=_redact_output),
    )
    input_: capo_finspace_data.types.list_users_request.ListUsersRequest = {
        "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