Skip to content

GetRetrieverResponse

Source code in docs_src/capo_qbusiness/types/get_retriever_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class GetRetrieverResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_qbusiness.types.application_id.ApplicationId"]
    """<p>The identifier of the Amazon Q Business application using the retriever. </p>"""
    retriever_id: NotRequired["capo_qbusiness.types.retriever_id.RetrieverId"]
    """<p>The identifier of the retriever.</p>"""
    retriever_arn: NotRequired["capo_qbusiness.types.retriever_arn.RetrieverArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role associated with the retriever.</p>"""
    type: NotRequired["capo_qbusiness.types.retriever_type.RetrieverType"]
    """<p>The type of the retriever.</p>"""
    status: NotRequired["capo_qbusiness.types.retriever_status.RetrieverStatus"]
    """<p>The status of the retriever.</p>"""
    display_name: NotRequired["capo_qbusiness.types.retriever_name.RetrieverName"]
    """<p>The name of the retriever.</p>"""
    configuration: NotRequired[
        "capo_qbusiness.types.retriever_configuration.RetrieverConfiguration"
    ]
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.</p>"""
    created_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the retriever was created.</p>"""
    updated_at: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the retriever was last updated.</p>"""

application_id instance-attribute 

application_id: NotRequired[ApplicationId]

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

configuration instance-attribute 

configuration: NotRequired[RetrieverConfiguration]

created_at instance-attribute 

created_at: NotRequired[Timestamp]

The Unix timestamp when the retriever was created.

display_name instance-attribute 

display_name: NotRequired[RetrieverName]

The name of the retriever.

retriever_arn instance-attribute 

retriever_arn: NotRequired[RetrieverArn]

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

retriever_id instance-attribute 

retriever_id: NotRequired[RetrieverId]

The identifier of the retriever.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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

status instance-attribute 

status: NotRequired[RetrieverStatus]

The status of the retriever.

type instance-attribute 

type: NotRequired[RetrieverType]

The type of the retriever.

updated_at instance-attribute 

updated_at: NotRequired[Timestamp]

The Unix timestamp when the retriever was last updated.