QBusiness / Client / list_data_sources

list_data_sources#

QBusiness.Client.list_data_sources(**kwargs)#

Lists the Amazon Q Business data source connectors that you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_data_sources(
    applicationId='string',
    indexId='string',
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.

  • maxResults (integer) – The maximum number of data source connectors to return.

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) –

      If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.

Exceptions