Omics / Client / get_run_task

get_run_task

Omics.Client.get_run_task(**kwargs)

Gets information about a workflow run task.

See also: AWS API Documentation

Request Syntax

response = client.get_run_task(
    id='string',
    taskId='string'
)

Parameters:

• id (string) –

  [REQUIRED]

  The workflow run ID.

• taskId (string) –

  [REQUIRED]

  The task’s ID.

Return type:

dict

Returns:

Response Syntax

{
    '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),
    'statusMessage': 'string',
    'logStream': 'string',
    'gpus': 123,
    'instanceType': 'string',
    'failureReason': 'string'
}

Response Structure

• (dict) –

  • taskId (string) –

    The task’s ID.

  • status (string) –

    The task’s status.

  • name (string) –

    The task’s name.

  • cpus (integer) –

    The task’s CPU usage.

  • 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 gigabytes.

  • creationTime (datetime) –

    When the task was created.

  • startTime (datetime) –

    The task’s start time.

  • stopTime (datetime) –

    The task’s stop time.

  • statusMessage (string) –

    The task’s status message.

  • logStream (string) –

    The task’s log stream.

  • gpus (integer) –

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

  • instanceType (string) –

    The instance type for a task.

  • failureReason (string) –

    The reason a task has failed.

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