QuickSight / Client / search_knowledge_bases

search_knowledge_bases¶

QuickSight.Client.search_knowledge_bases(**kwargs)¶

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

Request Syntax

response = 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'
    }
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the knowledge base.
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to return.
Filters (list) –
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.
SortBy (dict) –
The sort configuration for the search results.
- sortByField (string) – [REQUIRED]
  
  The field to sort by.
- sortOrder (string) – [REQUIRED]
  
  The sort order (ascending or descending).

Return type:

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.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException