read_set_metadatas

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

Overview

Name	read_set_metadatas
Type	Resource
Id	aws.omics.read_set_metadatas

Fields

The following fields are returned by SELECT queries:

get_read_set_metadata

Name	Datatype	Description
id	string	The read set's ID. (pattern: <code>[0-9]+</code>)
name	string	The read set's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The read set's ARN. (pattern: <code>arn:.+</code>)
creation_job_id	string	The read set's creation job ID. (pattern: <code>[a-zA-Z0-9]+</code>)
creation_time	string (date-time)	When the read set was created.
creation_type	string	The creation type of the read set. (IMPORT, UPLOAD)
description	string	The read set's description. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
etag	object	The entity tag (ETag) is a hash of the object meant to represent its semantic content.
file_type	string	The read set's file type. (FASTQ, BAM, CRAM, UBAM)
files	object	The read set's files.
reference_arn	string	The read set's genome reference ARN. (pattern: <code>arn:.+</code>)
sample_id	string	The read set's sample ID. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
sequence_information	object	The read set's sequence information.
sequence_store_id	string	The read set's sequence store ID. (pattern: <code>[0-9]+</code>)
status	string	The read set's status. (ARCHIVED, ACTIVATING, ACTIVE, DELETING, DELETED, PROCESSING_UPLOAD, UPLOAD_FAILED)
status_message	string	The status message for a read set. It provides more detail as to why the read set has a status. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
subject_id	string	The read set's subject ID. (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_read_set_metadata	select	id, sequence_store_id, region		Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource 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 read set's ID.
region	string	AWS region (default: us-east-1)
sequence_store_id	string	The read set's sequence store ID.

SELECT examples

get_read_set_metadata

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

SELECT
id,
name,
arn,
creation_job_id,
creation_time,
creation_type,
description,
etag,
file_type,
files,
reference_arn,
sample_id,
sequence_information,
sequence_store_id,
status,
status_message,
subject_id
FROM aws.omics.read_set_metadatas
WHERE id = '{{ id }}' -- required
AND sequence_store_id = '{{ sequence_store_id }}' -- required
AND region = '{{ region }}' -- required
;