Omics / Paginator / ListRunTasks

ListRunTasks

class Omics.Paginator.ListRunTasks

paginator = client.get_paginator('list_run_tasks')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• id (string) –

  [REQUIRED]

  The run’s ID.

• status (string) – Filter the list by status.

• 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': [
        {
            'taskId': 'string',
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED',
            'name': 'string',
            'cpus': 123,
            'cacheHit': True|False,
            'cacheS3Uri': 'string',
            'memory': 123,
            'creationTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'stopTime': datetime(2015, 1, 1),
            'gpus': 123,
            'instanceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of tasks.

    • (dict) –

      A workflow run task.

      • taskId (string) –

        The task’s ID.

      • status (string) –

        The task’s status.

      • name (string) –

        The task’s name.

      • cpus (integer) –

        The task’s CPU count.

      • cacheHit (boolean) –

        Set to true if AWS HealthOmics found a matching entry in the run cache for this task.

      • cacheS3Uri (string) –

        The S3 URI of the cache location.

      • memory (integer) –

        The task’s memory use in gigabyes.

      • creationTime (datetime) –

        When the task was created.

      • startTime (datetime) –

        When the task started.

      • stopTime (datetime) –

        When the task stopped.

      • gpus (integer) –

        The number of Graphics Processing Units (GPU) specified for the task.

      • instanceType (string) –

        The instance type for a task.

  • NextToken (string) –

    A token to resume pagination.