QuickSight / Client / list_users_index_capacity

list_users_index_capacity¶

QuickSight.Client.list_users_index_capacity(**kwargs)¶

Lists per-user index capacity consumption for an account.

Request Syntax

response = client.list_users_index_capacity(
    awsAccountId='string',
    namespace='string',
    filters=[
        {
            'userNameOrEmail': {
                'prefix': 'string'
            },
            'totalCapacityBytes': {
                'minBytes': 123,
                'maxBytes': 123
            }
        },
    ],
    sortBy='TOTAL_CAPACITY_BYTES',
    sortOrder='ASC'|'DESC',
    maxResults=123,
    nextToken='string'
)

Parameters:

awsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the index capacity data.
namespace (string) – The namespace to scope the user search to. Required when the userNameOrEmail filter is present.
filters (list) –
Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.
- (dict) –
  
  A filter for user index capacity queries. Only one filter type can be specified per request.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: userNameOrEmail, totalCapacityBytes.
  - userNameOrEmail (dict) –
    
    Filter users by username or email prefix.
    - prefix (string) – [REQUIRED]
      
      The prefix to match against username or email (starts-with match).
  - totalCapacityBytes (dict) –
    
    Filter users by total capacity range in bytes.
    - minBytes (integer) –
      
      The minimum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required.
    - maxBytes (integer) –
      
      The maximum capacity in bytes (inclusive). At least one of minBytes or maxBytes is required.
sortBy (string) – The field to sort results by.
sortOrder (string) – The sort order for results. Defaults to DESC if not specified.
maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – The token for the next set of results, received from a previous call.

Return type:

dict

Returns:

Response Syntax

{
    'users': [
        {
            'userArn': 'string',
            'userName': 'string',
            'email': 'string',
            'role': 'string',
            'totalCapacityBytes': 123,
            'totalKBCapacityBytes': 123,
            'totalSpaceCapacityBytes': 123,
            'kbCount': 123,
            'spaceCount': 123
        },
    ],
    'nextToken': 'string',
    'requestId': 'string'
}

Response Structure

(dict) –
- users (list) –
  
  The list of users with their index capacity metrics.
  - (dict) –
    
    A summary of a user’s index capacity consumption.
    - userArn (string) –
      
      The ARN of the user.
    - userName (string) –
      
      The username of the user.
    - email (string) –
      
      The email address of the user.
    - role (string) –
      
      The role of the user.
    - totalCapacityBytes (integer) –
      
      The total index capacity consumed by the user in bytes.
    - totalKBCapacityBytes (integer) –
      
      The total index capacity consumed by the user’s knowledge bases in bytes.
    - totalSpaceCapacityBytes (integer) –
      
      The total index capacity consumed by the user’s spaces in bytes.
    - kbCount (integer) –
      
      The number of knowledge bases owned by the user.
    - spaceCount (integer) –
      
      The number of spaces owned by the user.
- nextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- requestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidRequestException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException