Omics / Paginator / ListReferences

ListReferences#

class Omics.Paginator.ListReferences#
paginator = client.get_paginator('list_references')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1),
        'md5': 'string',
        'name': 'string'
    },
    referenceStoreId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • filter (dict) –

    A filter to apply to the list.

    • createdAfter (datetime) –

      The filter’s start date.

    • createdBefore (datetime) –

      The filter’s end date.

    • md5 (string) –

      An MD5 checksum to filter on.

    • name (string) –

      A name to filter on.

  • referenceStoreId (string) –

    [REQUIRED]

    The references’ reference store ID.

  • 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

{
    'references': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'md5': 'string',
            'name': 'string',
            'referenceStoreId': 'string',
            'status': 'ACTIVE'|'DELETING'|'DELETED',
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • references (list) –

      A list of references.

      • (dict) –

        A genome reference.

        • arn (string) –

          The reference’s ARN.

        • creationTime (datetime) –

          When the reference was created.

        • description (string) –

          The reference’s description.

        • id (string) –

          The reference’s ID.

        • md5 (string) –

          The reference’s MD5 checksum.

        • name (string) –

          The reference’s name.

        • referenceStoreId (string) –

          The reference’s store ID.

        • status (string) –

          The reference’s status.

        • updateTime (datetime) –

          When the reference was updated.

    • NextToken (string) –

      A token to resume pagination.