Skip to content

QBusiness  >  Operations  >  create_retriever

create_retriever

Operation

create_retriever async 

create_retriever(input: CreateRetrieverInput, plugins: list[Plugin] | None = None) -> CreateRetrieverOutput

Adds a retriever to your Amazon Q Business application.

Parameters:

Name Type Description Default
input CreateRetrieverInput

An instance of CreateRetrieverInput.

 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
CreateRetrieverOutput

An instance of CreateRetrieverOutput.

Input

CreateRetrieverInput dataclass

Dataclass for CreateRetrieverInput structure.

Attributes

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

The identifier of your Amazon Q Business application.

client_token class-attribute instance-attribute 
client_token: str | None = None

A token that you provide to identify the request to create your Amazon Q Business application 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.

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

The name of your retriever.

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

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

tags class-attribute instance-attribute 
tags: list[Tag] | None = None

A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

The type of retriever you are using.

Output

CreateRetrieverOutput dataclass

Dataclass for CreateRetrieverOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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 = None

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

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

The identifier of the retriever you are using.