variant_stores

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

Overview

Name	variant_stores
Type	Resource
Id	aws.omics.variant_stores

Fields

The following fields are returned by SELECT queries:

get_variant_store

Name	Datatype	Description
id	string	The store'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>)
name	string	The store's name.
creation_time	string (date-time)	When the store was created.
description	string	The store's description.
reference	object	A genome reference.
sse_config	object	Server-side encryption (SSE) settings for a store.
status	string	The store's status. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)
status_message	string	The store's status message.
store_arn	string	The store's ARN. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
store_size_bytes	integer (int64)	The store's size in bytes.
tags	object	The store's tags.
update_time	string (date-time)	When the store was updated.

list_variant_stores

Name	Datatype	Description
id	string	The store'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>)
name	string	The store's name.
creation_time	string (date-time)	When the store was created.
description	string	The store's description.
reference	object	A genome reference.
sse_config	object	Server-side encryption (SSE) settings for a store.
status	string	The store's status. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)
status_message	string	The store's status message.
store_arn	string	The store's ARN. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
store_size_bytes	integer (int64)	The store's size in bytes.
update_time	string (date-time)	When the store was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_variant_store	select	name, 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 a variant store.
list_variant_stores	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 variant stores.
create_variant_store	insert	region, reference		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. Creates a variant store.
update_variant_store	update	name, 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. Updates a variant store.
delete_variant_store	delete	name, region	force	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. Deletes a variant store.

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
name	string	The store's name.
region	string	AWS region (default: us-east-1)
force	boolean	Whether to force deletion.
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_variant_store

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 a variant store.

SELECT
id,
name,
creation_time,
description,
reference,
sse_config,
status,
status_message,
store_arn,
store_size_bytes,
tags,
update_time
FROM aws.omics.variant_stores
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_variant_stores

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 variant stores.

SELECT
id,
name,
creation_time,
description,
reference,
sse_config,
status,
status_message,
store_arn,
store_size_bytes,
update_time
FROM aws.omics.variant_stores
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_variant_store

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. Creates a variant store.

INSERT INTO aws.omics.variant_stores (
reference,
name,
description,
tags,
sseConfig,
region
)
SELECT 
'{{ reference }}' /* required */,
'{{ name }}',
'{{ description }}',
'{{ tags }}',
'{{ sseConfig }}',
'{{ region }}'
RETURNING
id,
name,
creation_time,
reference,
status
;

Manifest

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

UPDATE examples

update_variant_store

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. Updates a variant store.

UPDATE aws.omics.variant_stores
SET 
description = '{{ description }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
creation_time,
description,
reference,
status,
update_time;

DELETE examples

delete_variant_store

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. Deletes a variant store.

DELETE FROM aws.omics.variant_stores
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND force = '{{ force }}'
;