AWS cli documentation change
Summary
Clarified workflow definition file requirements and parameter template handling
Security assessment
Changes improve operational clarity but don't address specific security vulnerabilities or introduce security controls. The zip format requirement is a technical constraint rather than a security measure.
Diff
diff --git a/cli/latest/reference/omics/create-workflow.md b/cli/latest/reference/omics/create-workflow.md index 64bccaa09..4e10d6573 100644 --- a//cli/latest/reference/omics/create-workflow.md +++ b//cli/latest/reference/omics/create-workflow.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 -Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow: +Creates a private workflow. Before you create a private workflow, you must create and configure these required resources: @@ -62,3 +62,2 @@ Creates a private workflow.Private workflows depend on a variety of resources th - * _Input data_ : Input data for the workflow, stored in an S3 bucket or a Amazon Web Services HealthOmics sequence store. - * _Workflow definition files_ : Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. - * _Parameter template files_ : Define run parameters using a parameter template file (written in JSON). + * _Workflow definition files_ : Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format. + * (Optional) _Parameter template_ : You can create a parameter template file that defines the run parameters, or Amazon Web Services HealthOmics can generate the parameter template for you. @@ -66 +65 @@ Creates a private workflow.Private workflows depend on a variety of resources th - * (Optional) _Sentieon licenses_ : Request a Sentieon license if you plan to use Sentieon software in a private workflow. + * (Optional) _Sentieon licenses_ : Request a Sentieon license if using the Sentieon software in a private workflow. @@ -70 +69 @@ Creates a private workflow.Private workflows depend on a variety of resources th -For more information, see [Creating or updating a private workflow in Amazon Web Services HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the Amazon Web Services HealthOmics User Guide. +For more information, see [Creating or updating a private workflow in Amazon Web Services HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -89,0 +89,6 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- + [--readme-markdown <value>] + [--parameter-template-path <value>] + [--readme-path <value>] + [--definition-repository <value>] + [--workflow-bucket-owner-id <value>] + [--readme-uri <value>] @@ -116 +121 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A name for the workflow. +> Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console. @@ -124 +129 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The workflow engine for the workflow. +> The workflow engine for the workflow. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition. @@ -136 +141 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A ZIP archive for the workflow. +> A ZIP archive containing the main workflow definition file and dependencies that it imports for the workflow. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see [Workflow definition requirements](https://docs.aws.amazon.com/omics/latest/dev/workflow-defn-requirements.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -140 +145 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The URI of a definition for the workflow. +> The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow. @@ -144 +149 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> The path of the main definition file for the workflow. +> The path of the main definition file for the workflow. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: `workflow-definition/main-file.wdl` . @@ -148 +153 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/omics- -> A parameter template for the workflow. +> A parameter template for the workflow. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see [Parameter template files](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -182 +187 @@ JSON Syntax: -> The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. +> The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The `storageCapacity` can be overwritten at run time. The storage capacity is not required for runs with a `DYNAMIC` storage type. @@ -186 +191 @@ JSON Syntax: -> Tags for the workflow. +> Tags for the workflow. You can define up to 50 tags for the workflow. 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_ . @@ -207 +212 @@ JSON Syntax: -> To ensure that requests don’t run multiple times, specify a unique ID for each request. +> An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests. @@ -221 +226 @@ JSON Syntax: -> The default storage type for runs that use this workflow. STATIC storage allocates a fixed amount of storage. DYNAMIC storage 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 default storage type for runs that use this workflow. The `storageType` can be overridden at run time. `DYNAMIC` storage dynamically scales the storage up or down, based on file system utilization. `STATIC` storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see [Run storage types](https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html) in the _Amazon Web Services HealthOmics User Guide_ . @@ -229,0 +235,76 @@ JSON Syntax: +`--readme-markdown` (string) + +> The markdown content for the workflow’s README file. This provides documentation and usage information for users of the workflow. + +`--parameter-template-path` (string) + +> The path to the workflow parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow. If not specified, the workflow will be created without a parameter template. + +`--readme-path` (string) + +> The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the `README.md` file from the root directory of the repository will be used. + +`--definition-repository` (structure) + +> The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository. +> +> connectionArn -> (string) +> +>> The Amazon Resource Name (ARN) of the connection to the source code repository. +> +> fullRepositoryId -> (string) +> +>> The full repository identifier, including the repository owner and name. For example, ‘repository-owner/repository-name’. +> +> sourceReference -> (structure) +> +>> The source reference for the repository, such as a branch name, tag, or commit ID. +>> +>> type -> (string) +>> +>>> The type of source reference, such as branch, tag, or commit. +>> +>> value -> (string) +>> +>>> The value of the source reference, such as the branch name, tag name, or commit ID. +> +> excludeFilePatterns -> (list) +> +>> A list of file patterns to exclude when retrieving the workflow definition from the repository. +>> +>> (string) + +Shorthand Syntax: + + + connectionArn=string,fullRepositoryId=string,sourceReference={type=string,value=string},excludeFilePatterns=string,string + + +JSON Syntax: + + + { + "connectionArn": "string", + "fullRepositoryId": "string", + "sourceReference": { + "type": "BRANCH"|"TAG"|"COMMIT", + "value": "string" + }, + "excludeFilePatterns": ["string", ...] + } + + +`--workflow-bucket-owner-id` (string) + +> The Amazon Web Services account ID of the expected owner of the S3 bucket that contains the workflow definition. If not specified, the service skips the validation. + +`--readme-uri` (string) + +> The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include: +> +> * The S3 URI must begin with `s3://USER-OWNED-BUCKET/` +> * The requester must have access to the S3 bucket and object. +> * The max README content length is 500 KiB. +> + + @@ -423 +504 @@ uuid -> (string) - * [AWS CLI 2.27.56 Command Reference](../../index.html) » + * [AWS CLI 2.27.59 Command Reference](../../index.html) »