Omics / Paginator / ListBatch

ListBatch

class Omics.Paginator.ListBatch

paginator = client.get_paginator('list_batch')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    status='PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
    name='string',
    runGroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• status (string) – Filter batches by status.

• name (string) – Filter batches by name.

• runGroupId (string) – Filter batches by run group 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

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'status': 'PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
            'createdAt': datetime(2015, 1, 1),
            'totalRuns': 123,
            'workflowId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of batch summary objects. See BatchListItem.

    • (dict) –

      A summary of a batch returned by ListBatch.

      • id (string) –

        The batch identifier.

      • name (string) –

        The batch name.

      • status (string) –

        The current batch status.

      • createdAt (datetime) –

        The timestamp when the batch was created.

      • totalRuns (integer) –

        The total number of runs in the batch.

      • workflowId (string) –

        The identifier of the workflow used for the batch.

  • NextToken (string) –

    A token to resume pagination.