Qbusiness  >  Operations  >  delete_retriever

delete_retriever

Operation

delete_retriever async

delete_retriever(input: DeleteRetrieverInput, plugins: list[Plugin] | None = None) -> DeleteRetrieverOutput

Deletes the retriever used by an Amazon Q Business application.

Parameters:

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

Input

DeleteRetrieverInput dataclass

Dataclass for DeleteRetrieverInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

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

retriever_id class-attribute instance-attribute

retriever_id: str | None = None

The identifier of the retriever being deleted.

Output

DeleteRetrieverOutput dataclass

Dataclass for DeleteRetrieverOutput structure.