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

***********************
update_annotation_store
***********************



.. py:method:: Omics.Client.update_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>`__.

    

   

  Updates an annotation store.

  

  

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


  **Request Syntax**
  ::

    response = client.update_annotation_store(
        name='string',
        description='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    A name for the store.

    

  
  :type description: string
  :param description: 

    A description for the store.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'id': 'string',
          'reference': {
              'referenceArn': 'string'
          },
          'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
          'name': 'string',
          'description': 'string',
          'creationTime': datetime(2015, 1, 1),
          'updateTime': datetime(2015, 1, 1),
          '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'
      }
      
    **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.

        
      

      - **description** *(string) --* 

        The store's description.

        
      

      - **creationTime** *(datetime) --* 

        When the store was created.

        
      

      - **updateTime** *(datetime) --* 

        When the store was updated.

        
      

      - **storeOptions** *(dict) --* 

        Parsing options for the store.

        .. 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 annotation file format of the store.

        
  
  **Exceptions**
  
  *   :py:class:`Omics.Client.exceptions.InternalServerException`

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

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

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

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

  