QBusiness / Client / list_data_sources
list_data_sources#
- QBusiness.Client.list_data_sources(**kwargs)#
Lists the Amazon Q data source connectors that you have created.
See also: AWS API Documentation
Request Syntax
response = client.list_data_sources( applicationId='string', indexId='string', maxResults=123, nextToken='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.
maxResults (integer) – The maximum number of data source connectors to return.
nextToken (string) – If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q data source connectors.
- 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) –
If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
Exceptions
QBusiness.Client.exceptions.ResourceNotFoundException
QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException