Omics / Client / get_annotation_store

get_annotation_store#

Omics.Client.get_annotation_store(**kwargs)#

Gets information about an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.get_annotation_store(
    name='string'
)
Parameters:

name (string) –

[REQUIRED]

The store’s name.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'reference': {
        'referenceArn': 'string'
    },
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'storeArn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'updateTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'storeOptions': {
        'tsvStoreOptions': {
            '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'
                },
            ]
        }
    },
    'storeFormat': 'GFF'|'TSV'|'VCF',
    'statusMessage': 'string',
    'storeSizeBytes': 123,
    'numVersions': 123
}

Response Structure

  • (dict) –

    • id (string) –

      The store’s ID.

    • reference (dict) –

      The store’s genome reference.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: referenceArn. 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'}

      • referenceArn (string) –

        The reference’s ARN.

    • status (string) –

      The store’s status.

    • storeArn (string) –

      The store’s ARN.

    • name (string) –

      The store’s name.

    • description (string) –

      The store’s description.

    • sseConfig (dict) –

      The store’s server-side encryption (SSE) settings.

      • type (string) –

        The encryption type.

      • keyArn (string) –

        An encryption key ARN.

    • creationTime (datetime) –

      When the store was created.

    • updateTime (datetime) –

      When the store was updated.

    • tags (dict) –

      The store’s tags.

      • (string) –

        • (string) –

    • storeOptions (dict) –

      The store’s parsing options.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: tsvStoreOptions. 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'}

      • tsvStoreOptions (dict) –

        File settings for a TSV store.

        • annotationType (string) –

          The store’s annotation type.

        • formatToHeader (dict) –

          The store’s header key to column name mapping.

          • (string) –

            • (string) –

        • schema (list) –

          The store’s schema.

          • (dict) –

            • (string) –

              • (string) –

    • storeFormat (string) –

      The store’s annotation file format.

    • statusMessage (string) –

      A status message.

    • storeSizeBytes (integer) –

      The store’s size in bytes.

    • numVersions (integer) –

      An integer indicating how many versions of an annotation store exist.

Exceptions