Amazon Omics

{'runOutputUri': 'string', 'uuid': 'string'}

Gets information about a workflow run.

See also: AWS API Documentation

Request Syntax

client.get_run(
    id='string',
    export=[
        'DEFINITION',
    ]
)

type id:

string

param id:

[REQUIRED]

The run's ID.

type export:

list

param export:

The run's export format.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    'workflowId': 'string',
    'workflowType': 'PRIVATE'|'READY2RUN',
    'runId': 'string',
    'roleArn': 'string',
    'name': 'string',
    'runGroupId': 'string',
    'priority': 123,
    'definition': 'string',
    'digest': 'string',
    'parameters': {...}|[...]|123|123.4|'string'|True|None,
    'storageCapacity': 123,
    'outputUri': 'string',
    'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
    'resourceDigests': {
        'string': 'string'
    },
    'startedBy': 'string',
    'creationTime': datetime(2015, 1, 1),
    'startTime': datetime(2015, 1, 1),
    'stopTime': datetime(2015, 1, 1),
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    },
    'accelerators': 'GPU',
    'retentionMode': 'RETAIN'|'REMOVE',
    'failureReason': 'string',
    'logLocation': {
        'engineLogStream': 'string',
        'runLogStream': 'string'
    },
    'uuid': 'string',
    'runOutputUri': 'string'
}

Response Structure

• (dict) --

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

  • workflowType (string) --

    The run's workflow type.

  • runId (string) --

    The run's ID.

  • roleArn (string) --

    The run's service role ARN.

  • name (string) --

    The run's name.

  • runGroupId (string) --

    The run's group ID.

  • priority (integer) --

    The run's priority.

  • definition (string) --

    The run's definition.

  • digest (string) --

    The run's digest.

  • parameters (:ref:`document<document>`) --

    The run's parameters.

  • storageCapacity (integer) --

    The run's storage capacity in gigabytes.

  • outputUri (string) --

    The run's output URI.

  • logLevel (string) --

    The run's log level.

  • resourceDigests (dict) --

    The run's resource digests.

    • (string) --

      • (string) --

  • startedBy (string) --

    Who started the run.

  • creationTime (datetime) --

    When the run was created.

  • startTime (datetime) --

    When the run started.

  • stopTime (datetime) --

    The run's stop time.

  • statusMessage (string) --

    The run's status message.

  • tags (dict) --

    The run's tags.

    • (string) --

      • (string) --

  • accelerators (string) --

    The computational accelerator used to run the workflow.

  • retentionMode (string) --

    The run's retention mode.

  • failureReason (string) --

    The reason a run has failed.

  • logLocation (dict) --

    The location of the run log.

    • engineLogStream (string) --

      The log stream ARN for the engine log.

    • runLogStream (string) --

      The log stream ARN for the run log.

  • uuid (string) --

    The universally unique identifier for a run.

  • runOutputUri (string) --

    The destination for workflow outputs.

{'runOutputUri': 'string', 'uuid': 'string'}

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

See also: AWS API Documentation

Request Syntax

client.start_run(
    workflowId='string',
    workflowType='PRIVATE'|'READY2RUN',
    runId='string',
    roleArn='string',
    name='string',
    runGroupId='string',
    priority=123,
    parameters={...}|[...]|123|123.4|'string'|True|None,
    storageCapacity=123,
    outputUri='string',
    logLevel='OFF'|'FATAL'|'ERROR'|'ALL',
    tags={
        'string': 'string'
    },
    requestId='string',
    retentionMode='RETAIN'|'REMOVE'
)

type workflowId:

string

param workflowId:

The run's workflow ID.

type workflowType:

string

param workflowType:

The run's workflow type.

type runId:

string

param runId:

The ID of a run to duplicate.

type roleArn:

string

param roleArn:

[REQUIRED]

A service role for the run.

type name:

string

param name:

A name for the run.

type runGroupId:

string

param runGroupId:

The run's group ID.

type priority:

integer

param priority:

A priority for the run.

type parameters:

:ref:`document<document>`

param parameters:

Parameters for the run.

type storageCapacity:

integer

param storageCapacity:

A storage capacity for the run in gigabytes.

type outputUri:

string

param outputUri:

An output URI for the run.

type logLevel:

string

param logLevel:

A log level for the run.

type tags:

dict

param tags:

Tags for the run.

• (string) --

  • (string) --

type requestId:

string

param requestId:

[REQUIRED]

To ensure that requests don't run multiple times, specify a unique ID for each request.

This field is autopopulated if not provided.

type retentionMode:

string

param retentionMode:

The retention mode for the run.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    'tags': {
        'string': 'string'
    },
    'uuid': 'string',
    'runOutputUri': 'string'
}

Response Structure

• (dict) --

  • arn (string) --

    The run's ARN.

  • id (string) --

    The run's ID.

  • status (string) --

    The run's status.

  • tags (dict) --

    The run's tags.

    • (string) --

      • (string) --

  • uuid (string) --

    The universally unique identifier for a run.

  • runOutputUri (string) --

    The destination for workflow outputs.