AgentsforBedrock / Client / list_data_sources

list_data_sources#

AgentsforBedrock.Client.list_data_sources(**kwargs)#

Lists the data sources in a knowledge base and information about each one.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sources(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • knowledgeBaseId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'dataSourceSummaries': [
        {
            'dataSourceId': 'string',
            'description': 'string',
            'knowledgeBaseId': 'string',
            'name': 'string',
            'status': 'AVAILABLE'|'DELETING'|'DELETE_UNSUCCESSFUL',
            '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) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions