Omics / Client / start_run

start_run

Omics.Client.start_run(**kwargs)

Starts a run.

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

Parameters:

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

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

• runId (string) – The run’s ID.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    'tags': {
        'string': '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) –

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