Omics / Paginator / ListRuns

ListRuns

class Omics.Paginator.ListRuns

paginator = client.get_paginator('list_runs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    name='string',
    runGroupId='string',
    status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• name (string) – Filter the list by run name.

• runGroupId (string) – Filter the list by run group ID.

• status (string) – The status of a run.

• 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',
            'id': 'string',
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
            'workflowId': 'string',
            'name': 'string',
            'priority': 123,
            'storageCapacity': 123,
            'creationTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'stopTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of runs.

    • (dict) –

      A workflow run.

      • arn (string) –

        The run’s ARN.

      • id (string) –

        The run’s ID.

      • status (string) –

        The run’s status.

      • workflowId (string) –

        The run’s workflow ID.

      • name (string) –

        The run’s name.

      • priority (integer) –

        The run’s priority.

      • storageCapacity (integer) –

        The run’s storage capacity.

      • creationTime (datetime) –

        When the run was created.

      • startTime (datetime) –

        When the run started.

      • stopTime (datetime) –

        When the run stopped.

  • NextToken (string) –

    A token to resume pagination.