@aws-sdk/client-omics 3.848.0 → 3.855.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +36 -5
  3. package/dist-es/commands/UploadReadSetPartCommand.js +1 -1
  4. package/dist-es/models/models_0.js +6 -3
  5. package/dist-es/models/models_1.js +3 -1
  6. package/dist-es/protocols/Aws_restJson1.js +19 -0
  7. package/dist-types/Omics.d.ts +1 -1
  8. package/dist-types/OmicsClient.d.ts +1 -1
  9. package/dist-types/commands/CancelRunCommand.d.ts +1 -1
  10. package/dist-types/commands/CreateRunCacheCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateRunGroupCommand.d.ts +1 -1
  12. package/dist-types/commands/CreateWorkflowCommand.d.ts +17 -1
  13. package/dist-types/commands/CreateWorkflowVersionCommand.d.ts +16 -1
  14. package/dist-types/commands/DeleteRunCacheCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteRunCommand.d.ts +1 -1
  16. package/dist-types/commands/DeleteRunGroupCommand.d.ts +1 -1
  17. package/dist-types/commands/DeleteWorkflowCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteWorkflowVersionCommand.d.ts +1 -1
  19. package/dist-types/commands/GetRunCacheCommand.d.ts +1 -1
  20. package/dist-types/commands/GetRunCommand.d.ts +1 -1
  21. package/dist-types/commands/GetRunGroupCommand.d.ts +1 -1
  22. package/dist-types/commands/GetRunTaskCommand.d.ts +1 -1
  23. package/dist-types/commands/GetWorkflowCommand.d.ts +13 -1
  24. package/dist-types/commands/GetWorkflowVersionCommand.d.ts +13 -1
  25. package/dist-types/commands/ListRunCachesCommand.d.ts +1 -1
  26. package/dist-types/commands/ListRunGroupsCommand.d.ts +1 -1
  27. package/dist-types/commands/ListRunTasksCommand.d.ts +1 -1
  28. package/dist-types/commands/ListRunsCommand.d.ts +1 -1
  29. package/dist-types/commands/ListWorkflowVersionsCommand.d.ts +1 -1
  30. package/dist-types/commands/ListWorkflowsCommand.d.ts +1 -1
  31. package/dist-types/commands/StartRunCommand.d.ts +1 -1
  32. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateRunCacheCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateRunGroupCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateWorkflowCommand.d.ts +2 -1
  36. package/dist-types/commands/UpdateWorkflowVersionCommand.d.ts +2 -1
  37. package/dist-types/commands/UploadReadSetPartCommand.d.ts +1 -1
  38. package/dist-types/index.d.ts +1 -1
  39. package/dist-types/models/models_0.d.ts +199 -91
  40. package/dist-types/models/models_1.d.ts +76 -1
  41. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/UploadReadSetPartCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/models/models_0.d.ts +42 -18
  44. package/dist-types/ts3.4/models/models_1.d.ts +27 -1
  45. package/package.json +5 -5
