Omics / Client / get_annotation_store_version

get_annotation_store_version#

Omics.Client.get_annotation_store_version(**kwargs)#

Retrieves the metadata for an annotation store version.

See also: AWS API Documentation

Request Syntax

response = client.get_annotation_store_version(
    name='string',
    versionName='string'
)
Parameters:

  • name (string) –

    [REQUIRED]

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

  • versionName (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'storeId': 'string',
    'id': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'versionArn': 'string',
    'name': 'string',
    'versionName': 'string',
    'description': 'string',
    'creationTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'tags': {
        'string': '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'
                },
            ]
        }
    },
    'statusMessage': 'string',
    'versionSizeBytes': 123
}

Response Structure

  • (dict) –

    • storeId (string) –

      The store ID for annotation store version.

    • id (string) –

      The annotation store version ID.

    • status (string) –

      The status of an annotation store version.

    • versionArn (string) –

      The Arn for the annotation store.

    • name (string) –

      The name of the annotation store.

    • versionName (string) –

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

    • description (string) –

      The description for an annotation store version.

    • creationTime (datetime) –

      The time stamp for when an annotation store version was created.

    • updateTime (datetime) –

      The time stamp for when an annotation store version was updated.

    • tags (dict) –

      Any tags associated with an annotation store version.

      • (string) –

        • (string) –

    • 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) –

    • statusMessage (string) –

      The status of an annotation store version.

    • versionSizeBytes (integer) –

      The size of the annotation store version in Bytes.

Exceptions