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.
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
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' )
- 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 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.
retentionMode (string) – The retention mode for the run.
- 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