Omics / Client / update_variant_store

update_variant_store#

Omics.Client.update_variant_store(**kwargs)#

Updates a variant store.

See also: AWS API Documentation

Request Syntax

response = client.update_variant_store(
    name='string',
    description='string'
)
Parameters:
  • name (string) –

    [REQUIRED]

    A name for the store.

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

Return type:

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

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.

Exceptions

  • Omics.Client.exceptions.InternalServerException

  • Omics.Client.exceptions.ThrottlingException

  • Omics.Client.exceptions.ValidationException

  • Omics.Client.exceptions.ResourceNotFoundException

  • Omics.Client.exceptions.AccessDeniedException