Skip to content

get_retriever

Operation

get_retriever

get_retriever(request: GetRetrieverInput | GetRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRetrieverInputDict]) -> GetRetrieverOutput

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

Parameters:

Name Type Description Default
request GetRetrieverInput | GetRetrieverInputDict | 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[GetRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRetrieverOutput

An instance of GetRetrieverOutput.

get_retriever async

get_retriever(request: GetRetrieverInput | GetRetrieverInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRetrieverInputDict]) -> GetRetrieverOutput

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

Parameters:

Name Type Description Default
request GetRetrieverInput | GetRetrieverInputDict | 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[GetRetrieverInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRetrieverOutput

An instance of GetRetrieverOutput.

Input

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

GetRetrieverInputDict

Bases: TypedDict

Dictionary form of GetRetrieverInput.

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.

GetRetrieverInput dataclass

Bases: _SerdeShape

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

Output

GetRetrieverOutput dataclass

Bases: _SerdeShape

Dataclass for GetRetrieverOutput structure.

Attributes

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

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

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

The Unix timestamp when the retriever was created.

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

The name of the retriever.

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.

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

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

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

The identifier of the retriever.

role_arn class-attribute instance-attribute
role_arn: str | 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: str | None = ...

The status of the retriever.

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

The type of the retriever.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The Unix timestamp when the retriever was last updated.