QuickSight / Client / list_knowledge_bases

list_knowledge_bases

QuickSight.Client.list_knowledge_bases(**kwargs)

Lists all knowledge bases in an Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

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

  • AwsAccountId (string) –

    [REQUIRED]

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

  • MaxResults (integer) – The maximum number of results to return.

  • NextToken (string) – The token for the next set of results, or null if there are no more results.

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