Skip to content

update_retriever

Operation

update_retriever

update_retriever(request: UpdateRetrieverInput | UpdateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrieverInputDict]) -> UpdateRetrieverOutput

Updates the retriever used for your Amazon Q Business application.

Parameters:

Name Type Description Default
request UpdateRetrieverInput | UpdateRetrieverInputDict | 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[UpdateRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRetrieverOutput

An instance of UpdateRetrieverOutput.

update_retriever async

update_retriever(request: UpdateRetrieverInput | UpdateRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrieverInputDict]) -> UpdateRetrieverOutput

Updates the retriever used for your Amazon Q Business application.

Parameters:

Name Type Description Default
request UpdateRetrieverInput | UpdateRetrieverInputDict | 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[UpdateRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRetrieverOutput

An instance of UpdateRetrieverOutput.

Input

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

UpdateRetrieverInputDict

Bases: TypedDict

Dictionary form of UpdateRetrieverInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of your Amazon Q Business application.

configuration instance-attribute

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

display_name instance-attribute
display_name: str | None

The name of your retriever.

retriever_id instance-attribute
retriever_id: Required[str]

The identifier of your retriever.

role_arn instance-attribute
role_arn: str | None

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

UpdateRetrieverInput dataclass

Bases: _SerdeShape

Dataclass for UpdateRetrieverInput structure.

Attributes

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

The identifier of your Amazon Q Business application.

configuration class-attribute instance-attribute
configuration: RetrieverConfiguration | 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 = ...

The name of your retriever.

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

The identifier of your retriever.

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

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

Output

UpdateRetrieverOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateRetrieverOutput 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.