Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

update_annotation_store

update_annotation_store(**kwargs)

Updates an annotation store.

See also: AWS API Documentation

Request Syntax

response = client.update_annotation_store(
    description='string',
    name='string'
)
Parameters
  • description (string) -- A description for the store.
  • name (string) --

    [REQUIRED]

    A name for the store.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • creationTime (datetime) --

      When the store was created.

    • description (string) --

      The store's description.

    • id (string) --

      The store's ID.

    • name (string) --

      The store's name.

    • 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.

    • storeFormat (string) --

      The annotation file format of the store.

    • 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) --
    • updateTime (datetime) --

      When the store was updated.

Exceptions

  • Omics.Client.exceptions.InternalServerException
  • Omics.Client.exceptions.ThrottlingException
  • Omics.Client.exceptions.ValidationException
  • Omics.Client.exceptions.ResourceNotFoundException
  • Omics.Client.exceptions.AccessDeniedException