Omics / Client / create_annotation_store_version

create_annotation_store_version#

Omics.Client.create_annotation_store_version(**kwargs)#

Creates a new version of an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.create_annotation_store_version(
    name='string',
    versionName='string',
    description='string',
    versionOptions={
        'tsvVersionOptions': {
            'annotationType': 'GENERIC'|'CHR_POS'|'CHR_POS_REF_ALT'|'CHR_START_END_ONE_BASE'|'CHR_START_END_REF_ALT_ONE_BASE'|'CHR_START_END_ZERO_BASE'|'CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader': {
                'string': 'string'
            },
            'schema': [
                {
                    'string': 'LONG'|'INT'|'STRING'|'FLOAT'|'DOUBLE'|'BOOLEAN'
                },
            ]
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of an annotation store version from which versions are being created.

  • versionName (string) –

    [REQUIRED]

    The name given to an annotation store version to distinguish it from other versions.

  • description (string) – The description of an annotation store version.

  • versionOptions (dict) –

    The options for an annotation store version.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: tsvVersionOptions.

    • tsvVersionOptions (dict) –

      File settings for a version of a TSV store.

      • annotationType (string) –

        The store version’s annotation type.

      • formatToHeader (dict) –

        The annotation store version’s header key to column name mapping.

        • (string) –

          • (string) –

      • schema (list) –

        The TSV schema for an annotation store version.

        • (dict) –

          • (string) –

            • (string) –

  • tags (dict) –

    Any tags added to annotation store version.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'versionName': 'string',
    'storeId': 'string',
    'versionOptions': {
        'tsvVersionOptions': {
            'annotationType': 'GENERIC'|'CHR_POS'|'CHR_POS_REF_ALT'|'CHR_START_END_ONE_BASE'|'CHR_START_END_REF_ALT_ONE_BASE'|'CHR_START_END_ZERO_BASE'|'CHR_START_END_REF_ALT_ZERO_BASE',
            'formatToHeader': {
                'string': 'string'
            },
            'schema': [
                {
                    'string': 'LONG'|'INT'|'STRING'|'FLOAT'|'DOUBLE'|'BOOLEAN'
                },
            ]
        }
    },
    'name': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • id (string) –

      A generated ID for the annotation store

    • versionName (string) –

      The name given to an annotation store version to distinguish it from other versions.

    • storeId (string) –

      The ID for the annotation store from which new versions are being created.

    • versionOptions (dict) –

      The options for an annotation store version.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: tsvVersionOptions. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • tsvVersionOptions (dict) –

        File settings for a version of a TSV store.

        • annotationType (string) –

          The store version’s annotation type.

        • formatToHeader (dict) –

          The annotation store version’s header key to column name mapping.

          • (string) –

            • (string) –

        • schema (list) –

          The TSV schema for an annotation store version.

          • (dict) –

            • (string) –

              • (string) –

    • name (string) –

      The name given to an annotation store version to distinguish it from other versions.

    • status (string) –

      The status of a annotation store version.

    • creationTime (datetime) –

      The time stamp for the creation of an annotation store version.

Exceptions