annotation_stores

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

Overview

Name	annotation_stores
Type	Resource
Id	aws.omics.annotation_stores

Fields

The following fields are returned by SELECT queries:

get_annotation_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.
num_versions	integer	An integer indicating how many versions of an annotation store exist.
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	A status message.
store_arn	string	The store's ARN. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
store_format	string	The store's annotation file format. (GFF, TSV, VCF)
store_options	object	Settings for a store.
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_annotation_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)	The store's creation time.
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_format	string	The store's file format. (GFF, TSV, VCF)
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_annotation_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 an annotation store.
list_annotation_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 annotation stores.
create_annotation_store	insert	region, storeFormat		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 an annotation store.
update_annotation_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 an annotation store.
delete_annotation_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 an annotation 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_annotation_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 an annotation store.

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

list_annotation_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 annotation stores.

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

INSERT examples

create_annotation_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 an annotation store.

INSERT INTO aws.omics.annotation_stores (
reference,
name,
description,
tags,
versionName,
sseConfig,
storeFormat,
storeOptions,
region
)
SELECT 
'{{ reference }}',
'{{ name }}',
'{{ description }}',
'{{ tags }}',
'{{ versionName }}',
'{{ sseConfig }}',
'{{ storeFormat }}' /* required */,
'{{ storeOptions }}',
'{{ region }}'
RETURNING
id,
name,
creation_time,
reference,
status,
store_format,
store_options,
version_name
;

Manifest

# Description fields are for documentation purposes
- name: annotation_stores
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the annotation_stores resource.
  - name: reference
    description: |
      A genome reference.
    value:
      referenceArn: "{{ referenceArn }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: versionName
    value: "{{ versionName }}"
  - name: sseConfig
    description: |
      Server-side encryption (SSE) settings for a store.
    value:
      type_: "{{ type_ }}"
      keyArn: "{{ keyArn }}"
  - name: storeFormat
    value: "{{ storeFormat }}"
    valid_values: ['GFF', 'TSV', 'VCF']
  - name: storeOptions
    description: |
      Settings for a store.
    value:
      tsvStoreOptions:
        annotationType: "{{ annotationType }}"
        formatToHeader: "{{ formatToHeader }}"
        schema: "{{ schema }}"

UPDATE examples

update_annotation_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 an annotation store.

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

DELETE examples

delete_annotation_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 an annotation store.

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