read_set_export_jobs

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

Overview

Name	read_set_export_jobs
Type	Resource
Id	aws.omics.read_set_export_jobs

Fields

The following fields are returned by SELECT queries:

get_read_set_export_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.
destination	string	The job's destination in Amazon S3. (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?</code>)
read_sets	array	The job's read sets.
sequence_store_id	string	The job's sequence store ID. (pattern: <code>[0-9]+</code>)
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_read_set_export_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.
destination	string	The job's destination in Amazon S3. (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?</code>)
sequence_store_id	string	The job's sequence store ID. (pattern: <code>[0-9]+</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_read_set_export_job	select	sequence_store_id, id, region		Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.
list_read_set_export_jobs	select	sequence_store_id, region	maxResults, nextToken	Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

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.
region	string	AWS region (default: us-east-1)
sequence_store_id	string	The jobs' sequence store ID.
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_read_set_export_job

Retrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.

SELECT
id,
completion_time,
creation_time,
destination,
read_sets,
sequence_store_id,
status,
status_message
FROM aws.omics.read_set_export_jobs
WHERE sequence_store_id = '{{ sequence_store_id }}' -- required
AND id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_read_set_export_jobs

Retrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.

SELECT
id,
completion_time,
creation_time,
destination,
sequence_store_id,
status
FROM aws.omics.read_set_export_jobs
WHERE sequence_store_id = '{{ sequence_store_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;