AWS API Changes

2026/06/05 - Amazon QuickSight - 8 new api methods

Changes Adds support for Knowledge Base APIs and Index Capacity API

BatchDeleteKnowledgeBase (new)

Link ¶

Deletes one or more knowledge bases.

Request Syntax

client.batch_delete_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseIds=[
        'string',
    ]
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type KnowledgeBaseIds:

list

param KnowledgeBaseIds:

[REQUIRED]

A list of knowledge base identifiers to delete.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'Deleted': [
        {
            'KnowledgeBaseId': 'string',
            'KnowledgeBaseArn': 'string'
        },
    ],
    'Errors': [
        {
            'KnowledgeBaseId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Deleted (list) --
  
  A list of knowledge bases that were successfully deleted.
  - (dict) --
    
    Information about a knowledge base that was successfully deleted in a batch operation.
    - KnowledgeBaseId (string) --
      
      The unique identifier of the successfully deleted knowledge base.
    - KnowledgeBaseArn (string) --
      
      The ARN of the successfully deleted knowledge base.
- Errors (list) --
  
  A list of knowledge bases that failed to be deleted.
  - (dict) --
    
    Information about a knowledge base that failed to be deleted in a batch operation.
    - KnowledgeBaseId (string) --
      
      The unique identifier of the knowledge base that failed to be deleted.
    - ErrorCode (string) --
      
      The error code for the deletion failure.
    - ErrorMessage (string) --
      
      The error message for the deletion failure.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

ListKnowledgeBases (new)

Link ¶

Lists all knowledge bases in an Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

client.list_knowledge_bases(
    AwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBaseSummaries': [
        {
            'KnowledgeBaseArn': 'string',
            'KnowledgeBaseId': 'string',
            'Name': 'string',
            'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
            'DataSourceArn': 'string',
            'Type': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'KnowledgeBaseSizeBytes': 123,
            'DocumentCount': 123,
            'PrimaryOwnerArn': 'string',
            'PrimaryOwnerUsername': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBaseSummaries (list) --
  
  A list of knowledge base summaries.
  - (dict) --
    
    A summary of a knowledge base, including its identifier, name, status, and metadata.
    - KnowledgeBaseArn (string) --
      
      The Amazon Resource Name (ARN) of the knowledge base.
    - KnowledgeBaseId (string) --
      
      The unique identifier for the knowledge base.
    - Name (string) --
      
      The name of the knowledge base.
    - Status (string) --
      
      The status of the knowledge base.
    - DataSourceArn (string) --
      
      The ARN of the data source associated with the knowledge base.
    - Type (string) --
      
      The type of the knowledge base.
    - CreatedAt (datetime) --
      
      The date and time that the knowledge base was created.
    - UpdatedAt (datetime) --
      
      The date and time that the knowledge base was last updated.
    - KnowledgeBaseSizeBytes (integer) --
      
      The size of the knowledge base in bytes.
    - DocumentCount (integer) --
      
      The number of documents in the knowledge base.
    - PrimaryOwnerArn (string) --
      
      The ARN of the primary owner of the knowledge base.
    - PrimaryOwnerUsername (string) --
      
      The username of the primary owner of the knowledge base.
- 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.
- Status (integer) --
  
  The HTTP status of the request.

UpdateKnowledgeBasePermissions (new)

Link ¶

Updates the resource permissions for a knowledge base.

See also: AWS API Documentation

Request Syntax

client.update_knowledge_base_permissions(
    AwsAccountId='string',
    KnowledgeBaseId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type KnowledgeBaseId:

string

param KnowledgeBaseId:

[REQUIRED]

The unique identifier for the knowledge base.

type GrantPermissions:

list

param GrantPermissions:

The resource permissions that you want to grant on the knowledge base.

(dict) --

Permission for the resource.
- Principal (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the principal. This can be one of the following:
  - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
  - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

type RevokePermissions:

list

param RevokePermissions:

The resource permissions that you want to revoke from the knowledge base.

(dict) --

Permission for the resource.
- Principal (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the principal. This can be one of the following:
  - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
  - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBaseArn (string) --
  
  The Amazon Resource Name (ARN) of the knowledge base.
- KnowledgeBaseId (string) --
  
  The unique identifier for the knowledge base.
- Permissions (list) --
  
  The resource permissions for the knowledge base.
  - (dict) --
    
    Permission for the resource.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
      - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

DeleteKnowledgeBase (new)

Link ¶

Deletes a knowledge base.

See also: AWS API Documentation

Request Syntax

client.delete_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type KnowledgeBaseId:

string

param KnowledgeBaseId:

[REQUIRED]

The unique identifier for the knowledge base.

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBaseArn (string) --
  
  The ARN of the deleted knowledge base.
- KnowledgeBaseId (string) --
  
  The ID of the deleted knowledge base.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

DescribeKnowledgeBase (new)

Link ¶

Describes a knowledge base.

See also: AWS API Documentation

Request Syntax

client.describe_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type KnowledgeBaseId:

string

param KnowledgeBaseId:

[REQUIRED]

The unique identifier for the knowledge base.

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBase': {
        'KnowledgeBaseArn': 'string',
        'KnowledgeBaseId': 'string',
        'Name': 'string',
        'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
        'DataSourceArn': 'string',
        'KnowledgeBaseConfiguration': {
            'templateConfiguration': {
                'template': {...}|[...]|123|123.4|'string'|True|None
            },
            'eventEnabled': True|False
        },
        'MediaExtractionConfiguration': {
            'imageExtractionConfiguration': {
                'imageExtractionStatus': 'ENABLED'|'DISABLED'
            },
            'audioExtractionConfiguration': {
                'audioExtractionStatus': 'ENABLED'|'DISABLED'
            },
            'videoExtractionConfiguration': {
                'videoExtractionStatus': 'ENABLED'|'DISABLED',
                'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
            }
        },
        'Type': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Description': 'string',
        'IsEmailNotificationOptedForIngestionFailures': True|False,
        'FirstCompletedIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'FirstIncompleteIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'LatestIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'KnowledgeBaseSizeBytes': 123,
        'DocumentCount': 123,
        'PrimaryOwnerArn': 'string',
        'PrimaryOwnerUsername': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBase (dict) --
  
  The knowledge base.
  - KnowledgeBaseArn (string) --
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - KnowledgeBaseId (string) --
    
    The unique identifier for the knowledge base.
  - Name (string) --
    
    The name of the knowledge base.
  - Status (string) --
    
    The status of the knowledge base.
  - DataSourceArn (string) --
    
    The ARN of the data source associated with the knowledge base.
  - KnowledgeBaseConfiguration (dict) --
    
    The configuration settings for the knowledge base.
    - templateConfiguration (dict) --
      
      The template configuration for the knowledge base.
      - template (:ref:`document<document>`) --
        
        The template document that defines the knowledge base behavior.
    - eventEnabled (boolean) --
      
      Indicates whether event notifications are enabled for the knowledge base.
  - MediaExtractionConfiguration (dict) --
    
    The media extraction configuration for the knowledge base.
    - imageExtractionConfiguration (dict) --
      
      The configuration for image extraction.
      - imageExtractionStatus (string) --
        
        The status of image extraction. Valid values are ENABLED and DISABLED.
    - audioExtractionConfiguration (dict) --
      
      The configuration for audio extraction.
      - audioExtractionStatus (string) --
        
        The status of audio extraction. Valid values are ENABLED and DISABLED.
    - videoExtractionConfiguration (dict) --
      
      The configuration for video extraction.
      - videoExtractionStatus (string) --
        
        The status of video extraction. Valid values are ENABLED and DISABLED.
      - videoExtractionType (string) --
        
        The type of video extraction to perform.
  - Type (string) --
    
    The type of the knowledge base.
  - CreatedAt (datetime) --
    
    The date and time that the knowledge base was created.
  - UpdatedAt (datetime) --
    
    The date and time that the knowledge base was last updated.
  - Description (string) --
    
    The description of the knowledge base.
  - IsEmailNotificationOptedForIngestionFailures (boolean) --
    
    Indicates whether email notifications are enabled for ingestion failures.
  - FirstCompletedIngestionSummary (dict) --
    
    A summary of the first completed ingestion for the knowledge base.
    - IngestionId (string) --
      
      The unique identifier for the ingestion job.
    - IngestionStatus (string) --
      
      The status of the ingestion job.
    - StartTime (datetime) --
      
      The start time of the ingestion job.
    - EndTime (datetime) --
      
      The end time of the ingestion job.
  - FirstIncompleteIngestionSummary (dict) --
    
    A summary of the first incomplete ingestion for the knowledge base.
    - IngestionId (string) --
      
      The unique identifier for the ingestion job.
    - IngestionStatus (string) --
      
      The status of the ingestion job.
    - StartTime (datetime) --
      
      The start time of the ingestion job.
    - EndTime (datetime) --
      
      The end time of the ingestion job.
  - LatestIngestionSummary (dict) --
    
    A summary of the most recent ingestion for the knowledge base.
    - IngestionId (string) --
      
      The unique identifier for the ingestion job.
    - IngestionStatus (string) --
      
      The status of the ingestion job.
    - StartTime (datetime) --
      
      The start time of the ingestion job.
    - EndTime (datetime) --
      
      The end time of the ingestion job.
  - KnowledgeBaseSizeBytes (integer) --
    
    The size of the knowledge base in bytes.
  - DocumentCount (integer) --
    
    The number of documents in the knowledge base.
  - PrimaryOwnerArn (string) --
    
    The ARN of the primary owner of the knowledge base.
  - PrimaryOwnerUsername (string) --
    
    The username of the primary owner of the knowledge base.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

SearchKnowledgeBases (new)

Link ¶

Searches for a subset of knowledge bases based on specified filters.

See also: AWS API Documentation

Request Syntax

client.search_knowledge_bases(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'name': 'KNOWLEDGE_BASE_ID'|'KNOWLEDGE_BASE_NAME'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'KNOWLEDGE_BASE_SIZE_BYTES'|'PRIMARY_OWNER',
            'operator': 'STRING_EQUALS'|'STRING_LIKE'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN_OR_EQUALS',
            'value': 'string'
        },
    ],
    SortBy={
        'sortByField': 'KNOWLEDGE_BASE_SIZE_BYTES'|'CREATED_AT',
        'sortOrder': 'ASC'|'DESC'
    }
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type Filters:

list

param Filters:

The filters to apply when searching knowledge bases.

(dict) --

A filter to apply when searching knowledge bases.
- name (string) -- [REQUIRED]
  
  The name of the field to filter on.
- operator (string) -- [REQUIRED]
  
  The comparison operator to use for the filter.
- value (string) -- [REQUIRED]
  
  The value to filter on.

type SortBy:

dict

param SortBy:

The sort configuration for the search results.

sortByField (string) -- [REQUIRED]

The field to sort by.
sortOrder (string) -- [REQUIRED]

The sort order (ascending or descending).

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBaseSummaries': [
        {
            'KnowledgeBaseArn': 'string',
            'KnowledgeBaseId': 'string',
            'Name': 'string',
            'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
            'DataSourceArn': 'string',
            'Type': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'KnowledgeBaseSizeBytes': 123,
            'DocumentCount': 123,
            'PrimaryOwnerArn': 'string',
            'PrimaryOwnerUsername': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBaseSummaries (list) --
  
  A list of knowledge base summaries.
  - (dict) --
    
    A summary of a knowledge base, including its identifier, name, status, and metadata.
    - KnowledgeBaseArn (string) --
      
      The Amazon Resource Name (ARN) of the knowledge base.
    - KnowledgeBaseId (string) --
      
      The unique identifier for the knowledge base.
    - Name (string) --
      
      The name of the knowledge base.
    - Status (string) --
      
      The status of the knowledge base.
    - DataSourceArn (string) --
      
      The ARN of the data source associated with the knowledge base.
    - Type (string) --
      
      The type of the knowledge base.
    - CreatedAt (datetime) --
      
      The date and time that the knowledge base was created.
    - UpdatedAt (datetime) --
      
      The date and time that the knowledge base was last updated.
    - KnowledgeBaseSizeBytes (integer) --
      
      The size of the knowledge base in bytes.
    - DocumentCount (integer) --
      
      The number of documents in the knowledge base.
    - PrimaryOwnerArn (string) --
      
      The ARN of the primary owner of the knowledge base.
    - PrimaryOwnerUsername (string) --
      
      The username of the primary owner of the knowledge base.
- 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.
- Status (integer) --
  
  The HTTP status of the request.

DescribeKnowledgeBasePermissions (new)

Link ¶

Describes the resource permissions for a knowledge base.

See also: AWS API Documentation

Request Syntax

client.describe_knowledge_base_permissions(
    AwsAccountId='string',
    KnowledgeBaseId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.

type KnowledgeBaseId:

string

param KnowledgeBaseId:

[REQUIRED]

The unique identifier for the knowledge base.

rtype:

dict

returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- KnowledgeBaseArn (string) --
  
  The Amazon Resource Name (ARN) of the knowledge base.
- KnowledgeBaseId (string) --
  
  The unique identifier for the knowledge base.
- Permissions (list) --
  
  The resource permissions for the knowledge base.
  - (dict) --
    
    Permission for the resource.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
      - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.
- Status (integer) --
  
  The HTTP status of the request.

ListUsersIndexCapacity (new)

Link ¶

Lists per-user index capacity consumption for an account.

See also: AWS API Documentation

Request Syntax

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'
)

type awsAccountId:

string

param awsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the index capacity data.

type namespace:

string

param namespace:

The namespace to scope the user search to. Required when the userNameOrEmail filter is present.

type filters:

list

param filters:

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.

type sortBy:

string

param sortBy:

The field to sort results by.

type sortOrder:

string

param sortOrder:

The sort order for results. Defaults to DESC if not specified.

type maxResults:

integer

param maxResults:

The maximum number of results to return per page.

type nextToken:

string

param nextToken:

The token for the next set of results, received from a previous call.

rtype:

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.