read_set_activation_jobs

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

Overview

Name	read_set_activation_jobs
Type	Resource
Id	aws.omics.read_set_activation_jobs

Fields

The following fields are returned by SELECT queries:

get_read_set_activation_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.
sequence_store_id	string	The job's sequence store ID. (pattern: <code>[0-9]+</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_read_set_activation_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.
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_activation_job	select	id, sequence_store_id, region		Returns detailed information about the status of a read set activation job in JSON format.
list_read_set_activation_jobs	select	sequence_store_id, region	maxResults, nextToken	Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob 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 read set's sequence store ID.
maxResults	integer	The maximum number of read set activation 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_activation_job

Returns detailed information about the status of a read set activation job in JSON format.

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

list_read_set_activation_jobs

Retrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.

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