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 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': [ { 'createdAt': datetime(2015, 1, 1), 'dataSourceId': 'string', 'displayName': 'string', 'status': 'PENDING_CREATION'|'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], '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 application.
createdAt (datetime) –
The Unix timestamp when the Amazon Q data source was created.
dataSourceId (string) –
The identifier of the Amazon Q data source.
displayName (string) –
The name of the Amazon Q data source.
status (string) –
The status of the Amazon Q data source.
type (string) –
The type of the Amazon Q data source.
updatedAt (datetime) –
The Unix timestamp when the Amazon Q data source was last updated.
NextToken (string) –
A token to resume pagination.