QConnect / Client / get_import_job

get_import_job

QConnect.Client.get_import_job(**kwargs)

Retrieves the started import job.

See also: AWS API Documentation

Request Syntax

response = client.get_import_job(
    importJobId='string',
    knowledgeBaseId='string'
)
Parameters:

  • importJobId (string) –

    [REQUIRED]

    The identifier of the import job to retrieve.

  • knowledgeBaseId (string) –

    [REQUIRED]

    The identifier of the knowledge base that the import job belongs to.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • importJob (dict) –

      The import job.

      • importJobId (string) –

        The identifier of the import job.

      • knowledgeBaseId (string) –

        The identifier of the knowledge base.

      • uploadId (string) –

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

      • knowledgeBaseArn (string) –

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

      • importJobType (string) –

        The type of the import job.

      • status (string) –

        The status of the import job.

      • url (string) –

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

      • failedRecordReport (string) –

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

      • urlExpiry (datetime) –

        The expiration time of the URL as an epoch timestamp.

      • createdTime (datetime) –

        The timestamp when the import job was created.

      • 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) –

      • externalSourceConfiguration (dict) –

        The configuration information of the external data source.

        • source (string) –

          The type 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.

Exceptions