Qbusiness  >  Operations  >  update_retriever

update_retriever

Operation

update_retriever async

update_retriever(input: UpdateRetrieverInput, plugins: list[Plugin] | None = None) -> UpdateRetrieverOutput

Updates the retriever used for your Amazon Q Business application.

Parameters:

Name	Type	Description	Default
input	UpdateRetrieverInput	An instance of UpdateRetrieverInput.	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
UpdateRetrieverOutput	An instance of UpdateRetrieverOutput.

Input

UpdateRetrieverInput dataclass

Dataclass for UpdateRetrieverInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of your Amazon Q Business application.

configuration class-attribute instance-attribute

configuration: RetrieverConfiguration | None = None

Provides information on how the retriever used for your Amazon Q Business application is configured.

display_name class-attribute instance-attribute

display_name: str | None = None

The name of your retriever.

retriever_id class-attribute instance-attribute

retriever_id: str | None = None

The identifier of your retriever.

role_arn class-attribute instance-attribute

role_arn: str | None = None

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

Output

UpdateRetrieverOutput dataclass

Dataclass for UpdateRetrieverOutput structure.