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(
    referenceStoreId='string',
    filter={
        'name': 'string',
        'md5': 'string',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• referenceStoreId (string) –

  [REQUIRED]

  The references’ reference store ID.

• filter (dict) –

  A filter to apply to the list.

  • name (string) –

    A name to filter on.

  • md5 (string) –

    An MD5 checksum to filter on.

  • createdAfter (datetime) –

    The filter’s start date.

  • createdBefore (datetime) –

    The filter’s end date.

• 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': [
        {
            'id': 'string',
            'arn': 'string',
            'referenceStoreId': 'string',
            'md5': 'string',
            'status': 'ACTIVE'|'DELETING'|'DELETED',
            'name': 'string',
            'description': 'string',
            'creationTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • references (list) –

    A list of references.

    • (dict) –

      A genome reference.

      • id (string) –

        The reference’s ID.

      • arn (string) –

        The reference’s ARN.

      • referenceStoreId (string) –

        The reference’s store ID.

      • md5 (string) –

        The reference’s MD5 checksum.

      • status (string) –

        The reference’s status.

      • name (string) –

        The reference’s name.

      • description (string) –

        The reference’s description.

      • creationTime (datetime) –

        When the reference was created.

      • updateTime (datetime) –

        When the reference was updated.

  • NextToken (string) –

    A token to resume pagination.