Skip to content

UpdateRetrieverRequest

Source code in docs_src/capo_qbusiness/types/update_retriever_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
class UpdateRetrieverRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of your Amazon Q Business application.</p>"""
    retriever_id: "capo_qbusiness.types.retriever_id.RetrieverId"
    """<p>The identifier of your retriever.</p>"""
    configuration: NotRequired[
        "capo_qbusiness.types.retriever_configuration.RetrieverConfiguration"
    ]
    display_name: NotRequired["capo_qbusiness.types.retriever_name.RetrieverName"]
    """<p>The name of your retriever.</p>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources. </p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of your Amazon Q Business application.

configuration instance-attribute 

configuration: NotRequired[RetrieverConfiguration]

display_name instance-attribute 

display_name: NotRequired[RetrieverName]

The name of your retriever.

retriever_id instance-attribute 

retriever_id: RetrieverId

The identifier of your retriever.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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