feat(client-omics): Adds data provenance to import jobs from read set…

…s and references
aws · Aug 27, 2024 · b752120 · b752120
1 parent ea83621
commit b752120
Show file tree

Hide file tree

Showing 9 changed files with 122 additions and 17 deletions.
diff --git a/clients/client-omics/src/commands/CreateRunGroupCommand.ts b/clients/client-omics/src/commands/CreateRunGroupCommand.ts
@@ -28,7 +28,7 @@ export interface CreateRunGroupCommandInput extends CreateRunGroupRequest {}
 export interface CreateRunGroupCommandOutput extends CreateRunGroupResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a run group.</p>
+ * <p>You can optionally create a run group to limit the compute resources for the runs that you add to the group.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-omics/src/commands/CreateShareCommand.ts b/clients/client-omics/src/commands/CreateShareCommand.ts
@@ -33,10 +33,10 @@ export interface CreateShareCommandOutput extends CreateShareResponse, __Metadat
  *          <p>The following resources support cross-account sharing:</p>
  *          <ul>
  *             <li>
- *                <p>Healthomics variant stores</p>
+ *                <p>HealthOmics variant stores</p>
  *             </li>
  *             <li>
- *                <p>Healthomics annotation stores</p>
+ *                <p>HealthOmics annotation stores</p>
  *             </li>
  *             <li>
  *                <p>Private workflows</p>

diff --git a/clients/client-omics/src/commands/GetReadSetImportJobCommand.ts b/clients/client-omics/src/commands/GetReadSetImportJobCommand.ts
@@ -67,6 +67,7 @@ export interface GetReadSetImportJobCommandOutput extends GetReadSetImportJobRes
  * //       tags: { // TagMap
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       readSetId: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

diff --git a/clients/client-omics/src/commands/GetReadSetMetadataCommand.ts b/clients/client-omics/src/commands/GetReadSetMetadataCommand.ts
@@ -92,6 +92,7 @@ export interface GetReadSetMetadataCommandOutput extends GetReadSetMetadataRespo
  * //     source1: "STRING_VALUE",
  * //     source2: "STRING_VALUE",
  * //   },
+ * //   creationJobId: "STRING_VALUE",
  * // };
  *
  * ```

diff --git a/clients/client-omics/src/commands/GetReferenceImportJobCommand.ts b/clients/client-omics/src/commands/GetReferenceImportJobCommand.ts
@@ -59,6 +59,7 @@ export interface GetReferenceImportJobCommandOutput extends GetReferenceImportJo
  * //       tags: { // TagMap
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       referenceId: "STRING_VALUE",
  * //     },
  * //   ],
  * // };

diff --git a/clients/client-omics/src/commands/GetReferenceMetadataCommand.ts b/clients/client-omics/src/commands/GetReferenceMetadataCommand.ts
@@ -69,6 +69,8 @@ export interface GetReferenceMetadataCommandOutput extends GetReferenceMetadataR
  * //       },
  * //     },
  * //   },
+ * //   creationType: "STRING_VALUE",
+ * //   creationJobId: "STRING_VALUE",
  * // };
  *
  * ```

