QBusiness / Paginator / ListDataSources

ListDataSources#

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

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

See also: AWS API Documentation

Request Syntax

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

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application linked to the data source connectors.

  • indexId (string) –

    [REQUIRED]

    The identifier of the index used with one or more data source connectors.

  • 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

{
    'dataSources': [
        {
            'displayName': 'string',
            'dataSourceId': 'string',
            'type': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'PENDING_CREATION'|'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • dataSources (list) –

      An array of summary information for one or more data source connector.

      • (dict) –

        A data source in an Amazon Q Business application.

        • displayName (string) –

          The name of the Amazon Q Business data source.

        • dataSourceId (string) –

          The identifier of the Amazon Q Business data source.

        • type (string) –

          The type of the Amazon Q Business data source.

        • createdAt (datetime) –

          The Unix timestamp when the Amazon Q Business data source was created.

        • updatedAt (datetime) –

          The Unix timestamp when the Amazon Q Business data source was last updated.

        • status (string) –

          The status of the Amazon Q Business data source.

    • NextToken (string) –

      A token to resume pagination.