Qbusiness  >  Operations  >  get_retriever

get_retriever

Operation

get_retriever async

get_retriever(input: GetRetrieverInput, plugins: list[Plugin] | None = None) -> GetRetrieverOutput

Gets information about an existing retriever used by an Amazon Q Business application.

Parameters:

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

Input

GetRetrieverInput dataclass

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

Output

GetRetrieverOutput dataclass

Dataclass for GetRetrieverOutput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

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

configuration class-attribute instance-attribute

configuration: RetrieverConfiguration | None = None

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

created_at class-attribute instance-attribute

created_at: datetime | None = None

The Unix timestamp when the retriever was created.

display_name class-attribute instance-attribute

display_name: str | None = None

The name of the retriever.

retriever_arn class-attribute instance-attribute

retriever_arn: str | None = None

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

retriever_id class-attribute instance-attribute

retriever_id: str | None = None

The identifier of the retriever.

role_arn class-attribute instance-attribute

role_arn: str | None = None

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

status class-attribute instance-attribute

status: RetrieverStatus | None = None

The status of the retriever.

type class-attribute instance-attribute

type: RetrieverType | None = None

The type of the retriever.

updated_at class-attribute instance-attribute

updated_at: datetime | None = None

The Unix timestamp when the retriever was last updated.