diff --git a/clients/client-omics/src/models/models_0.ts b/clients/client-omics/src/models/models_0.ts
@@ -2733,19 +2733,21 @@ export interface CreateRunGroupRequest {
   name?: string;
 
   /**
-   * <p>The maximum number of CPUs to use in the group.</p>
+   * <p>The maximum number of CPUs that can run
+   *       concurrently across all active runs in the run group.</p>
    * @public
    */
   maxCpus?: number;
 
   /**
-   * <p>The maximum number of concurrent runs for the group.</p>
+   * <p>The maximum number of runs that can be running at the same time.</p>
    * @public
    */
   maxRuns?: number;
 
   /**
-   * <p>A maximum run time for the group in minutes.</p>
+   * <p>The maximum time for each run (in minutes). If a run exceeds
+   *       the maximum run time, the run fails automatically.</p>
    * @public
    */
   maxDuration?: number;
@@ -2763,7 +2765,8 @@ export interface CreateRunGroupRequest {
   requestId?: string;
 
   /**
-   * <p>The maximum GPUs that can be used by a run group.</p>
+   * <p>The maximum number of GPUs that can run concurrently across all active
+   *       runs in the run group.</p>
    * @public
    */
   maxGpus?: number;
@@ -3103,7 +3106,7 @@ export interface CreateWorkflowRequest {
   parameterTemplate?: Record<string, WorkflowParameter>;
 
   /**
-   * <p>The storage capacity for the workflow in gibibytes.</p>
+   * <p>The default storage capacity for the workflow runs, in gibibytes.</p>
    * @public
    */
   storageCapacity?: number;
@@ -3929,6 +3932,12 @@ export interface ImportReadSetSourceItem {
    * @public
    */
   tags?: Record<string, string>;
+
+  /**
+   * <p>The source's read set ID.</p>
+   * @public
+   */
+  readSetId?: string;
 }
 
 /**
@@ -4194,6 +4203,12 @@ export interface GetReadSetMetadataResponse {
    * @public
    */
   etag?: ETag;
+
+  /**
+   * <p>The read set's creation job ID.</p>
+   * @public
+   */
+  creationJobId?: string;
 }
 
 /**
@@ -4330,6 +4345,12 @@ export interface ImportReferenceSourceItem {
    * @public
    */
   tags?: Record<string, string>;
+
+  /**
+   * <p>The source's reference ID.</p>
+   * @public
+   */
+  referenceId?: string;
 }
 
 /**
@@ -4421,6 +4442,19 @@ export interface GetReferenceMetadataRequest {
   referenceStoreId: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const ReferenceCreationType = {
+  IMPORT: "IMPORT",
+} as const;
+
+/**
+ * @public
+ */
+export type ReferenceCreationType = (typeof ReferenceCreationType)[keyof typeof ReferenceCreationType];
+
 /**
  * <p>A set of genome reference files.</p>
  * @public
@@ -4517,6 +4551,18 @@ export interface GetReferenceMetadataResponse {
    * @public
    */
   files?: ReferenceFiles;
+
+  /**
+   * <p>The reference's creation type.</p>
+   * @public
+   */
+  creationType?: ReferenceCreationType;
+
+  /**
+   * <p>The reference's creation job ID.</p>
+   * @public
+   */
+  creationJobId?: string;
 }
 
 /**
@@ -5562,7 +5608,7 @@ export interface GetWorkflowResponse {
   parameterTemplate?: Record<string, WorkflowParameter>;
 
   /**
-   * <p>The workflow's storage capacity in gibibytes.</p>
+   * <p>The workflow's default run storage capacity in gibibytes.</p>
    * @public
    */
   storageCapacity?: number;

