Skip to content

delete_retriever

Operation

delete_retriever

delete_retriever(request: DeleteRetrieverInput | DeleteRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRetrieverInputDict]) -> DeleteRetrieverOutput

Deletes the retriever used by an Amazon Q Business application.

Parameters:

Name Type Description Default
request DeleteRetrieverInput | DeleteRetrieverInputDict | 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[DeleteRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRetrieverOutput

An instance of DeleteRetrieverOutput.

delete_retriever async

delete_retriever(request: DeleteRetrieverInput | DeleteRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRetrieverInputDict]) -> DeleteRetrieverOutput

Deletes the retriever used by an Amazon Q Business application.

Parameters:

Name Type Description Default
request DeleteRetrieverInput | DeleteRetrieverInputDict | 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[DeleteRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRetrieverOutput

An instance of DeleteRetrieverOutput.

Input

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

DeleteRetrieverInputDict

Bases: TypedDict

Dictionary form of DeleteRetrieverInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

retriever_id instance-attribute
retriever_id: Required[str]

The identifier of the retriever being deleted.

DeleteRetrieverInput dataclass

Bases: _SerdeShape

Dataclass for DeleteRetrieverInput structure.

Attributes

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

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

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

The identifier of the retriever being deleted.

Output

DeleteRetrieverOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteRetrieverOutput structure.

Attributes

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.