StartRun - HealthOmics API Reference
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

StartRun

Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, AWS HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.

To start a new run, the following inputs are required:

  • A service role ARN (roleArn).

  • The run's workflow ID (workflowId, not the uuid or runId).

  • An Amazon S3 location (outputUri) where the run outputs will be saved.

  • All required workflow parameters (parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation.

  • For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage.

StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:

  • A service role ARN (roleArn).

  • The ID of the run to duplicate (runId).

  • An Amazon S3 location where the run outputs will be saved (outputUri).

To learn more about the optional parameters for StartRun, see Starting a run in the AWS HealthOmics User Guide.

Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:

  • Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit.

  • The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.

To learn more about the retention modes, see Run retention mode in the AWS HealthOmics User Guide.

Request Syntax

POST /run HTTP/1.1
Content-type: application/json

{
   "cacheBehavior": "string",
   "cacheId": "string",
   "logLevel": "string",
   "name": "string",
   "outputUri": "string",
   "parameters": JSON value,
   "priority": number,
   "requestId": "string",
   "retentionMode": "string",
   "roleArn": "string",
   "runGroupId": "string",
   "runId": "string",
   "storageCapacity": number,
   "storageType": "string",
   "tags": { 
      "string" : "string" 
   },
   "workflowId": "string",
   "workflowOwnerId": "string",
   "workflowType": "string",
   "workflowVersionName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

cacheBehavior

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: CACHE_ON_FAILURE | CACHE_ALWAYS

Required: No

cacheId

Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

logLevel

A log level for the run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: OFF | FATAL | ERROR | ALL

Required: No

name

A name for the run. This is recommended to view and organize runs in the AWS HealthOmics console and CloudWatch logs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

outputUri

An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 750.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

parameters

Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.

Type: JSON value

Required: No

priority

Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the AWS HealthOmics User Guide.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

requestId

An idempotency token used to dedupe retry requests so that duplicate runs are not created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: Yes

retentionMode

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

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: RETAIN | REMOVE

Required: No

roleArn

A service role for the run. The roleArn requires access to AWS HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:.+

Required: Yes

runGroupId

The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

runId

The ID of a run to duplicate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

storageCapacity

The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

storageType

The storage type for the run. If you set the storage type to DYNAMIC, AWS HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the AWS HealthOmics User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: STATIC | DYNAMIC

Required: No

tags

Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the AWS HealthOmics User Guide.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

workflowId

The run's workflow ID. The workflowId is not the UUID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

workflowOwnerId

The 12-digit account ID of the workflow owner that is used for running a shared workflow. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

Type: String

Pattern: [0-9]{12}

Required: No

workflowType

The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: PRIVATE | READY2RUN

Required: No

workflowVersionName

The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the AWS HealthOmics User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

Required: No

Response Syntax

HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "runOutputUri": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "uuid": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

arn

Unique resource identifier for the run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:.+

id

The run's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

runOutputUri

The destination for workflow outputs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 750.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

status

The run's status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: PENDING | STARTING | RUNNING | STOPPING | COMPLETED | DELETED | CANCELLED | FAILED

tags

The run's tags.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

uuid

The universally unique identifier for a run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: