Skip to content

QBusiness  >  Operations  >  list_retrievers

list_retrievers

Operation

list_retrievers async 

list_retrievers(input: ListRetrieversInput, plugins: list[Plugin] | None = None) -> ListRetrieversOutput

Lists the retriever used by an Amazon Q Business application.

Parameters:

Name Type Description Default
input ListRetrieversInput

An instance of ListRetrieversInput.

 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
ListRetrieversOutput

An instance of ListRetrieversOutput.

Input

ListRetrieversInput dataclass

Dataclass for ListRetrieversInput structure.

Attributes

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

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

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

The maximum number of retrievers returned.

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

Dataclass for ListRetrieversOutput structure.

Attributes

next_token class-attribute instance-attribute 
next_token: str | None = 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 = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 = None

An array of summary information for one or more retrievers.