Omics / Client / list_reference_stores
list_reference_stores#
- Omics.Client.list_reference_stores(**kwargs)#
Retrieves a list of reference stores.
See also: AWS API Documentation
Request Syntax
response = client.list_reference_stores( maxResults=123, nextToken='string', filter={ 'name': 'string', 'createdAfter': datetime(2015, 1, 1), 'createdBefore': datetime(2015, 1, 1) } )
- Parameters:
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.
name (string) –
The name to filter on.
createdAfter (datetime) –
The filter’s start date.
createdBefore (datetime) –
The filter’s end date.
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'referenceStores': [ { 'arn': 'string', 'id': 'string', 'name': 'string', 'description': 'string', 'sseConfig': { 'type': 'KMS', 'keyArn': 'string' }, 'creationTime': datetime(2015, 1, 1) }, ] }
Response Structure
(dict) –
nextToken (string) –
A pagination token that’s included if more results are available.
referenceStores (list) –
A list of reference stores.
(dict) –
Details about a reference store.
arn (string) –
The store’s ARN.
id (string) –
The store’s ID.
name (string) –
The store’s name.
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) –
When the store was created.
Exceptions
Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException