:doc:`Omics <../../omics>` / Client / create_annotation_store

***********************
create_annotation_store
***********************



.. py:method:: Omics.Client.create_annotation_store(**kwargs)

  

  

  .. warning::

    

    Amazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see `Amazon Web Services HealthOmics variant store and annotation store availability change <https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html>`__.

    

   

  Creates an annotation store.

  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/CreateAnnotationStore>`_  


  **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'
                    },
                ]
            }
        }
    )
    
  :type reference: dict
  :param reference: 

    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.

      

    
  
  :type name: string
  :param name: 

    A name for the store.

    

  
  :type description: string
  :param description: 

    A description for the store.

    

  
  :type tags: dict
  :param tags: 

    Tags for the store.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type versionName: string
  :param versionName: 

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

    

  
  :type sseConfig: dict
  :param sseConfig: 

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

    

  
    - **type** *(string) --* **[REQUIRED]** 

      The encryption type.

      

    
    - **keyArn** *(string) --* 

      An encryption key ARN.

      

    
  
  :type storeFormat: string
  :param storeFormat: **[REQUIRED]** 

    The annotation file format of the store.

    

  
  :type storeOptions: dict
  :param storeOptions: 

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

            
      
    
    
    
  
  
  :rtype: 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**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

  
  *   :py:class:`Omics.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Omics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Omics.Client.exceptions.ValidationException`

  
  *   :py:class:`Omics.Client.exceptions.ConflictException`

  
  *   :py:class:`Omics.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Omics.Client.exceptions.AccessDeniedException`

  