list_variant_stores

list_variant_stores(**kwargs)

Retrieves a list of variant stores.

See also: AWS API Documentation

Request Syntax

response = client.list_variant_stores(
    filter={
        'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'
    },
    ids=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)
Parameters
  • filter (dict) --

    A filter to apply to the list.

    • status (string) --

      A status to filter on.

  • ids (list) --

    A list of store IDs.

    • (string) --
  • maxResults (integer) -- The maximum number of stores to return in one page of results.
  • nextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'variantStores': [
        {
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'reference': {
                'referenceArn': 'string'
            },
            'sseConfig': {
                'keyArn': 'string',
                'type': 'KMS'
            },
            'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
            'statusMessage': 'string',
            'storeArn': 'string',
            'storeSizeBytes': 123,
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A pagination token that's included if more results are available.

    • variantStores (list) --

      A list of variant stores.

      • (dict) --

        A variant store.

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

        • sseConfig (dict) --

          The store's server-side encryption (SSE) settings.

          • keyArn (string) --

            An encryption key ARN.

          • type (string) --

            The encryption type.

        • status (string) --

          The store's status.

        • statusMessage (string) --

          The store's status message.

        • storeArn (string) --

          The store's ARN.

        • storeSizeBytes (integer) --

          The store's size in bytes.

        • 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