reference_metadatas

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

Overview

Name	reference_metadatas
Type	Resource
Id	aws.omics.reference_metadatas

Fields

The following fields are returned by SELECT queries:

get_reference_metadata

Name	Datatype	Description
id	string	The reference's ID. (pattern: <code>[0-9]+</code>)
name	string	The reference's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The reference's ARN. (pattern: <code>arn:.+</code>)
creation_job_id	string	The reference's creation job ID. (pattern: <code>[a-zA-Z0-9]+</code>)
creation_time	string (date-time)	When the reference was created.
creation_type	string	The reference's creation type. (IMPORT)
description	string	The reference's description. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
files	object	The reference's files.
md_5	string	The reference's MD5 checksum. (pattern: <code>[\p{L}||\p{N}]+</code>)
reference_store_id	string	The reference's reference store ID. (pattern: <code>[0-9]+</code>)
status	string	The reference's status. (ACTIVE, DELETING, DELETED)
update_time	string (date-time)	When the reference was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reference_metadata	select	id, reference_store_id, region		Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. 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 reference's ID.
reference_store_id	string	The reference's reference store ID.
region	string	AWS region (default: us-east-1)

SELECT examples

get_reference_metadata

Retrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. 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,
files,
md_5,
reference_store_id,
status,
update_time
FROM aws.omics.reference_metadatas
WHERE id = '{{ id }}' -- required
AND reference_store_id = '{{ reference_store_id }}' -- required
AND region = '{{ region }}' -- required
;