Start Import Job

connectwisdomservice_start_import_job

R Documentation

Start an asynchronous job to import Wisdom resources from an uploaded source file

Description

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use start_content_upload to upload an asset that contains the resource data.

• For importing Wisdom 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.

Usage

connectwisdomservice_start_import_job(clientToken,
  externalSourceConfiguration, importJobType, knowledgeBaseId, metadata,
  uploadId)

Arguments

clientToken

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

externalSourceConfiguration

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

importJobType

[required] The type of the import job.

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

knowledgeBaseId

[required] The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

• For importing Wisdom quick responses, this should be a QUICK_RESPONSES type knowledge base.

metadata

The metadata fields of the imported Wisdom resources.

uploadId

[required] A pointer to the uploaded asset. This value is returned by start_content_upload.

Value

A list with the following syntax:

list(
  importJob = list(
    createdTime = as.POSIXct(
      "2015-01-01"
    ),
    externalSourceConfiguration = list(
      configuration = list(
        connectConfiguration = list(
          instanceId = "string"
        )
      ),
      source = "AMAZON_CONNECT"
    ),
    failedRecordReport = "string",
    importJobId = "string",
    importJobType = "QUICK_RESPONSES",
    knowledgeBaseArn = "string",
    knowledgeBaseId = "string",
    lastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    metadata = list(
      "string"
    ),
    status = "START_IN_PROGRESS"|"FAILED"|"COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETED",
    uploadId = "string",
    url = "string",
    urlExpiry = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$start_import_job(
  clientToken = "string",
  externalSourceConfiguration = list(
    configuration = list(
      connectConfiguration = list(
        instanceId = "string"
      )
    ),
    source = "AMAZON_CONNECT"
  ),
  importJobType = "QUICK_RESPONSES",
  knowledgeBaseId = "string",
  metadata = list(
    "string"
  ),
  uploadId = "string"
)