list_users_index_capacity ¶

def list_users_index_capacity(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    namespace: Optional["capo_quicksight.types.namespace.Namespace"] = None,
    filters: Optional[
        "capo_quicksight.types.user_index_capacity_filters.UserIndexCapacityFilters"
    ] = None,
    sort_by: Optional[
        "capo_quicksight.types.user_index_capacity_sort_by.UserIndexCapacitySortBy"
    ] = None,
    sort_order: Optional[
        "capo_quicksight.types.user_index_capacity_sort_order.UserIndexCapacitySortOrder"
    ] = None,
    max_results: Optional[
        "capo_quicksight.types.list_users_index_capacity_request_max_results_integer.ListUsersIndexCapacityRequestMaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_quicksight.types.list_users_index_capacity_response.ListUsersIndexCapacityResponse":
    """<p>Lists per-user index capacity consumption for an account.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the index capacity data.</p>
        namespace: <p>The namespace to scope the user search to. Required when the userNameOrEmail filter is present.</p>
        filters: <p>Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.</p>
        sort_by: <p>The field to sort results by.</p>
        sort_order: <p>The sort order for results. Defaults to DESC if not specified.</p>
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results, received from a previous call.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_request_exception.InvalidRequestException: <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.list_users_index_capacity_request.ListUsersIndexCapacityRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.list_users_index_capacity_response.ListUsersIndexCapacityResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.list_users_index_capacity

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.list_users_index_capacity.list_users_index_capacity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUsersIndexCapacity")
    )
    input_: capo_quicksight.types.list_users_index_capacity_request.ListUsersIndexCapacityRequest = {
        "aws_account_id": aws_account_id
    }
    if namespace is not None:
        input_["namespace"] = namespace
    if filters is not None:
        input_["filters"] = filters
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    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