Omics / Client / create_annotation_store

create_annotation_store#

Omics.Client.create_annotation_store(**kwargs)#

Creates an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.create_annotation_store(
    reference={
        'referenceArn': 'string'
    },
    name='string',
    description='string',
    tags={
        'string': 'string'
    },
    versionName='string',
    sseConfig={
        'type': 'KMS',
        'keyArn': 'string'
    },
    storeFormat='GFF'|'TSV'|'VCF',
    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'
                },
            ]
        }
    }
)
Parameters:

  • reference (dict) –

    The genome reference for the store’s annotations.

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

  • versionName (string) – The name given to an annotation store version to distinguish it from other versions.

  • sseConfig (dict) –

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

    • type (string) – [REQUIRED]

      The encryption type.

    • keyArn (string) –

      An encryption key ARN.

  • storeFormat (string) –

    [REQUIRED]

    The annotation file format of the store.

  • storeOptions (dict) –

    File parsing options for the annotation store.

    Note

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

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

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'reference': {
        'referenceArn': 'string'
    },
    'storeFormat': 'GFF'|'TSV'|'VCF',
    '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'
                },
            ]
        }
    },
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'name': 'string',
    'versionName': 'string',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • id (string) –

      The store’s ID.

    • reference (dict) –

      The store’s genome reference. Required for all stores except TSV format with generic annotations.

      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.

    • storeFormat (string) –

      The annotation file format of the store.

    • storeOptions (dict) –

      The store’s file 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) –

    • status (string) –

      The store’s status.

    • name (string) –

      The store’s name.

    • versionName (string) –

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

    • creationTime (datetime) –

      When the store was created.

Exceptions