Omics / Paginator / ListSequenceStores

ListSequenceStores

class Omics.Paginator.ListSequenceStores

paginator = client.get_paginator('list_sequence_stores')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Omics.Client.list_sequence_stores().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• 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

{
    '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.