AWS omics medium security documentation change
Summary
Added workflow version selection, storage type configuration, output bucket ownership verification, and updated CLI examples
Security assessment
Added 'Output bucket owner's account ID' field to verify bucket ownership, which addresses potential unauthorized access to S3 buckets by ensuring proper ownership validation
Diff
diff --git a/omics/latest/dev/starting-a-run.md b/omics/latest/dev/starting-a-run.md index 46f99e6e9..699971d53 100644 --- a//omics/latest/dev/starting-a-run.md +++ b//omics/latest/dev/starting-a-run.md @@ -12,0 +13,2 @@ You also set the run priority. How priority impacts the run depends on whether t +If you have created one or more workflow versions, you can specify the version when you start the run. If you don’t specify a version, HealthOmics starts the [default workflow version](./workflows-default-version.html). + @@ -64,0 +67,2 @@ object | "o":{"left":"a", "right":1} | In WDL, object maps to WDL Pair, Map, or + * **Workflow version** (Optional) - Select a workflow version to use for this run. If you don't select a version, the run uses the workflow default version. + @@ -67 +71 @@ object | "o":{"left":"a", "right":1} | In WDL, object maps to WDL Pair, Map, or - * **Run priority** \- The priority of this run. Higher numbers specify a higher priority, and the highest priority tasks are run first. + * **Run priority** (Optional) - The priority of this run. Higher numbers specify a higher priority, and the highest priority tasks are run first. @@ -69 +73,3 @@ object | "o":{"left":"a", "right":1} | In WDL, object maps to WDL Pair, Map, or - * **Run storage capacity** \- The amount of temporary storage needed for the run. By default, the run storage capacity that was set for the workflow will be selected. You can select a different run storage capacity for your run. + * **Run storage type** \- Specify the storage type here to override the default run storage type specified for the workflow. Static storage allocates a fixed amount of storage for the run. Dynamic storage scales up and down as required for each task in the run. + + * **Run storage capacity** \- For static run storage, specify the amount of storage needed for the run. This entry overrides the default run storage amount specified for the workflow. @@ -72,0 +79,2 @@ object | "o":{"left":"a", "right":1} | In WDL, object maps to WDL Pair, Map, or + * **Output bucket owner's account ID** (Optional) - If your account doesn't own the output bucket, enter the bucket owner's AWS account ID. This information is required so that HealthOmics can verify the bucket ownership. + @@ -107 +115 @@ Use the **start-run** API operation with the IAM role and Amazon S3 bucket that -In response, you get the following output. The `uuid` is unique to the run, and along with `runOutputUri` can be used to track where output data is written. +In response, you get the following output. The `uuid` is unique to the run, and along with `outputUri` can be used to track where output data is written. @@ -112 +120 @@ In response, you get the following output. The `uuid` is unique to the run, and - "id": "1234567", + "id": "123456789", @@ -114 +122 @@ In response, you get the following output. The `uuid` is unique to the run, and - "runOutputUri":"s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a" + "outputUri":"s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a" @@ -121,0 +130,17 @@ Reference the input JSON file in the AWS CLI by adding `--inputs file://<input_f +You can specify a workflow version for the run. + + + aws omics start-run + --workflow-id workflow id \ + ... + --workflow-version-name '1.2.1' + +You can override the default run storage type, which is specified in the workflow. + + + aws omics start-run + --workflow-id workflow id \ + ... + --storage-type STATIC + --storage-capacity 2400 + @@ -125 +150,2 @@ You can also use the **start-run** API with a GPU workflow ID, as shown. - aws omics start-run --workflow-id workflow id \ + aws omics start-run + --workflow-id workflow id \ @@ -146 +172 @@ The **get-run** API operation also returns other details, such as whether the wo - "runOutputUri":"s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a" + "outputUri":"s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a" @@ -149,0 +176 @@ The **get-run** API operation also returns other details, such as whether the wo + "workflowVersionName": "3.0.0",