list_data_sources¶
Operation¶
list_data_sources
async
¶
list_data_sources(input: ListDataSourcesInput, plugins: list[Plugin] | None = None) -> ListDataSourcesOutput
Lists the Amazon Q Business data source connectors that you have created.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDataSourcesInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListDataSourcesOutput
|
An instance of |
Input¶
ListDataSourcesInput
dataclass
¶
Dataclass for ListDataSourcesInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to the data source connectors.
index_id
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index used with one or more data source connectors.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of data source connectors to return.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
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.
Output¶
ListDataSourcesOutput
dataclass
¶
Dataclass for ListDataSourcesOutput structure.
Attributes¶
data_sources
class-attribute
instance-attribute
¶
data_sources: list[DataSource] | None = None
An array of summary information for one or more data source connector.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
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.