AWS cli documentation change
Summary
Updated documentation for omics start-run command with detailed parameter explanations, retention mode controls, and clarification of required inputs
Security assessment
The changes add documentation about security best practices including required IAM role permissions (access to HealthOmics/S3/CloudWatch/EC2), output URI access controls, and retention modes that help prevent resource exhaustion. However, there is no evidence of addressing a specific security vulnerability.
Diff
diff --git a/cli/latest/reference/omics/start-run.md b/cli/latest/reference/omics/start-run.md index 081250c35..bfa619cdf 100644 --- a//cli/latest/reference/omics/start-run.md +++ b//cli/latest/reference/omics/start-run.md @@ -15 +15 @@ - * [AWS CLI 2.27.56 Command Reference](../../index.html) » + * [AWS CLI 2.27.59 Command Reference](../../index.html) » @@ -60 +60 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Starts a new run or duplicates an existing run. +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, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the `GetRun` API operation. @@ -62 +62 @@ 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 (the default), specify the required `storageCapacity` . +To start a new run, the following inputs are required: @@ -64 +64,5 @@ For a new run, specify a unique `requestId` , the `workflowId` , and a role ARN. -You duplicate a run by specifing a unique `requestId` , the `runID` of the run to duplicate, and a role ARN. + * 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. @@ -66 +70,20 @@ You duplicate a run by specifing a unique `requestId` , the `runID` of the run t -For more information about the optional parameters in the StartRun request, see [Starting a run](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html) in the _Amazon Web Services HealthOmics User Guide_ . + + +> `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](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html) in the _Amazon Web Services 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](https://docs.aws.amazon.com/omics/latest/dev/run-retention.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -121 +144 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The run’s workflow ID. +> The run’s workflow ID. The `workflowId` is not the UUID. @@ -125 +148 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The run’s workflow type. +> 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. @@ -140 +163 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A service role for the run. +> A service role for the run. The `roleArn` requires access to Amazon Web Services 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` . @@ -144 +167 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A name for the run. +> A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs. @@ -152 +175 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> 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](https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior) in the Amazon Web Services HealthOmics User Guide. +> 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](https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior) in the _Amazon Web Services HealthOmics User Guide_ . @@ -163 +186 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The run’s group ID. +> 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. @@ -167 +190 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A priority for the run. +> 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](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority) in the _Amazon Web Services HealthOmics User Guide_ . @@ -171 +194 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> Parameters for the run. +> 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. @@ -181 +204 @@ JSON Syntax: -> The static storage capacity (in gibibytes) for this run. This field is not required if the storage type is dynamic (the system ignores any value that you enter). +> 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). @@ -185 +208 @@ JSON Syntax: -> An output URI for the run. +> 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. @@ -202 +225 @@ JSON Syntax: -> Tags for the run. +> Tags for the run. You can add up to 50 tags per run. For more information, see [Adding a tag](https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -223 +246 @@ JSON Syntax: -> To ensure that requests don’t run multiple times, specify a unique ID for each request. +> An idempotency token used to dedupe retry requests so that duplicate runs are not created. @@ -227 +250 @@ JSON Syntax: -> The retention mode for the run. The default value is RETAIN. +> The retention mode for the run. The default value is `RETAIN` . @@ -229 +252 @@ JSON Syntax: -> Amazon Web Services 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` , Amazon Web Services 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. +> Amazon Web Services 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` , Amazon Web Services 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. @@ -242 +265 @@ JSON Syntax: -> The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see [Running workflows](https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html) in the _Amazon Web Services HealthOmics User Guide_ . +> The storage type for the run. If you set the storage type to `DYNAMIC` , Amazon Web Services 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](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -253 +276 @@ JSON Syntax: -> The ID of the workflow owner. +> 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. @@ -257 +280 @@ JSON Syntax: -> The name of the workflow version. +> 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](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -460 +483 @@ runOutputUri -> (string) - * [AWS CLI 2.27.56 Command Reference](../../index.html) » + * [AWS CLI 2.27.59 Command Reference](../../index.html) »