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.

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.

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',
    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.

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

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

      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.

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