Omics / Client / get_variant_store

get_variant_store#

Omics.Client.get_variant_store(**kwargs)#

Gets information about a variant store.

See also: AWS API Documentation

Request Syntax

response = client.get_variant_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'
    },
    'statusMessage': 'string',
    'storeSizeBytes': 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) –

    • statusMessage (string) –

      The store’s status message.

    • storeSizeBytes (integer) –

      The store’s size in bytes.

Exceptions