Skip to content

CreateRetrieverRequest

Source code in docs_src/capo_qbusiness/types/create_retriever_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateRetrieverRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of your Amazon Q Business application.</p>"""
    type: "capo_qbusiness.types.retriever_type.RetrieverType"
    """<p>The type of retriever you are using.</p>"""
    display_name: "capo_qbusiness.types.retriever_name.RetrieverName"
    """<p>The name of your retriever.</p>"""
    configuration: "capo_qbusiness.types.retriever_configuration.RetrieverConfiguration"
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A token that you provide to identify the request to create your Amazon Q Business application retriever.</p>"""
    tags: NotRequired["capo_qbusiness.types.tags.Tags"]
    """<p>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: _ . : / = + - @.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of your Amazon Q Business application.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

A token that you provide to identify the request to create your Amazon Q Business application retriever.

configuration instance-attribute 

configuration: RetrieverConfiguration

display_name instance-attribute 

display_name: RetrieverName

The name of your retriever.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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

tags instance-attribute 

tags: NotRequired[Tags]

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 instance-attribute 

type: RetrieverType

The type of retriever you are using.