Omics / Client / create_variant_store

create_variant_store#

Omics.Client.create_variant_store(**kwargs)#

Creates a variant store.

See also: AWS API Documentation

Request Syntax

response = client.create_variant_store(
    reference={
        'referenceArn': 'string'
    },
    name='string',
    description='string',
    tags={
        'string': 'string'
    },
    sseConfig={
        'type': 'KMS',
        'keyArn': 'string'
    }
)
Parameters:

  • reference (dict) –

    [REQUIRED]

    The genome reference for the store’s variants.

    Note

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

    • referenceArn (string) –

      The reference’s ARN.

  • name (string) – A name for the store.

  • description (string) – A description for the store.

  • tags (dict) –

    Tags for the store.

    • (string) –

      • (string) –

  • sseConfig (dict) –

    Server-side encryption (SSE) settings for the store.

    • type (string) – [REQUIRED]

      The encryption type.

    • keyArn (string) –

      An encryption key ARN.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'reference': {
        'referenceArn': 'string'
    },
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'name': 'string',
    'creationTime': datetime(2015, 1, 1)
}

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.

    • name (string) –

      The store’s name.

    • creationTime (datetime) –

      When the store was created.

Exceptions