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(
    ids=[
        'string',
    ],
    maxResults=123,
    nextToken='string',
    filter={
        'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED'
    }
)
Parameters:

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

  • filter (dict) –

    A filter to apply to the list.

    • status (string) –

      A status to filter on.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • annotationStores (list) –

      A list of stores.

      • (dict) –

        An annotation store.

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

        • storeArn (string) –

          The store’s ARN.

        • name (string) –

          The store’s name.

        • storeFormat (string) –

          The store’s file format.

        • description (string) –

          The store’s description.

        • sseConfig (dict) –

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

          • type (string) –

            The encryption type.

          • keyArn (string) –

            An encryption key ARN.

        • creationTime (datetime) –

          The store’s creation time.

        • updateTime (datetime) –

          When the store was updated.

        • statusMessage (string) –

          The store’s status message.

        • storeSizeBytes (integer) –

          The store’s size in bytes.

    • nextToken (string) –

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

Exceptions