Omics / Client / start_run

start_run#

Omics.Client.start_run(**kwargs)#

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.

StartRun will not support re-run for a workflow that is shared with you.

HealthOmics stores a fixed number of runs that are available to the console and API. By default, HealthOmics doesn’t any remove any runs. If HealthOmics reaches the maximum number of runs, you must manually remove runs. To have older runs removed automatically, set the retention mode to REMOVE.

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_run(
    workflowId='string',
    workflowType='PRIVATE'|'READY2RUN',
    runId='string',
    roleArn='string',
    name='string',
    cacheId='string',
    cacheBehavior='CACHE_ON_FAILURE'|'CACHE_ALWAYS',
    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',
    storageType='STATIC'|'DYNAMIC',
    workflowOwnerId='string'
)
Parameters:

  • workflowId (string) – The run’s workflow ID.

  • workflowType (string) – The run’s workflow type.

  • runId (string) – The ID of a run to duplicate.

  • roleArn (string) –

    [REQUIRED]

    A service role for the run.

  • name (string) – A name for the run.

  • cacheId (string) – Identifier of the cache associated with this run. If you don’t specify a cache ID, no task outputs are cached for this run.

  • cacheBehavior (string) – The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the AWS HealthOmics User Guide.

  • runGroupId (string) – The run’s group ID.

  • priority (integer) – A priority for the run.

  • parameters (document) – Parameters for the run.

  • storageCapacity (integer) – A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

  • outputUri (string) – An output URI for the run.

  • logLevel (string) – A log level for the run.

  • tags (dict) –

    Tags for the run.

    • (string) –

      • (string) –

  • requestId (string) –

    [REQUIRED]

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

    This field is autopopulated if not provided.

  • retentionMode (string) –

    The retention mode for the run. The default value is RETAIN.

    HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.

    For more information about retention mode, see Specifying run retention mode in the AWS HealthOmics User Guide.

  • storageType (string) – The run’s storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

  • workflowOwnerId (string) – The ID of the workflow owner.

Return type:

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) –

      Unique resource identifier for the run.

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

Exceptions