Omics / Client / list_annotation_stores

list_annotation_stores

Omics.Client.list_annotation_stores(**kwargs)

Retrieves a list of annotation stores.

See also: AWS API Documentation

Request Syntax

response = client.list_annotation_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) –

  IDs of stores to list.

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

{
    'annotationStores': [
        {
            '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',
            'storeFormat': 'GFF'|'TSV'|'VCF',
            'storeSizeBytes': 123,
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • annotationStores (list) –

    A list of stores.

    • (dict) –

      An annotation store.

      • creationTime (datetime) –

        The store’s creation time.

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

      • storeFormat (string) –

        The store’s file format.

      • storeSizeBytes (integer) –

        The store’s size in bytes.

      • updateTime (datetime) –

        When the store was updated.

  • nextToken (string) –

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

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException