Skip to content

ImportDocumentInput

Source code in docs_src/capo_qapps/types/import_document_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class ImportDocumentInput(TypedDict, closed=True):
    instance_id: "capo_qapps.types.instance_id.InstanceId"
    """<p>The unique identifier of the Amazon Q Business application environment instance.</p>"""
    card_id: "capo_qapps.types.uuid.UUID"
    """<p>The unique identifier of the card the file is associated with.</p>"""
    app_id: "capo_qapps.types.uuid.UUID"
    """<p>The unique identifier of the Q App the file is associated with.</p>"""
    file_contents_base64: "str"
    """<p>The base64-encoded contents of the file to upload.</p>"""
    file_name: "capo_qapps.types.filename.Filename"
    """<p>The name of the file being uploaded.</p>"""
    scope: "capo_qapps.types.document_scope.DocumentScope"
    """<p>Whether the file is associated with a Q App definition or a specific Q App session.</p>"""
    session_id: NotRequired["capo_qapps.types.uuid.UUID"]
    """<p>The unique identifier of the Q App session the file is associated with, if applicable.</p>"""

app_id instance-attribute 

app_id: UUID

The unique identifier of the Q App the file is associated with.

card_id instance-attribute 

card_id: UUID

The unique identifier of the card the file is associated with.

file_contents_base64 instance-attribute 

file_contents_base64: str

The base64-encoded contents of the file to upload.

file_name instance-attribute 

file_name: Filename

The name of the file being uploaded.

instance_id instance-attribute 

instance_id: InstanceId

The unique identifier of the Amazon Q Business application environment instance.

scope instance-attribute 

scope: DocumentScope

Whether the file is associated with a Q App definition or a specific Q App session.

session_id instance-attribute 

session_id: NotRequired[UUID]

The unique identifier of the Q App session the file is associated with, if applicable.