Omics / Client / list_sequence_stores

list_sequence_stores¶

Omics.Client.list_sequence_stores(**kwargs)¶

Retrieves a list of sequence stores and returns each sequence store’s metadata.

For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.

Request Syntax

response = client.list_sequence_stores(
    maxResults=123,
    nextToken='string',
    filter={
        'name': 'string',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'updatedAfter': datetime(2015, 1, 1),
        'updatedBefore': 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) –
  
  A name to filter on.
- createdAfter (datetime) –
  
  The filter’s start date.
- createdBefore (datetime) –
  
  The filter’s end date.
- status (string) –
  
  Filter results based on status.
- updatedAfter (datetime) –
  
  Filter results based on stores updated after the specified time.
- updatedBefore (datetime) –
  
  Filter results based on stores updated before the specified time.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'sequenceStores': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'sseConfig': {
                'type': 'KMS',
                'keyArn': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'fallbackLocation': 'string',
            'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
            'statusMessage': 'string',
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A pagination token that’s included if more results are available.
- sequenceStores (list) –
  
  A list of sequence stores.
  - (dict) –
    
    Details about a sequence 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.
    - fallbackLocation (string) –
      
      An S3 location that is used to store files that have failed a direct upload.
    - eTagAlgorithmFamily (string) –
      
      The algorithm family of the ETag.
    - status (string) –
      
      Status of the sequence store.
    - statusMessage (string) –
      
      The status message of the sequence store.
    - updateTime (datetime) –
      
      The last-updated time of the Sequence Store.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException