Omics / Paginator / ListAnnotationStores
ListAnnotationStores#
- class Omics.Paginator.ListAnnotationStores#
paginator = client.get_paginator('list_annotation_stores')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Omics.Client.list_annotation_stores()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ids=[ 'string', ], filter={ 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
ids (list) –
IDs of stores to list.
(string) –
filter (dict) –
A filter to apply to the list.
status (string) –
A status to filter on.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- 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 setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_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 token to resume pagination.