Skip to main content

read_set_import_jobs

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

Overview

Nameread_set_import_jobs
TypeResource
Idaws.omics.read_set_import_jobs

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe job's ID. (pattern: <code>[0-9]+</code>)
completion_timestring (date-time)When the job completed.
creation_timestring (date-time)When the job was created.
role_arnstringThe job's service role ARN. (pattern: <code>arn:.*</code>)
sequence_store_idstringThe job's sequence store ID. (pattern: <code>[0-9]+</code>)
sourcesarrayThe job's source files.
statusstringThe job's status. (SUBMITTED, IN_PROGRESS, CANCELLING, CANCELLED, FAILED, COMPLETED, COMPLETED_WITH_FAILURES)
status_messagestringThe job's status message. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_read_set_import_jobselectid, sequence_store_id, regionGets detailed and status information about a read set import job and returns the data in JSON format.
list_read_set_import_jobsselectsequence_store_id, regionmaxResults, nextTokenRetrieves a list of read set import jobs and returns the data in JSON format.

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.

NameDatatypeDescription
idstringThe job's ID.
regionstringAWS region (default: us-east-1)
sequence_store_idstringThe jobs' sequence store ID.
maxResultsintegerThe maximum number of jobs to return in one page of results.
nextTokenstringSpecify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

Gets detailed and status information about a read set import job and returns the data in JSON format.

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