list_run_tasks

Omics.Client.list_run_tasks(**kwargs)

Retrieves a list of tasks for a run.

See also: AWS API Documentation

Request Syntax

response = client.list_run_tasks(
    id='string',
    maxResults=123,
    startingToken='string',
    status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED'
)

Parameters

• id (string) --

  [REQUIRED]

  The run's ID.

• maxResults (integer) -- The maximum number of run tasks to return in one page of results.
• startingToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
• status (string) -- Filter the list by status.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'cpus': 123,
            'creationTime': datetime(2015, 1, 1),
            'memory': 123,
            'name': 'string',
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'CANCELLED'|'FAILED',
            'stopTime': datetime(2015, 1, 1),
            'taskId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    A list of tasks.

    • (dict) --

      A workflow run task.

      • cpus (integer) --

        The task's CPU count.

      • creationTime (datetime) --

        When the task was created.

      • memory (integer) --

        The task's memory use in gigabyes.

      • name (string) --

        The task's name.

      • startTime (datetime) --

        When the task started.

      • status (string) --

        The task's status.

      • stopTime (datetime) --

        When the task stopped.

      • taskId (string) --

        The task's ID.

  • nextToken (string) --

    A pagination token that's included if more results are available.

Exceptions

• Omics.Client.exceptions.InternalServerException
• Omics.Client.exceptions.ServiceQuotaExceededException
• Omics.Client.exceptions.ThrottlingException
• Omics.Client.exceptions.ValidationException
• Omics.Client.exceptions.ConflictException
• Omics.Client.exceptions.ResourceNotFoundException
• Omics.Client.exceptions.AccessDeniedException
• Omics.Client.exceptions.RequestTimeoutException