@@ -27,7 +27,7 @@ declare const ListWorkflowVersionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the workflow versions for the specified workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the Amazon Web Services HealthOmics User Guide.</p>
30
+ * <p>Lists the workflow versions for the specified workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListWorkflowsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves a list of workflows.</p>
30
+ * <p>Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify <code>PRIVATE</code> to retrieve a list of private workflows or specify <code>READY2RUN</code> for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const StartRunCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Starts a new run or duplicates an existing run.</p> <p>For a new run, specify a unique <code>requestId</code>, the <code>workflowId</code>, and a role ARN. If you're using static run storage (the default), specify the required <code>storageCapacity</code>.</p> <p>You duplicate a run by specifing a unique <code>requestId</code>, the <code>runID</code> of the run to duplicate, and a role ARN.</p> <p>For more information about the optional parameters in the StartRun request, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Starting a run</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
30
+ * <p>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 <code>GetRun</code> API operation.</p> <p>To start a new run, the following inputs are required:</p> <ul> <li> <p>A service role ARN (<code>roleArn</code>).</p> </li> <li> <p>The run's workflow ID (<code>workflowId</code>, not the <code>uuid</code> or <code>runId</code>).</p> </li> <li> <p>An Amazon S3 location (<code>outputUri</code>) where the run outputs will be saved.</p> </li> <li> <p>All required workflow parameters (<code>parameter</code>), 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 <code>GetRun</code> API operation. </p> </li> <li> <p>For runs with a <code>STATIC</code> (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use <code>DYNAMIC</code> storage.</p> </li> </ul> <p> <code>StartRun</code> 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:</p> <ul> <li> <p>A service role ARN (<code>roleArn</code>).</p> </li> <li> <p>The ID of the run to duplicate (<code>runId</code>).</p> </li> <li> <p>An Amazon S3 location where the run outputs will be saved (<code>outputUri</code>).</p> </li> </ul> <p>To learn more about the optional parameters for <code>StartRun</code>, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Starting a run</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p> <p>Use the <code>retentionMode</code> input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:</p> <ul> <li> <p>Specify <code>REMOVE</code> to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the <code>REMOVE</code> mode to initiate major run requests so that your runs do not fail when you reach the limit.</p> </li> <li> <p>The <code>retentionMode</code> is set to the <code>RETAIN</code> 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.</p> </li> </ul> <p>To learn more about the retention modes, see <a href="https://docs.aws.amazon.com/omics/latest/dev/run-retention.html">Run retention mode</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
3
+ import { TagResourceRequest, TagResourceResponse } from "../models/models_1";
4
4
  import { OmicsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OmicsClient";
5
5
  /**
6
6
  * @public
@@ -27,7 +27,7 @@ declare const UpdateRunCacheCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update a run cache. </p>
30
+ * <p>Updates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with <code>CACHE_ON_FAILURE</code> or <code>CACHE_ALWAYS</code>. To confirm that your run cache settings have been properly updated, use the <code>GetRunCache</code> API operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html">How call caching works</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const UpdateRunGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a run group.</p>
30
+ * <p>Updates the settings of a run group and returns a response with no body if the operation is successful.</p> <p>You can update the following settings with <code>UpdateRunGroup</code>:</p> <ul> <li> <p>Maximum number of CPUs</p> </li> <li> <p>Run time (measured in minutes)</p> </li> <li> <p>Number of GPUs</p> </li> <li> <p>Number of concurrent runs</p> </li> <li> <p>Group name</p> </li> </ul> <p>To confirm that the settings have been successfully updated, use the <code>ListRunGroups</code> or <code>GetRunGroup</code> API operations to verify that the desired changes have been made.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const UpdateWorkflowCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates information about a workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/update-private-workflow.html">Update a private workflow</a> in the Amazon Web Services HealthOmics User Guide.</p>
30
+ * <p>Updates information about a workflow.</p> <p>You can update the following workflow information:</p> <ul> <li> <p>Name</p> </li> <li> <p>Description</p> </li> <li> <p>Default storage type</p> </li> <li> <p>Default storage capacity (with workflow ID)</p> </li> </ul> <p>This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the <code>GetWorkflow</code> API operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/update-private-workflow.html">Update a private workflow</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -40,6 +40,7 @@ declare const UpdateWorkflowCommand_base: {
40
40
  * description: "STRING_VALUE",
41
41
  * storageType: "STRING_VALUE",
42
42
  * storageCapacity: Number("int"),
43
+ * readmeMarkdown: "STRING_VALUE",
43
44
  * };
44
45
  * const command = new UpdateWorkflowCommand(input);
45
46
  * const response = await client.send(command);
@@ -27,7 +27,7 @@ declare const UpdateWorkflowVersionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates information about the workflow version. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the Amazon Web Services HealthOmics User Guide.</p>
30
+ * <p>Updates information about the workflow version. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -40,6 +40,7 @@ declare const UpdateWorkflowVersionCommand_base: {
40
40
  * description: "STRING_VALUE",
41
41
  * storageType: "STRING_VALUE",
42
42
  * storageCapacity: Number("int"),
43
+ * readmeMarkdown: "STRING_VALUE",
43
44
  * };
44
45
  * const command = new UpdateWorkflowVersionCommand(input);
45
46
  * const response = await client.send(command);
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer, StreamingBlobPayloadInputTypes } from "@smithy/types";
3
- import { UploadReadSetPartRequest, UploadReadSetPartResponse } from "../models/models_0";
3
+ import { UploadReadSetPartRequest, UploadReadSetPartResponse } from "../models/models_1";
4
4
  import { OmicsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OmicsClient";
5
5
  /**
6
6
  * @public
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <p>This is the <i>AWS HealthOmics API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/omics/latest/dev/">What is AWS HealthOmics?</a> in the <i>AWS HealthOmics User Guide</i>.</p>
2
+ * <p>Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services.</p> <p>For an introduction to the service, see <a href="https://docs.aws.amazon.com/omics/latest/dev/what-is-healthomics.html">What is Amazon Web Services HealthOmics?</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
3
3
  *
4
4
  * @packageDocumentation
5
5
  */
@@ -2182,7 +2182,7 @@ export interface CreateReferenceStoreResponse {
2182
2182
  */
2183
2183
  export interface CreateRunCacheRequest {
2184
2184
  /**
2185
- * <p>Default cache behavior for runs that use this cache. Supported values are:</p> <p> <code>CACHE_ON_FAILURE</code>: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.</p> <p> <code>CACHE_ALWAYS</code>: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.</p> <p>If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the Amazon Web Services HealthOmics User Guide.</p>
2185
+ * <p>Default cache behavior for runs that use this cache. Supported values are:</p> <p> <code>CACHE_ON_FAILURE</code>: Caches task outputs from completed tasks for runs that fail. This setting is useful if you're debugging a workflow that fails after several tasks completed successfully. The subsequent run uses the cache outputs for previously-completed tasks if the task definition, inputs, and container in ECR are identical to the prior run.</p> <p> <code>CACHE_ALWAYS</code>: Caches task outputs from completed tasks for all runs. This setting is useful in development mode, but do not use it in a production setting.</p> <p>If you don't specify a value, the default behavior is CACHE_ON_FAILURE. When you start a run that uses this cache, you can override the default cache behavior.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2186
2186
  * @public
2187
2187
  */
2188
2188
  cacheBehavior?: CacheBehavior | undefined;
@@ -2590,6 +2590,61 @@ export interface CreateVariantStoreResponse {
2590
2590
  */
2591
2591
  creationTime: Date | undefined;
2592
2592
  }
2593
+ /**
2594
+ * @public
2595
+ * @enum
2596
+ */
2597
+ export declare const SourceReferenceType: {
2598
+ readonly BRANCH: "BRANCH";
2599
+ readonly COMMIT: "COMMIT";
2600
+ readonly TAG: "TAG";
2601
+ };
2602
+ /**
2603
+ * @public
2604
+ */
2605
+ export type SourceReferenceType = (typeof SourceReferenceType)[keyof typeof SourceReferenceType];
2606
+ /**
2607
+ * <p>Contains information about the source reference in a code repository, such as a branch, tag, or commit.</p>
2608
+ * @public
2609
+ */
2610
+ export interface SourceReference {
2611
+ /**
2612
+ * <p>The type of source reference, such as branch, tag, or commit.</p>
2613
+ * @public
2614
+ */
2615
+ type: SourceReferenceType | undefined;
2616
+ /**
2617
+ * <p>The value of the source reference, such as the branch name, tag name, or commit ID.</p>
2618
+ * @public
2619
+ */
2620
+ value: string | undefined;
2621
+ }
2622
+ /**
2623
+ * <p>Contains information about a source code repository that hosts the workflow definition files.</p>
2624
+ * @public
2625
+ */
2626
+ export interface DefinitionRepository {
2627
+ /**
2628
+ * <p>The Amazon Resource Name (ARN) of the connection to the source code repository.</p>
2629
+ * @public
2630
+ */
2631
+ connectionArn: string | undefined;
2632
+ /**
2633
+ * <p>The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.</p>
2634
+ * @public
2635
+ */
2636
+ fullRepositoryId: string | undefined;
2637
+ /**
2638
+ * <p>The source reference for the repository, such as a branch name, tag, or commit ID.</p>
2639
+ * @public
2640
+ */
2641
+ sourceReference?: SourceReference | undefined;
2642
+ /**
2643
+ * <p>A list of file patterns to exclude when retrieving the workflow definition from the repository.</p>
2644
+ * @public
2645
+ */
2646
+ excludeFilePatterns?: string[] | undefined;
2647
+ }
2593
2648
  /**
2594
2649
  * @public
2595
2650
  * @enum
@@ -2636,7 +2691,7 @@ export type StorageType = (typeof StorageType)[keyof typeof StorageType];
2636
2691
  */
2637
2692
  export interface CreateWorkflowRequest {
2638
2693
  /**
2639
- * <p>A name for the workflow.</p>
2694
+ * <p>Name (optional but highly recommended) for the workflow to locate relevant information in the CloudWatch logs and Amazon Web Services HealthOmics console. </p>
2640
2695
  * @public
2641
2696
  */
2642
2697
  name?: string | undefined;
@@ -2646,42 +2701,42 @@ export interface CreateWorkflowRequest {
2646
2701
  */
2647
2702
  description?: string | undefined;
2648
2703
  /**
2649
- * <p>The workflow engine for the workflow.</p>
2704
+ * <p>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.</p>
2650
2705
  * @public
2651
2706
  */
2652
2707
  engine?: WorkflowEngine | undefined;
2653
2708
  /**
2654
- * <p>A ZIP archive for the workflow.</p>
2709
+ * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-defn-requirements.html">Workflow definition requirements</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2655
2710
  * @public
2656
2711
  */
2657
2712
  definitionZip?: Uint8Array | undefined;
2658
2713
  /**
2659
- * <p>The URI of a definition for the workflow.</p>
2714
+ * <p>The S3 URI of a definition for the workflow. The S3 bucket must be in the same region as the workflow.</p>
2660
2715
  * @public
2661
2716
  */
2662
2717
  definitionUri?: string | undefined;
2663
2718
  /**
2664
- * <p>The path of the main definition file for the workflow.</p>
2719
+ * <p>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: <code>workflow-definition/main-file.wdl</code>. </p>
2665
2720
  * @public
2666
2721
  */
2667
2722
  main?: string | undefined;
2668
2723
  /**
2669
- * <p>A parameter template for the workflow.</p>
2724
+ * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html">Parameter template files</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2670
2725
  * @public
2671
2726
  */
2672
2727
  parameterTemplate?: Record<string, WorkflowParameter> | undefined;
2673
2728
  /**
2674
- * <p>The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.</p>
2729
+ * <p>The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. The <code>storageCapacity</code> can be overwritten at run time. The storage capacity is not required for runs with a <code>DYNAMIC</code> storage type.</p>
2675
2730
  * @public
2676
2731
  */
2677
2732
  storageCapacity?: number | undefined;
2678
2733
  /**
2679
- * <p>Tags for the workflow.</p>
2734
+ * <p>Tags for the workflow. You can define up to 50 tags for the workflow. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html">Adding a tag</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2680
2735
  * @public
2681
2736
  */
2682
2737
  tags?: Record<string, string> | undefined;
2683
2738
  /**
2684
- * <p>To ensure that requests don't run multiple times, specify a unique ID for each request.</p>
2739
+ * <p>An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.</p>
2685
2740
  * @public
2686
2741
  */
2687
2742
  requestId?: string | undefined;
@@ -2691,10 +2746,40 @@ export interface CreateWorkflowRequest {
2691
2746
  */
2692
2747
  accelerators?: Accelerators | undefined;
2693
2748
  /**
2694
- * <p> 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 <a href="https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html">Running workflows</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2749
+ * <p>The default storage type for runs that use this workflow. The <code>storageType</code> can be overridden at run time. <code>DYNAMIC</code> storage dynamically scales the storage up or down, based on file system utilization. <code>STATIC</code> storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
2695
2750
  * @public
2696
2751
  */
2697
2752
  storageType?: StorageType | undefined;
2753
+ /**
2754
+ * <p>The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.</p>
2755
+ * @public
2756
+ */
2757
+ readmeMarkdown?: string | undefined;
2758
+ /**
2759
+ * <p>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.</p>
2760
+ * @public
2761
+ */
2762
+ parameterTemplatePath?: string | undefined;
2763
+ /**
2764
+ * <p>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 <code>README.md</code> file from the root directory of the repository will be used.</p>
2765
+ * @public
2766
+ */
2767
+ readmePath?: string | undefined;
2768
+ /**
2769
+ * <p>The repository information for the workflow definition. This allows you to source your workflow definition directly from a code repository.</p>
2770
+ * @public
2771
+ */
2772
+ definitionRepository?: DefinitionRepository | undefined;
2773
+ /**
2774
+ * <p>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.</p>
2775
+ * @public
2776
+ */
2777
+ workflowBucketOwnerId?: string | undefined;
2778
+ /**
2779
+ * <p>The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. Requirements include:</p> <ul> <li> <p>The S3 URI must begin with <code>s3://USER-OWNED-BUCKET/</code> </p> </li> <li> <p>The requester must have access to the S3 bucket and object.</p> </li> <li> <p>The max README content length is 500 KiB.</p> </li> </ul>
2780
+ * @public
2781
+ */
2782
+ readmeUri?: string | undefined;
2698
2783
  }
2699
2784
  /**
2700
2785
  * @public
@@ -2816,6 +2901,31 @@ export interface CreateWorkflowVersionRequest {
2816
2901
  * @public
2817
2902
  */
2818
2903
  workflowBucketOwnerId?: string | undefined;
2904
+ /**
2905
+ * <p>The markdown content for the workflow version's README file. This provides documentation and usage information for users of this specific workflow version.</p>
2906
+ * @public
2907
+ */
2908
+ readmeMarkdown?: string | undefined;
2909
+ /**
2910
+ * <p>The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.</p>
2911
+ * @public
2912
+ */
2913
+ parameterTemplatePath?: string | undefined;
2914
+ /**
2915
+ * <p>The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the <code>README.md</code> file from the root directory of the repository will be used.</p>
2916
+ * @public
2917
+ */
2918
+ readmePath?: string | undefined;
2919
+ /**
2920
+ * <p>The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.</p>
2921
+ * @public
2922
+ */
2923
+ definitionRepository?: DefinitionRepository | undefined;
2924
+ /**
2925
+ * <p>The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:</p> <ul> <li> <p>The S3 URI must begin with <code>s3://USER-OWNED-BUCKET/</code> </p> </li> <li> <p>The requester must have access to the S3 bucket and object.</p> </li> <li> <p>The max README content length is 500 KiB.</p> </li> </ul>
2926
+ * @public
2927
+ */
2928
+ readmeUri?: string | undefined;
2819
2929
  }
2820
2930
  /**
2821
2931
  * @public
@@ -2864,6 +2974,37 @@ export declare const CreationType: {
2864
2974
  * @public
2865
2975
  */
2866
2976
  export type CreationType = (typeof CreationType)[keyof typeof CreationType];
2977
+ /**
2978
+ * <p>Contains detailed information about the source code repository that hosts the workflow definition files.</p>
2979
+ * @public
2980
+ */
2981
+ export interface DefinitionRepositoryDetails {
2982
+ /**
2983
+ * <p>The Amazon Resource Name (ARN) of the connection to the source code repository.</p>
2984
+ * @public
2985
+ */
2986
+ connectionArn?: string | undefined;
2987
+ /**
2988
+ * <p>The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.</p>
2989
+ * @public
2990
+ */
2991
+ fullRepositoryId?: string | undefined;
2992
+ /**
2993
+ * <p>The source reference for the repository, such as a branch name, tag, or commit ID.</p>
2994
+ * @public
2995
+ */
2996
+ sourceReference?: SourceReference | undefined;
2997
+ /**
2998
+ * <p>The provider type of the source code repository, such as Bitbucket, GitHub, GitHubEnterpriseServer, GitLab, and GitLabSelfManaged.</p>
2999
+ * @public
3000
+ */
3001
+ providerType?: string | undefined;
3002
+ /**
3003
+ * <p>The endpoint URL of the source code repository provider.</p>
3004
+ * @public
3005
+ */
3006
+ providerEndpoint?: string | undefined;
3007
+ }
2867
3008
  /**
2868
3009
  * @public
2869
3010
  */
@@ -5036,6 +5177,7 @@ export interface GetVariantStoreResponse {
5036
5177
  */
5037
5178
  export declare const WorkflowExport: {
5038
5179
  readonly DEFINITION: "DEFINITION";
5180
+ readonly README: "README";
5039
5181
  };
5040
5182
  /**
5041
5183
  * @public
@@ -5165,6 +5307,21 @@ export interface GetWorkflowResponse {
5165
5307
  * @public
5166
5308
  */
5167
5309
  uuid?: string | undefined;
5310
+ /**
5311
+ * <p>The README content for the workflow, providing documentation and usage information.</p>
5312
+ * @public
5313
+ */
5314
+ readme?: string | undefined;
5315
+ /**
5316
+ * <p>Details about the source code repository that hosts the workflow definition files.</p>
5317
+ * @public
5318
+ */
5319
+ definitionRepositoryDetails?: DefinitionRepositoryDetails | undefined;
5320
+ /**
5321
+ * <p>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 <code>README.md</code> file from the root directory of the repository will be used.</p>
5322
+ * @public
5323
+ */
5324
+ readmePath?: string | undefined;
5168
5325
  }
5169
5326
  /**
5170
5327
  * @public
@@ -5300,6 +5457,21 @@ export interface GetWorkflowVersionResponse {
5300
5457
  * @public
5301
5458
  */
5302
5459
  workflowBucketOwnerId?: string | undefined;
5460
+ /**
5461
+ * <p>The README content for the workflow version, providing documentation and usage information specific to this version.</p>
5462
+ * @public
5463
+ */
5464
+ readme?: string | undefined;
5465
+ /**
5466
+ * <p>Details about the source code repository that hosts the workflow version definition files.</p>
5467
+ * @public
5468
+ */
5469
+ definitionRepositoryDetails?: DefinitionRepositoryDetails | undefined;
5470
+ /**
5471
+ * <p>The path to the workflow version README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the <code>README.md</code> file from the root directory of the repository will be used.</p>
5472
+ * @public
5473
+ */
5474
+ readmePath?: string | undefined;
5303
5475
  }
5304
5476
  /**
5305
5477
  * <p>A filter for import read set jobs.</p>
@@ -7315,12 +7487,12 @@ export interface UpdateRunGroupRequest {
7315
7487
  */
7316
7488
  export interface StartRunRequest {
7317
7489
  /**
7318
- * <p>The run's workflow ID.</p>
7490
+ * <p>The run's workflow ID. The <code>workflowId</code> is not the UUID.</p>
7319
7491
  * @public
7320
7492
  */
7321
7493
  workflowId?: string | undefined;
7322
7494
  /**
7323
- * <p>The run's workflow type.</p>
7495
+ * <p>The run's workflow type. The <code>workflowType</code> must be specified if you are running a <code>READY2RUN</code> workflow. If you are running a <code>PRIVATE</code> workflow (default), you do not need to include the workflow type. </p>
7324
7496
  * @public
7325
7497
  */
7326
7498
  workflowType?: WorkflowType | undefined;
@@ -7330,12 +7502,12 @@ export interface StartRunRequest {
7330
7502
  */
7331
7503
  runId?: string | undefined;
7332
7504
  /**
7333
- * <p>A service role for the run.</p>
7505
+ * <p>A service role for the run. The <code>roleArn</code> requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example <code>roleArn</code> is <code>arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ</code>. In this example, the AWS account ID is <code>123456789012</code> and the role name is <code>omics-service-role-serviceRole-W8O1XMPL7QZ</code>.</p>
7334
7506
  * @public
7335
7507
  */
7336
7508
  roleArn: string | undefined;
7337
7509
  /**
7338
- * <p>A name for the run.</p>
7510
+ * <p>A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.</p>
7339
7511
  * @public
7340
7512
  */
7341
7513
  name?: string | undefined;
@@ -7345,32 +7517,32 @@ export interface StartRunRequest {
7345
7517
  */
7346
7518
  cacheId?: string | undefined;
7347
7519
  /**
7348
- * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the Amazon Web Services HealthOmics User Guide.</p>
7520
+ * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/how-run-cache.html#run-cache-behavior">Run cache behavior</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7349
7521
  * @public
7350
7522
  */
7351
7523
  cacheBehavior?: CacheBehavior | undefined;
7352
7524
  /**
7353
- * <p>The run's group ID.</p>
7525
+ * <p>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.</p>
7354
7526
  * @public
7355
7527
  */
7356
7528
  runGroupId?: string | undefined;
7357
7529
  /**
7358
- * <p>A priority for the run.</p>
7530
+ * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html#run-priority">Run priority</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7359
7531
  * @public
7360
7532
  */
7361
7533
  priority?: number | undefined;
7362
7534
  /**
7363
- * <p>Parameters for the run.</p>
7535
+ * <p>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.</p>
7364
7536
  * @public
7365
7537
  */
7366
7538
  parameters?: __DocumentType | undefined;
7367
7539
  /**
7368
- * <p>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).</p>
7540
+ * <p>The <code>STATIC</code> 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 <code>DYNAMIC</code> (the system ignores any value that you enter).</p>
7369
7541
  * @public
7370
7542
  */
7371
7543
  storageCapacity?: number | undefined;
7372
7544
  /**
7373
- * <p>An output URI for the run.</p>
7545
+ * <p>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.</p>
7374
7546
  * @public
7375
7547
  */
7376
7548
  outputUri?: string | undefined;
@@ -7380,32 +7552,32 @@ export interface StartRunRequest {
7380
7552
  */
7381
7553
  logLevel?: RunLogLevel | undefined;
7382
7554
  /**
7383
- * <p>Tags for the run.</p>
7555
+ * <p>Tags for the run. You can add up to 50 tags per run. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/add-a-tag.html">Adding a tag</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7384
7556
  * @public
7385
7557
  */
7386
7558
  tags?: Record<string, string> | undefined;
7387
7559
  /**
7388
- * <p>To ensure that requests don't run multiple times, specify a unique ID for each request.</p>
7560
+ * <p>An idempotency token used to dedupe retry requests so that duplicate runs are not created.</p>
7389
7561
  * @public
7390
7562
  */
7391
7563
  requestId?: string | undefined;
7392
7564
  /**
7393
- * <p>The retention mode for the run. The default value is RETAIN. </p> <p>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 <code>REMOVE</code>, 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.</p> <p>For more information about retention mode, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Specifying run retention mode</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7565
+ * <p>The retention mode for the run. The default value is <code>RETAIN</code>. </p> <p>Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode (<code>RETAIN</code>), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to <code>REMOVE</code>, Amazon Web Services HealthOmics automatically removes runs (that have mode set to <code>REMOVE</code>) 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.</p> <p>For more information about retention mode, see <a href="https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html">Specifying run retention mode</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7394
7566
  * @public
7395
7567
  */
7396
7568
  retentionMode?: RunRetentionMode | undefined;
7397
7569
  /**
7398
- * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/Using-workflows.html">Running workflows</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7570
+ * <p>The storage type for the run. If you set the storage type to <code>DYNAMIC</code>, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses <code>STATIC</code> storage type, which allocates a fixed amount of storage. For more information about <code>DYNAMIC</code> and <code>STATIC</code> storage, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html">Run storage types</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7399
7571
  * @public
7400
7572
  */
7401
7573
  storageType?: StorageType | undefined;
7402
7574
  /**
7403
- * <p>The ID of the workflow owner. </p>
7575
+ * <p>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 <code>GetShare</code> API operation. If you are the workflow owner, you do not need to include this ID.</p>
7404
7576
  * @public
7405
7577
  */
7406
7578
  workflowOwnerId?: string | undefined;
7407
7579
  /**
7408
- * <p>The name of the workflow version.</p>
7580
+ * <p>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 <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
7409
7581
  * @public
7410
7582
  */
7411
7583
  workflowVersionName?: string | undefined;
@@ -7777,66 +7949,6 @@ export interface UpdateSequenceStoreResponse {
7777
7949
  */
7778
7950
  eTagAlgorithmFamily?: ETagAlgorithmFamily | undefined;
7779
7951
  }
7780
- /**
7781
- * @public
7782
- */
7783
- export interface UploadReadSetPartRequest {
7784
- /**
7785
- * <p>The Sequence Store ID used for the multipart upload.</p>
7786
- * @public
7787
- */
7788
- sequenceStoreId: string | undefined;
7789
- /**
7790
- * <p>The ID for the initiated multipart upload.</p>
7791
- * @public
7792
- */
7793
- uploadId: string | undefined;
7794
- /**
7795
- * <p>The source file for an upload part.</p>
7796
- * @public
7797
- */
7798
- partSource: ReadSetPartSource | undefined;
7799
- /**
7800
- * <p>The number of the part being uploaded.</p>
7801
- * @public
7802
- */
7803
- partNumber: number | undefined;
7804
- /**
7805
- * <p>The read set data to upload for a part.</p>
7806
- * @public
7807
- */
7808
- payload: StreamingBlobTypes | undefined;
7809
- }
7810
- /**
7811
- * @public
7812
- */
7813
- export interface UploadReadSetPartResponse {
7814
- /**
7815
- * <p>An identifier used to confirm that parts are being added to the intended upload.</p>
7816
- * @public
7817
- */
7818
- checksum: string | undefined;
7819
- }
7820
- /**
7821
- * @public
7822
- */
7823
- export interface TagResourceRequest {
7824
- /**
7825
- * <p>The resource's ARN.</p>
7826
- * @public
7827
- */
7828
- resourceArn: string | undefined;
7829
- /**
7830
- * <p>Tags for the resource.</p>
7831
- * @public
7832
- */
7833
- tags: Record<string, string> | undefined;
7834
- }
7835
- /**
7836
- * @public
7837
- */
7838
- export interface TagResourceResponse {
7839
- }
7840
7952
  /**
7841
7953
  * @internal
7842
7954
  */
@@ -7845,7 +7957,3 @@ export declare const GetReadSetResponseFilterSensitiveLog: (obj: GetReadSetRespo
7845
7957
  * @internal
7846
7958
  */
7847
7959
  export declare const GetReferenceResponseFilterSensitiveLog: (obj: GetReferenceResponse) => any;
7848
- /**
7849
- * @internal
7850
- */
7851
- export declare const UploadReadSetPartRequestFilterSensitiveLog: (obj: UploadReadSetPartRequest) => any;