Skip to content

list_retrievers

Operation

list_retrievers

list_retrievers(request: ListRetrieversInput | ListRetrieversInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrieversInputDict]) -> ListRetrieversOutput

Lists the retriever used by an Amazon Q Business application.

Parameters:

Name Type Description Default
request ListRetrieversInput | ListRetrieversInputDict | 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[ListRetrieversInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRetrieversOutput

An instance of ListRetrieversOutput.

list_retrievers async

list_retrievers(request: ListRetrieversInput | ListRetrieversInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrieversInputDict]) -> ListRetrieversOutput

Lists the retriever used by an Amazon Q Business application.

Parameters:

Name Type Description Default
request ListRetrieversInput | ListRetrieversInputDict | 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[ListRetrieversInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListRetrieversOutput

An instance of ListRetrieversOutput.

Input

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

ListRetrieversInputDict

Bases: TypedDict

Dictionary form of ListRetrieversInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application using the retriever.

max_results instance-attribute
max_results: int | None

The maximum number of retrievers returned.

next_token instance-attribute
next_token: str | None

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

ListRetrieversInput dataclass

Bases: _SerdeShape

Dataclass for ListRetrieversInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application using the retriever.

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

The maximum number of retrievers returned.

next_token class-attribute instance-attribute
next_token: str | None = ...

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.

Output

ListRetrieversOutput dataclass

Bases: _SerdeShape

Dataclass for ListRetrieversOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.

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.

retrievers class-attribute instance-attribute
retrievers: list[Retriever] | None = ...

An array of summary information for one or more retrievers.