annotation_store_versions

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

Overview

Name	annotation_store_versions
Type	Resource
Id	aws.omics.annotation_store_versions

Fields

The following fields are returned by SELECT queries:

get_annotation_store_version

Name	Datatype	Description
id	string	The annotation store version 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 name of the annotation store. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)
creation_time	string (date-time)	The time stamp for when an annotation store version was created.
description	string	The description for an annotation store version.
status	string	The status of an annotation store version. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)
status_message	string	The status of an annotation store version.
store_id	string	The store ID for annotation store version. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
tags	object	Any tags associated with an annotation store version.
update_time	string (date-time)	The time stamp for when an annotation store version was updated.
version_arn	string	The Arn for the annotation store. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
version_name	string	The name given to an annotation store version to distinguish it from others. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)
version_options	object	The options for an annotation store version.
version_size_bytes	integer (int64)	The size of the annotation store version in Bytes.

list_annotation_store_versions

Name	Datatype	Description
id	string	The annotation store version 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	A name given to an annotation store version to distinguish it from others. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)
creation_time	string (date-time)	The time stamp for when an annotation store version was created.
description	string	The description of an annotation store version.
status	string	The status of an annotation store version. (CREATING, UPDATING, DELETING, ACTIVE, FAILED)
status_message	string	The status of an annotation store version.
store_id	string	The store ID for an annotation store version. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
update_time	string (date-time)	The time stamp for when an annotation store version was updated.
version_arn	string	The Arn for an annotation store version. (pattern: <code>arn:([^: ]):([^: ]):([^: ]):([0-9]{12}):([^: ])</code>)
version_name	string	The name of an annotation store version. (pattern: <code>([a-z]){1}([a-z0-9_]){2,254}</code>)
version_size_bytes	integer (int64)	The size of an annotation store version in Bytes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_annotation_store_version	select	name, version_name, region		Retrieves the metadata for an annotation store version.
list_annotation_store_versions	select	name, region	maxResults, nextToken	Lists the versions of an annotation store.
create_annotation_store_version	insert	name, region, versionName		Creates a new version of an annotation store.
update_annotation_store_version	update	name, version_name, region		Updates the description of an annotation store version.
delete_annotation_store_versions	delete	name, region	force	Deletes one or multiple versions of 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 name of the annotation store from which versions are being deleted.
region	string	AWS region (default: us-east-1)
version_name	string	The name of an annotation store version.
force	boolean	Forces the deletion of an annotation store version when imports are in-progress..
maxResults	integer	The maximum number of annotation store versions to return in one page of results.
nextToken	string	Specifies the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_annotation_store_version

Retrieves the metadata for an annotation store version.

SELECT
id,
name,
creation_time,
description,
status,
status_message,
store_id,
tags,
update_time,
version_arn,
version_name,
version_options,
version_size_bytes
FROM aws.omics.annotation_store_versions
WHERE name = '{{ name }}' -- required
AND version_name = '{{ version_name }}' -- required
AND region = '{{ region }}' -- required
;

list_annotation_store_versions

Lists the versions of an annotation store.

SELECT
id,
name,
creation_time,
description,
status,
status_message,
store_id,
update_time,
version_arn,
version_name,
version_size_bytes
FROM aws.omics.annotation_store_versions
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_annotation_store_version

Creates a new version of an annotation store.

INSERT INTO aws.omics.annotation_store_versions (
versionName,
description,
versionOptions,
tags,
name,
region
)
SELECT 
'{{ versionName }}' /* required */,
'{{ description }}',
'{{ versionOptions }}',
'{{ tags }}',
'{{ name }}',
'{{ region }}'
RETURNING
id,
name,
creation_time,
status,
store_id,
version_name,
version_options
;

Manifest

# Description fields are for documentation purposes
- name: annotation_store_versions
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the annotation_store_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the annotation_store_versions resource.
  - name: versionName
    value: "{{ versionName }}"
  - name: description
    value: "{{ description }}"
  - name: versionOptions
    description: |
      The options for an annotation store version.
    value:
      tsvVersionOptions:
        annotationType: "{{ annotationType }}"
        formatToHeader: "{{ formatToHeader }}"
        schema: "{{ schema }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_annotation_store_version

Updates the description of an annotation store version.

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

DELETE examples

delete_annotation_store_versions

Deletes one or multiple versions of an annotation store.

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