Omics / Paginator / ListRunCaches

ListRunCaches

class Omics.Paginator.ListRunCaches

paginator = client.get_paginator('list_run_caches')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'items': [
        {
            'arn': 'string',
            'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
            'cacheS3Uri': 'string',
            'creationTime': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'DELETED'|'FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Details about each run cache in the response.

    • (dict) –

      List entry for one run cache.

      • arn (string) –

        Unique resource identifier for the run cache.

      • cacheBehavior (string) –

        Default cache behavior for the run cache.

      • cacheS3Uri (string) –

        The S3 uri for the run cache data.

      • creationTime (datetime) –

        The time that this run cache was created (an ISO 8601 formatted string).

      • id (string) –

        The identifier for this run cache.

      • name (string) –

        The name of the run cache.

      • status (string) –

        The run cache status.

  • NextToken (string) –

    A token to resume pagination.