Skip to content

StartImportJobRequest

Source code in docs_src/capo_qconnect/types/start_import_job_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class StartImportJobRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p> <ul> <li> <p>For importing Amazon Q in Connect quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p> </li> </ul>"""
    import_job_type: "capo_qconnect.types.import_job_type.ImportJobType"
    """<p>The type of the import job.</p> <ul> <li> <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p> </li> </ul>"""
    upload_id: "capo_qconnect.types.upload_id.UploadId"
    """<p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>"""
    client_token: NotRequired["capo_qconnect.types.non_empty_string.NonEmptyString"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    metadata: NotRequired["capo_qconnect.types.content_metadata.ContentMetadata"]
    """<p>The metadata fields of the imported Amazon Q in Connect resources.</p>"""
    external_source_configuration: NotRequired[
        "capo_qconnect.types.external_source_configuration.ExternalSourceConfiguration"
    ]
    """<p>The configuration information of the external source that the resource data are imported from.</p>"""

client_token instance-attribute 

client_token: NotRequired[NonEmptyString]

The tags used to organize, track, or control access for this resource.

external_source_configuration instance-attribute 

external_source_configuration: NotRequired[ExternalSourceConfiguration]

The configuration information of the external source that the resource data are imported from.

import_job_type instance-attribute 

import_job_type: ImportJobType

The type of the import job.

  • For importing quick response resource, set the value to QUICK_RESPONSES.

knowledge_base_id instance-attribute 

knowledge_base_id: UuidOrArn

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

metadata instance-attribute 

metadata: NotRequired[ContentMetadata]

The metadata fields of the imported Amazon Q in Connect resources.

upload_id instance-attribute 

upload_id: UploadId

A pointer to the uploaded asset. This value is returned by StartContentUpload.