Skip to content

list_data_sources

Operation

list_data_sources

list_data_sources(request: ListDataSourcesInput | ListDataSourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataSourcesInputDict]) -> ListDataSourcesOutput

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

Parameters:

Name Type Description Default
request ListDataSourcesInput | ListDataSourcesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDataSourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataSourcesOutput

An instance of ListDataSourcesOutput.

list_data_sources async

list_data_sources(request: ListDataSourcesInput | ListDataSourcesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataSourcesInputDict]) -> ListDataSourcesOutput

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

Parameters:

Name Type Description Default
request ListDataSourcesInput | ListDataSourcesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDataSourcesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataSourcesOutput

An instance of ListDataSourcesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListDataSourcesInputDict

Bases: TypedDict

Dictionary form of ListDataSourcesInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application linked to the data source connectors.

index_id instance-attribute
index_id: Required[str]

The identifier of the index used with one or more data source connectors.

max_results instance-attribute
max_results: int | None

The maximum number of data source connectors to return.

next_token instance-attribute
next_token: str | 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.

ListDataSourcesInput dataclass

Bases: _SerdeShape

Dataclass for ListDataSourcesInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

The identifier of the index used with one or more data source connectors.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of data source connectors to return.

next_token class-attribute instance-attribute
next_token: str | 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

Bases: _SerdeShape

Dataclass for ListDataSourcesOutput structure.

Attributes

data_sources class-attribute instance-attribute
data_sources: list[DataSource] | None = ...

An array of summary information for one or more data source connector.

next_token class-attribute instance-attribute
next_token: str | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.