reference_stores

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

Overview

Name	reference_stores
Type	Resource
Id	aws.omics.reference_stores

Fields

The following fields are returned by SELECT queries:

get_reference_store

Name	Datatype	Description
id	string	The store's ID. (pattern: <code>[0-9]+</code>)
name	string	The store's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The store's ARN. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	When the store was created.
description	string	The store's description. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
sse_config	object	Server-side encryption (SSE) settings for a store.

list_reference_stores

Name	Datatype	Description
id	string	The store's ID. (pattern: <code>[0-9]+</code>)
name	string	The store's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The store's ARN. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	When the store was created.
description	string	The store's description. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
sse_config	object	Server-side encryption (SSE) settings for a store.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reference_store	select	id, region		Gets information about a reference store.
list_reference_stores	select	region	maxResults, nextToken	Retrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
create_reference_store	insert	region, name		Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.
delete_reference_store	delete	id, region		Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference. For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

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 store's ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of stores 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_reference_store

Gets information about a reference store.

SELECT
id,
name,
arn,
creation_time,
description,
sse_config
FROM aws.omics.reference_stores
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_reference_stores

Retrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

SELECT
id,
name,
arn,
creation_time,
description,
sse_config
FROM aws.omics.reference_stores
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_reference_store

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

INSERT INTO aws.omics.reference_stores (
name,
description,
sseConfig,
tags,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ sseConfig }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
id,
name,
arn,
creation_time,
description,
sse_config
;

Manifest

# Description fields are for documentation purposes
- name: reference_stores
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the reference_stores resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: sseConfig
    description: |
      Server-side encryption (SSE) settings for a store.
    value:
      type_: "{{ type_ }}"
      keyArn: "{{ keyArn }}"
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

DELETE examples

delete_reference_store

Deletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference. For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.

DELETE FROM aws.omics.reference_stores
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;