AgentsforBedrock / Paginator / ListDataSources

ListDataSources#

class AgentsforBedrock.Paginator.ListDataSources#
paginator = client.get_paginator('list_data_sources')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_data_sources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • knowledgeBaseId (string) –

    [REQUIRED]

    The unique identifier of the knowledge base for which to return a list of information.

  • 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

{
    'dataSourceSummaries': [
        {
            'dataSourceId': 'string',
            'description': 'string',
            'knowledgeBaseId': 'string',
            'name': 'string',
            'status': 'AVAILABLE'|'DELETING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • dataSourceSummaries (list) –

      A list of objects, each of which contains information about a data source.

      • (dict) –

        Contains details about a data source.

        • dataSourceId (string) –

          The unique identifier of the data source.

        • description (string) –

          The description of the data source.

        • knowledgeBaseId (string) –

          The unique identifier of the knowledge base to which the data source belongs.

        • name (string) –

          The name of the data source.

        • status (string) –

          The status of the data source.

        • updatedAt (datetime) –

          The time at which the data source was last updated.

    • NextToken (string) –

      A token to resume pagination.