Amazon Omics

{'uuid': 'string'}

Gets detailed information about a run task using its ID.

See also: AWS API Documentation

Request Syntax

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

type id:

string

param id:

[REQUIRED]

The workflow run ID.

type taskId:

string

param taskId:

[REQUIRED]

The task's ID.

rtype:

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',
    'imageDetails': {
        'image': 'string',
        'imageDigest': 'string',
        'sourceImage': 'string'
    },
    'uuid': '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 Amazon Web Services 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.

  • imageDetails (dict) --

    Details about the container image that this task uses.

    • image (string) --

      The URI of the container image.

    • imageDigest (string) --

      The container image digest. If the image URI was transformed, this will be the digest of the container image referenced by the transformed URI.

    • sourceImage (string) --

      URI of the source registry. If the URI is from a third-party registry, Amazon Web Services HealthOmics transforms the URI to the corresponding ECR path, using the pull-through cache mapping rules.

  • uuid (string) --

    The universally unique identifier (UUID) for the workflow task.

{'items': {'uuid': 'string'}}

Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.

See also: AWS API Documentation

Request Syntax

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

type id:

string

param id:

[REQUIRED]

The run's ID.

type status:

string

param status:

Filter the list by status.

type startingToken:

string

param startingToken:

Specify the pagination token from a previous request to retrieve the next page of results.

type maxResults:

integer

param maxResults:

The maximum number of run tasks to return in one page of results.

rtype:

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',
            'uuid': '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 Amazon Web Services 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.

      • uuid (string) --

        The universally unique identifier (UUID) for the workflow task.

  • nextToken (string) --

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