run_tasks

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

Overview

Name	run_tasks
Type	Resource
Id	aws.omics.run_tasks

Fields

The following fields are returned by SELECT queries:

get_run_task

Name	Datatype	Description
name	string	The task's name.
cache_hit	boolean	Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.
cache_s3_uri	string	Uri to a S3 object or bucket (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?</code>)
cpus	integer	The task's CPU usage.
creation_time	string (date-time)	When the task was created.
failure_reason	string	The reason a task has failed. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
gpus	integer	The number of Graphics Processing Units (GPU) specified in the task.
image_details	object	Details about the container image that this task uses.
instance_type	string	The instance type for a task. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
log_stream	string	The task's log stream. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
memory	integer	The task's memory use in gigabytes.
start_time	string (date-time)	The task's start time.
status	string	The task's status. (PENDING, STARTING, RUNNING, STOPPING, COMPLETED, CANCELLED, FAILED)
status_message	string	The task's status message. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
stop_time	string (date-time)	The task's stop time.
task_id	string	The task's ID. (pattern: <code>[0-9]+</code>)
uuid	string	The universally unique identifier (UUID) for the workflow task. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

list_run_tasks

Name	Datatype	Description
name	string	The task's name.
cache_hit	boolean	Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.
cache_s3_uri	string	Uri to a S3 object or bucket (pattern: <code>s3:​//([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])(/(.{0,1024}))?</code>)
cpus	integer	The task's CPU count.
creation_time	string (date-time)	When the task was created.
gpus	integer	The number of Graphics Processing Units (GPU) specified for the task.
instance_type	string	The instance type for a task. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
memory	integer	The task's memory use in gigabyes.
start_time	string (date-time)	When the task started.
status	string	The task's status. (PENDING, STARTING, RUNNING, STOPPING, COMPLETED, CANCELLED, FAILED)
stop_time	string (date-time)	When the task stopped.
task_id	string	The task's ID. (pattern: <code>[0-9]+</code>)
uuid	string	The universally unique identifier (UUID) for the workflow task. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_run_task	select	id, task_id, region		Gets detailed information about a run task using its ID.
list_run_tasks	select	id, region	status, startingToken, maxResults	Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

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 run's ID.
region	string	AWS region (default: us-east-1)
task_id	string	The task's ID.
maxResults	integer	The maximum number of run tasks to return in one page of results.
startingToken	string	Specify the pagination token from a previous request to retrieve the next page of results.
status	string	Filter the list by status.

SELECT examples

get_run_task

Gets detailed information about a run task using its ID.

SELECT
name,
cache_hit,
cache_s3_uri,
cpus,
creation_time,
failure_reason,
gpus,
image_details,
instance_type,
log_stream,
memory,
start_time,
status,
status_message,
stop_time,
task_id,
uuid
FROM aws.omics.run_tasks
WHERE id = '{{ id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;

list_run_tasks

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

SELECT
name,
cache_hit,
cache_s3_uri,
cpus,
creation_time,
gpus,
instance_type,
memory,
start_time,
status,
stop_time,
task_id,
uuid
FROM aws.omics.run_tasks
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND startingToken = '{{ startingToken }}'
AND maxResults = '{{ maxResults }}'
;