QConnect / Client / start_import_job

start_import_job#

QConnect.Client.start_import_job(**kwargs)#

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

  • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

See also: AWS API Documentation

Request Syntax

response = client.start_import_job(
    clientToken='string',
    externalSourceConfiguration={
        'configuration': {
            'connectConfiguration': {
                'instanceId': 'string'
            }
        },
        'source': 'AMAZON_CONNECT'
    },
    importJobType='QUICK_RESPONSES',
    knowledgeBaseId='string',
    metadata={
        'string': 'string'
    },
    uploadId='string'
)
Parameters:

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • externalSourceConfiguration (dict) –

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

    • configuration (dict) – [REQUIRED]

      The configuration information of the external data source.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: connectConfiguration.

      • connectConfiguration (dict) –

        The configuration information of the Amazon Connect data source.

        • instanceId (string) –

          The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

    • source (string) – [REQUIRED]

      The type of the external data source.

  • importJobType (string) –

    [REQUIRED]

    The type of the import job.

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

  • knowledgeBaseId (string) –

    [REQUIRED]

    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 (dict) –

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

    • (string) –

      • (string) –

  • uploadId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'importJob': {
        'createdTime': datetime(2015, 1, 1),
        'externalSourceConfiguration': {
            'configuration': {
                'connectConfiguration': {
                    'instanceId': 'string'
                }
            },
            'source': 'AMAZON_CONNECT'
        },
        'failedRecordReport': 'string',
        'importJobId': 'string',
        'importJobType': 'QUICK_RESPONSES',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'lastModifiedTime': datetime(2015, 1, 1),
        'metadata': {
            'string': 'string'
        },
        'status': 'START_IN_PROGRESS'|'FAILED'|'COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
        'uploadId': 'string',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • importJob (dict) –

      The import job.

      • createdTime (datetime) –

        The timestamp when the import job was created.

      • externalSourceConfiguration (dict) –

        The configuration information of the external data source.

        • configuration (dict) –

          The configuration information of the external data source.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: connectConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • connectConfiguration (dict) –

            The configuration information of the Amazon Connect data source.

            • instanceId (string) –

              The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • source (string) –

          The type of the external data source.

      • failedRecordReport (string) –

        The link to donwload the information of resource data that failed to be imported.

      • importJobId (string) –

        The identifier of the import job.

      • importJobType (string) –

        The type of the import job.

      • knowledgeBaseArn (string) –

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId (string) –

        The identifier of the knowledge base.

      • lastModifiedTime (datetime) –

        The timestamp when the import job data was last modified.

      • metadata (dict) –

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

        • (string) –

          • (string) –

      • status (string) –

        The status of the import job.

      • uploadId (string) –

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

      • url (string) –

        The download link to the resource file that is uploaded to the import job.

      • urlExpiry (datetime) –

        The expiration time of the URL as an epoch timestamp.

Exceptions