import_jobs

Creates, updates, deletes, gets or lists an import_jobs resource.

Overview

Name	import_jobs
Type	Resource
Id	aws.wisdom.import_jobs

Fields

The following fields are returned by SELECT queries:

get_import_job

Name	Datatype	Description
created_time	string (date-time)	The timestamp when the import job was created.
external_source_configuration	object	The configuration information of the external data source.
failed_record_report	string	The link to donwload the information of resource data that failed to be imported.
import_job_id	string	The identifier of the import job. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
import_job_type	string	The type of the import job. (QUICK_RESPONSES)
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>^arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$</code>)
knowledge_base_id	string	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. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
last_modified_time	string (date-time)	The timestamp when the import job data was last modified.
metadata	object	The metadata fields of the imported Wisdom resources.
status	string	The status of the import job. (START_IN_PROGRESS, FAILED, COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED)
upload_id	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.
url_expiry	string (date-time)	The expiration time of the URL as an epoch timestamp.

list_import_jobs

Name	Datatype	Description
created_time	string (date-time)	The timestamp when the import job was created.
external_source_configuration	object	The configuration information of the external data source.
import_job_id	string	The identifier of the import job. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
import_job_type	string	The type of import job. (QUICK_RESPONSES)
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>^arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$</code>)
knowledge_base_id	string	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. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
last_modified_time	string (date-time)	The timestamp when the import job was last modified.
metadata	object	The metadata fields of the imported Wisdom resources.
status	string	The status of the import job. (START_IN_PROGRESS, FAILED, COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED)
upload_id	string	A pointer to the uploaded asset. This value is returned by StartContentUpload.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_import_job	select	import_job_id, knowledge_base_id, region		Retrieves the started import job.
list_import_jobs	select	knowledge_base_id, region	maxResults, nextToken	Lists information about import jobs.
delete_import_job	delete	import_job_id, knowledge_base_id, region		Deletes the quick response import job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
import_job_id	string	The identifier of the import job to be deleted.
knowledge_base_id	string	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.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_import_job

Retrieves the started import job.

SELECT
created_time,
external_source_configuration,
failed_record_report,
import_job_id,
import_job_type,
knowledge_base_arn,
knowledge_base_id,
last_modified_time,
metadata,
status,
upload_id,
url,
url_expiry
FROM aws.wisdom.import_jobs
WHERE import_job_id = '{{ import_job_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;

list_import_jobs

Lists information about import jobs.

SELECT
created_time,
external_source_configuration,
import_job_id,
import_job_type,
knowledge_base_arn,
knowledge_base_id,
last_modified_time,
metadata,
status,
upload_id
FROM aws.wisdom.import_jobs
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_import_job

Deletes the quick response import job.

DELETE FROM aws.wisdom.import_jobs
WHERE import_job_id = '{{ import_job_id }}' --required
AND knowledge_base_id = '{{ knowledge_base_id }}' --required
AND region = '{{ region }}' --required
;