annotation_import_jobs

Creates, updates, deletes, gets or lists an annotation_import_jobs resource.

Overview

Name	annotation_import_jobs
Type	Resource
Id	aws.omics.annotation_import_jobs

Fields

The following fields are returned by SELECT queries:

get_annotation_import_job

Name	Datatype	Description
id	string	The job's ID. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
annotation_fields	object	The annotation schema generated by the parsed annotation data.
completion_time	string (date-time)	When the job completed.
creation_time	string (date-time)	When the job was created.
destination_name	string	The job's destination annotation store. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)
format_options	object	Formatting options for a file.
items_	array	The job's imported items.
role_arn	string	The job's service role ARN. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
run_left_normalization	boolean	The job's left normalization setting.
status	string	The job's status. (SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED, COMPLETED_WITH_FAILURES)
status_message	string	The job's status message.
update_time	string (date-time)	When the job was updated.
version_name	string	The name of the annotation store version. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)

list_annotation_import_jobs

Name	Datatype	Description
id	string	The job's ID.
annotation_fields	object	The annotation schema generated by the parsed annotation data.
completion_time	string (date-time)	When the job completed.
creation_time	string (date-time)	When the job was created.
destination_name	string	The job's destination annotation store.
role_arn	string	The job's service role ARN. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
run_left_normalization	boolean	The job's left normalization setting.
status	string	The job's status. (SUBMITTED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED, COMPLETED_WITH_FAILURES)
update_time	string (date-time)	When the job was updated.
version_name	string	The name of the annotation store version. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_annotation_import_job	select	job_id, region		Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation import job.
list_annotation_import_jobs	select	region	maxResults, nextToken	Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation import jobs.

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
job_id	string	The job's 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	Specifies the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_annotation_import_job

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation import job.

SELECT
id,
annotation_fields,
completion_time,
creation_time,
destination_name,
format_options,
items_,
role_arn,
run_left_normalization,
status,
status_message,
update_time,
version_name
FROM aws.omics.annotation_import_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_annotation_import_jobs

Amazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation import jobs.

SELECT
id,
annotation_fields,
completion_time,
creation_time,
destination_name,
role_arn,
run_left_normalization,
status,
update_time,
version_name
FROM aws.omics.annotation_import_jobs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;