QuickSight / Paginator / ListKnowledgeBases

ListKnowledgeBases

class QuickSight.Paginator.ListKnowledgeBases

paginator = client.get_paginator('list_knowledge_bases')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QuickSight.Client.list_knowledge_bases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],
    '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.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the request.