start_run

Omics.Client.start_run(**kwargs)

Starts a run.

See also: AWS API Documentation

Request Syntax

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

Parameters

• logLevel (string) -- A log level for the run.
• name (string) -- A name for the run.
• outputUri (string) -- An output URI for the run.
• parameters (document) -- Parameters for the run.
• priority (integer) -- A priority for the run.
• 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.

• roleArn (string) --

  [REQUIRED]

  A service role for the run.

• runGroupId (string) -- The run's group ID.
• runId (string) -- The run's ID.
• storageCapacity (integer) -- A storage capacity for the run in gigabytes.
• tags (dict) --

  Tags for the run.

  • (string) --
    • (string) --
• workflowId (string) -- The run's workflow ID.
• workflowType (string) -- The run's workflows type.

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