reference_import_jobs

Creates, updates, deletes, gets or lists a reference_import_jobs resource.

Overview

Name	reference_import_jobs
Type	Resource
Id	aws.omics.reference_import_jobs

Fields

The following fields are returned by SELECT queries:

get_reference_import_job

Name	Datatype	Description
id	string	The job's ID. (pattern: <code>[0-9]+</code>)
completion_time	string (date-time)	When the job completed.
creation_time	string (date-time)	When the job was created.
reference_store_id	string	The job's reference store ID. (pattern: <code>[0-9]+</code>)
role_arn	string	The job's service role ARN. (pattern: <code>arn:.*</code>)
sources	array	The job's source files.
status	string	The job's status. (SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES)
status_message	string	The job's status message. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

list_reference_import_jobs

Name	Datatype	Description
id	string	The job's ID. (pattern: <code>[0-9]+</code>)
completion_time	string (date-time)	When the job completed.
creation_time	string (date-time)	When the job was created.
reference_store_id	string	The job's reference store ID. (pattern: <code>[0-9]+</code>)
role_arn	string	The job's service role ARN. (pattern: <code>arn:.*</code>)
status	string	The job's status. (SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reference_import_job	select	id, reference_store_id, region		Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.
list_reference_import_jobs	select	reference_store_id, region	maxResults, nextToken	Retrieves the metadata of one or more reference import jobs for a reference store.

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
id	string	The job's ID.
reference_store_id	string	The job's reference store ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of jobs to return in one page of results.
nextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_reference_import_job

Monitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.

SELECT
id,
completion_time,
creation_time,
reference_store_id,
role_arn,
sources,
status,
status_message
FROM aws.omics.reference_import_jobs
WHERE id = '{{ id }}' -- required
AND reference_store_id = '{{ reference_store_id }}' -- required
AND region = '{{ region }}' -- required
;

list_reference_import_jobs

Retrieves the metadata of one or more reference import jobs for a reference store.

SELECT
id,
completion_time,
creation_time,
reference_store_id,
role_arn,
status
FROM aws.omics.reference_import_jobs
WHERE reference_store_id = '{{ reference_store_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;