選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料，以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用，但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意，AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定，並顯示相關內容，包括相關廣告。若要接受或拒絕所有非必要 Cookie，請按一下「接受」或「拒絕」。若要進行更詳細的選擇，請按一下「自訂」。

偏好設定
聯絡我們
意見回饋
AWS Documentation
建立 AWS 帳戶
StartRun - HealthOmics API Reference
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also
此頁面尚未翻譯為您的語言。 請求翻譯

StartRun

PDF

Starts a new run or duplicates an existing run.

For a new run, specify a unique requestId, the workflowId, and a role ARN. If you're using static run storage, specify the required storageCapacity.

You can also specify the S3 location where the run outputs will be saved. If you run a high volume of workflows concurrently, use separate S3 output URIs for each workflow to avoid bucket throttling. For more information, see Starting a run in AWS HealthOmics in the AWS HealthOmics User Guide..

You duplicate a run by specifing a unique requestId, the runID of the run to duplicate, and a role ARN.

For more information about the optional parameters in the StartRun request, see Starting a run in AWS HealthOmics 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"
}

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.

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 URI for the run.

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.

Type: JSON value

Required: No

priority

A priority for the run.

Type: Integer

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

Required: No

requestId

To ensure that requests don't run multiple times, specify a unique ID for each request.

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.

Type: String

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

Pattern: arn:.+

Required: Yes

runGroupId

The run's group ID.

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

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

Type: Integer

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

Required: No

storageType

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, AWS HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows 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.

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.

Type: String

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

Pattern: [0-9]+

Required: No

workflowOwnerId

The ID of the workflow owner.

Type: String

Pattern: [0-9]{12}

Required: No

workflowType

The run's workflow type.

Type: String

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

Valid Values: PRIVATE | READY2RUN

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:

下一個主題：

StartVariantImportJob

上一個主題：

StartReferenceImportJob

需要協助？

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。