list_data_sources¶
Operation¶
list_data_sources
async
¶
list_data_sources(input: ListDataSourcesInput, plugins: list[Plugin] | None = None) -> ListDataSourcesOutput
Lists the data sources in a knowledge base and information about each one.
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¶
knowledge_base_id
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base for which to return a list of information.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
Output¶
ListDataSourcesOutput
dataclass
¶
Dataclass for ListDataSourcesOutput structure.
Attributes¶
data_source_summaries
instance-attribute
¶
data_source_summaries: list[DataSourceSummary]
A list of objects, each of which contains information about a data source.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.