diff --git a/clients/client-omics/src/protocols/Aws_restJson1.ts b/clients/client-omics/src/protocols/Aws_restJson1.ts
@@ -3551,6 +3551,7 @@ export const de_GetReadSetMetadataCommand = async (
   const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
   const doc = take(data, {
     arn: __expectString,
+    creationJobId: __expectString,
     creationTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
     creationType: __expectString,
     description: __expectString,
@@ -3634,7 +3635,9 @@ export const de_GetReferenceMetadataCommand = async (
   const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
   const doc = take(data, {
     arn: __expectString,
+    creationJobId: __expectString,
     creationTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
+    creationType: __expectString,
     description: __expectString,
     files: _json,
     id: __expectString,

diff --git a/codegen/sdk-codegen/aws-models/omics.json b/codegen/sdk-codegen/aws-models/omics.json
@@ -1903,7 +1903,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Creates a run group.</p>",
+        "smithy.api#documentation": "<p>You can optionally create a run group to limit the compute resources for the runs that you add to the group.</p>",
         "smithy.api#endpoint": {
           "hostPrefix": "workflows-"
         },
@@ -1926,7 +1926,7 @@
         "maxCpus": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>The maximum number of CPUs to use in the group.</p>",
+            "smithy.api#documentation": "<p>The maximum number of CPUs that can run\n      concurrently across all active runs in the run group.</p>",
             "smithy.api#range": {
               "min": 1,
               "max": 100000
@@ -1936,7 +1936,7 @@
         "maxRuns": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>The maximum number of concurrent runs for the group.</p>",
+            "smithy.api#documentation": "<p>The maximum number of runs that can be running at the same time.</p>",
             "smithy.api#range": {
               "min": 1,
               "max": 100000
@@ -1946,7 +1946,7 @@
         "maxDuration": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>A maximum run time for the group in minutes.</p>",
+            "smithy.api#documentation": "<p>The maximum time for each run (in minutes). If a run exceeds\n      the maximum run time, the run fails automatically.</p>",
             "smithy.api#range": {
               "min": 1,
               "max": 100000
@@ -1970,7 +1970,7 @@
         "maxGpus": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>The maximum GPUs that can be used by a run group.</p>",
+            "smithy.api#documentation": "<p>The maximum number of GPUs that can run concurrently across all active\n      runs in the run group.</p>",
             "smithy.api#range": {
               "min": 1,
               "max": 100000
@@ -2192,7 +2192,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n      with the principal subscriber (an AWS user with a different account than the resource owner).</p>\n         <p>The following resources support cross-account sharing:</p>\n         <ul>\n            <li>\n               <p>Healthomics variant stores</p>\n            </li>\n            <li>\n               <p>Healthomics annotation stores</p>\n            </li>\n            <li>\n               <p>Private workflows</p>\n            </li>\n         </ul>",
+        "smithy.api#documentation": "<p>Creates a cross-account shared resource. The resource owner makes an offer to share the resource \n      with the principal subscriber (an AWS user with a different account than the resource owner).</p>\n         <p>The following resources support cross-account sharing:</p>\n         <ul>\n            <li>\n               <p>HealthOmics variant stores</p>\n            </li>\n            <li>\n               <p>HealthOmics annotation stores</p>\n            </li>\n            <li>\n               <p>Private workflows</p>\n            </li>\n         </ul>",
         "smithy.api#endpoint": {
           "hostPrefix": "analytics-"
         },
@@ -2479,7 +2479,7 @@
         "storageCapacity": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>The storage capacity for the workflow in gibibytes.</p>",
+            "smithy.api#documentation": "<p>The default storage capacity for the workflow runs, in gibibytes.</p>",
             "smithy.api#range": {
               "min": 0,
               "max": 100000
@@ -2543,6 +2543,16 @@
         "smithy.api#output": {}
       }
     },
+    "com.amazonaws.omics#CreationJobId": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 1,
+          "max": 127
+        },
+        "smithy.api#pattern": "^[a-zA-Z0-9]+$"
+      }
+    },
     "com.amazonaws.omics#CreationTime": {
       "type": "timestamp",
       "traits": {
@@ -5285,6 +5295,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The entity tag (ETag) is a hash of the object meant to represent its semantic content.</p>"
           }
+        },
+        "creationJobId": {
+          "target": "com.amazonaws.omics#CreationJobId",
+          "traits": {
+            "smithy.api#documentation": "<p>The read set's creation job ID.</p>"
+          }
         }
       },
       "traits": {
@@ -5739,6 +5755,18 @@
           "traits": {
             "smithy.api#documentation": "<p>The reference's files.</p>"
           }
+        },
+        "creationType": {
+          "target": "com.amazonaws.omics#ReferenceCreationType",
+          "traits": {
+            "smithy.api#documentation": "<p>The reference's creation type.</p>"
+          }
+        },
+        "creationJobId": {
+          "target": "com.amazonaws.omics#CreationJobId",
+          "traits": {
+            "smithy.api#documentation": "<p>The reference's creation job ID.</p>"
+          }
         }
       },
       "traits": {
@@ -7582,7 +7610,7 @@
         "storageCapacity": {
           "target": "smithy.api#Integer",
           "traits": {
-            "smithy.api#documentation": "<p>The workflow's storage capacity in gibibytes.</p>",
+            "smithy.api#documentation": "<p>The workflow's default run storage capacity in gibibytes.</p>",
             "smithy.api#range": {
               "min": 0,
               "max": 100000
@@ -7805,6 +7833,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The source's tags.</p>"
           }
+        },
+        "readSetId": {
+          "target": "com.amazonaws.omics#ReadSetId",
+          "traits": {
+            "smithy.api#documentation": "<p>The source's read set ID.</p>"
+          }
         }
       },
       "traits": {
@@ -7941,6 +7975,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The source's tags.</p>"
           }
+        },
+        "referenceId": {
+          "target": "com.amazonaws.omics#ReferenceId",
+          "traits": {
+            "smithy.api#documentation": "<p>The source's reference ID.</p>"
+          }
         }
       },
       "traits": {
@@ -12056,6 +12096,17 @@
         "smithy.api#pattern": "^$|^arn:.+$"
       }
     },
+    "com.amazonaws.omics#ReferenceCreationType": {
+      "type": "string",
+      "traits": {
+        "smithy.api#enum": [
+          {
+            "value": "IMPORT",
+            "name": "IMPORT"
+          }
+        ]
+      }
+    },
     "com.amazonaws.omics#ReferenceDescription": {
       "type": "string",
       "traits": {
-Original file line number
+Diff line change
@@ Expand Up @@
      * //       tags: { // TagMap
      * //         "<keys>": "STRING_VALUE",
      * //       },
+     * //       readSetId: "STRING_VALUE",
      * //     },
      * //   ],
      * // };
@@ Expand Down @@