Skip to content

Commit b752120

Browse files
author
awstools
committed
feat(client-omics): Adds data provenance to import jobs from read sets and references
1 parent ea83621 commit b752120

File tree

9 files changed

+122
-17
lines changed

9 files changed

+122
-17
lines changed

clients/client-omics/src/commands/CreateRunGroupCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateRunGroupCommandInput extends CreateRunGroupRequest {}
2828
export interface CreateRunGroupCommandOutput extends CreateRunGroupResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a run group.</p>
31+
* <p>You can optionally create a run group to limit the compute resources for the runs that you add to the group.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

clients/client-omics/src/commands/CreateShareCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ export interface CreateShareCommandOutput extends CreateShareResponse, __Metadat
3333
* <p>The following resources support cross-account sharing:</p>
3434
* <ul>
3535
* <li>
36-
* <p>Healthomics variant stores</p>
36+
* <p>HealthOmics variant stores</p>
3737
* </li>
3838
* <li>
39-
* <p>Healthomics annotation stores</p>
39+
* <p>HealthOmics annotation stores</p>
4040
* </li>
4141
* <li>
4242
* <p>Private workflows</p>

clients/client-omics/src/commands/GetReadSetImportJobCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ export interface GetReadSetImportJobCommandOutput extends GetReadSetImportJobRes
6767
* // tags: { // TagMap
6868
* // "<keys>": "STRING_VALUE",
6969
* // },
70+
* // readSetId: "STRING_VALUE",
7071
* // },
7172
* // ],
7273
* // };

clients/client-omics/src/commands/GetReadSetMetadataCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ export interface GetReadSetMetadataCommandOutput extends GetReadSetMetadataRespo
9292
* // source1: "STRING_VALUE",
9393
* // source2: "STRING_VALUE",
9494
* // },
95+
* // creationJobId: "STRING_VALUE",
9596
* // };
9697
*
9798
* ```

clients/client-omics/src/commands/GetReferenceImportJobCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export interface GetReferenceImportJobCommandOutput extends GetReferenceImportJo
5959
* // tags: { // TagMap
6060
* // "<keys>": "STRING_VALUE",
6161
* // },
62+
* // referenceId: "STRING_VALUE",
6263
* // },
6364
* // ],
6465
* // };

clients/client-omics/src/commands/GetReferenceMetadataCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ export interface GetReferenceMetadataCommandOutput extends GetReferenceMetadataR
6969
* // },
7070
* // },
7171
* // },
72+
* // creationType: "STRING_VALUE",
73+
* // creationJobId: "STRING_VALUE",
7274
* // };
7375
*
7476
* ```

clients/client-omics/src/models/models_0.ts

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2733,19 +2733,21 @@ export interface CreateRunGroupRequest {
27332733
name?: string;
27342734

27352735
/**
2736-
* <p>The maximum number of CPUs to use in the group.</p>
2736+
* <p>The maximum number of CPUs that can run
2737+
* concurrently across all active runs in the run group.</p>
27372738
* @public
27382739
*/
27392740
maxCpus?: number;
27402741

27412742
/**
2742-
* <p>The maximum number of concurrent runs for the group.</p>
2743+
* <p>The maximum number of runs that can be running at the same time.</p>
27432744
* @public
27442745
*/
27452746
maxRuns?: number;
27462747

27472748
/**
2748-
* <p>A maximum run time for the group in minutes.</p>
2749+
* <p>The maximum time for each run (in minutes). If a run exceeds
2750+
* the maximum run time, the run fails automatically.</p>
27492751
* @public
27502752
*/
27512753
maxDuration?: number;
@@ -2763,7 +2765,8 @@ export interface CreateRunGroupRequest {
27632765
requestId?: string;
27642766

27652767
/**
2766-
* <p>The maximum GPUs that can be used by a run group.</p>
2768+
* <p>The maximum number of GPUs that can run concurrently across all active
2769+
* runs in the run group.</p>
27672770
* @public
27682771
*/
27692772
maxGpus?: number;
@@ -3103,7 +3106,7 @@ export interface CreateWorkflowRequest {
31033106
parameterTemplate?: Record<string, WorkflowParameter>;
31043107

31053108
/**
3106-
* <p>The storage capacity for the workflow in gibibytes.</p>
3109+
* <p>The default storage capacity for the workflow runs, in gibibytes.</p>
31073110
* @public
31083111
*/
31093112
storageCapacity?: number;
@@ -3929,6 +3932,12 @@ export interface ImportReadSetSourceItem {
39293932
* @public
39303933
*/
39313934
tags?: Record<string, string>;
3935+
3936+
/**
3937+
* <p>The source's read set ID.</p>
3938+
* @public
3939+
*/
3940+
readSetId?: string;
39323941
}
39333942

39343943
/**
@@ -4194,6 +4203,12 @@ export interface GetReadSetMetadataResponse {
41944203
* @public
41954204
*/
41964205
etag?: ETag;
4206+
4207+
/**
4208+
* <p>The read set's creation job ID.</p>
4209+
* @public
4210+
*/
4211+
creationJobId?: string;
41974212
}
41984213

41994214
/**
@@ -4330,6 +4345,12 @@ export interface ImportReferenceSourceItem {
43304345
* @public
43314346
*/
43324347
tags?: Record<string, string>;
4348+
4349+
/**
4350+
* <p>The source's reference ID.</p>
4351+
* @public
4352+
*/
4353+
referenceId?: string;
43334354
}
43344355

43354356
/**
@@ -4421,6 +4442,19 @@ export interface GetReferenceMetadataRequest {
44214442
referenceStoreId: string | undefined;
44224443
}
44234444

4445+
/**
4446+
* @public
4447+
* @enum
4448+
*/
4449+
export const ReferenceCreationType = {
4450+
IMPORT: "IMPORT",
4451+
} as const;
4452+
4453+
/**
4454+
* @public
4455+
*/
4456+
export type ReferenceCreationType = (typeof ReferenceCreationType)[keyof typeof ReferenceCreationType];
4457+
44244458
/**
44254459
* <p>A set of genome reference files.</p>
44264460
* @public
@@ -4517,6 +4551,18 @@ export interface GetReferenceMetadataResponse {
45174551
* @public
45184552
*/
45194553
files?: ReferenceFiles;
4554+
4555+
/**
4556+
* <p>The reference's creation type.</p>
4557+
* @public
4558+
*/
4559+
creationType?: ReferenceCreationType;
4560+
4561+
/**
4562+
* <p>The reference's creation job ID.</p>
4563+
* @public
4564+
*/
4565+
creationJobId?: string;
45204566
}
45214567

45224568
/**
@@ -5562,7 +5608,7 @@ export interface GetWorkflowResponse {
55625608
parameterTemplate?: Record<string, WorkflowParameter>;
55635609

55645610
/**
5565-
* <p>The workflow's storage capacity in gibibytes.</p>
5611+
* <p>The workflow's default run storage capacity in gibibytes.</p>
55665612
* @public
55675613
*/
55685614
storageCapacity?: number;

clients/client-omics/src/protocols/Aws_restJson1.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3551,6 +3551,7 @@ export const de_GetReadSetMetadataCommand = async (
35513551
const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
35523552
const doc = take(data, {
35533553
arn: __expectString,
3554+
creationJobId: __expectString,
35543555
creationTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
35553556
creationType: __expectString,
35563557
description: __expectString,
@@ -3634,7 +3635,9 @@ export const de_GetReferenceMetadataCommand = async (
36343635
const data: Record<string, any> = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
36353636
const doc = take(data, {
36363637
arn: __expectString,
3638+
creationJobId: __expectString,
36373639
creationTime: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
3640+
creationType: __expectString,
36383641
description: __expectString,
36393642
files: _json,
36403643
id: __expectString,

codegen/sdk-codegen/aws-models/omics.json

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1903,7 +1903,7 @@
19031903
}
19041904
],
19051905
"traits": {
1906-
"smithy.api#documentation": "<p>Creates a run group.</p>",
1906+
"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>",
19071907
"smithy.api#endpoint": {
19081908
"hostPrefix": "workflows-"
19091909
},
@@ -1926,7 +1926,7 @@
19261926
"maxCpus": {
19271927
"target": "smithy.api#Integer",
19281928
"traits": {
1929-
"smithy.api#documentation": "<p>The maximum number of CPUs to use in the group.</p>",
1929+
"smithy.api#documentation": "<p>The maximum number of CPUs that can run\n concurrently across all active runs in the run group.</p>",
19301930
"smithy.api#range": {
19311931
"min": 1,
19321932
"max": 100000
@@ -1936,7 +1936,7 @@
19361936
"maxRuns": {
19371937
"target": "smithy.api#Integer",
19381938
"traits": {
1939-
"smithy.api#documentation": "<p>The maximum number of concurrent runs for the group.</p>",
1939+
"smithy.api#documentation": "<p>The maximum number of runs that can be running at the same time.</p>",
19401940
"smithy.api#range": {
19411941
"min": 1,
19421942
"max": 100000
@@ -1946,7 +1946,7 @@
19461946
"maxDuration": {
19471947
"target": "smithy.api#Integer",
19481948
"traits": {
1949-
"smithy.api#documentation": "<p>A maximum run time for the group in minutes.</p>",
1949+
"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>",
19501950
"smithy.api#range": {
19511951
"min": 1,
19521952
"max": 100000
@@ -1970,7 +1970,7 @@
19701970
"maxGpus": {
19711971
"target": "smithy.api#Integer",
19721972
"traits": {
1973-
"smithy.api#documentation": "<p>The maximum GPUs that can be used by a run group.</p>",
1973+
"smithy.api#documentation": "<p>The maximum number of GPUs that can run concurrently across all active\n runs in the run group.</p>",
19741974
"smithy.api#range": {
19751975
"min": 1,
19761976
"max": 100000
@@ -2192,7 +2192,7 @@
21922192
}
21932193
],
21942194
"traits": {
2195-
"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>",
2195+
"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>",
21962196
"smithy.api#endpoint": {
21972197
"hostPrefix": "analytics-"
21982198
},
@@ -2479,7 +2479,7 @@
24792479
"storageCapacity": {
24802480
"target": "smithy.api#Integer",
24812481
"traits": {
2482-
"smithy.api#documentation": "<p>The storage capacity for the workflow in gibibytes.</p>",
2482+
"smithy.api#documentation": "<p>The default storage capacity for the workflow runs, in gibibytes.</p>",
24832483
"smithy.api#range": {
24842484
"min": 0,
24852485
"max": 100000
@@ -2543,6 +2543,16 @@
25432543
"smithy.api#output": {}
25442544
}
25452545
},
2546+
"com.amazonaws.omics#CreationJobId": {
2547+
"type": "string",
2548+
"traits": {
2549+
"smithy.api#length": {
2550+
"min": 1,
2551+
"max": 127
2552+
},
2553+
"smithy.api#pattern": "^[a-zA-Z0-9]+$"
2554+
}
2555+
},
25462556
"com.amazonaws.omics#CreationTime": {
25472557
"type": "timestamp",
25482558
"traits": {
@@ -5285,6 +5295,12 @@
52855295
"traits": {
52865296
"smithy.api#documentation": "<p>The entity tag (ETag) is a hash of the object meant to represent its semantic content.</p>"
52875297
}
5298+
},
5299+
"creationJobId": {
5300+
"target": "com.amazonaws.omics#CreationJobId",
5301+
"traits": {
5302+
"smithy.api#documentation": "<p>The read set's creation job ID.</p>"
5303+
}
52885304
}
52895305
},
52905306
"traits": {
@@ -5739,6 +5755,18 @@
57395755
"traits": {
57405756
"smithy.api#documentation": "<p>The reference's files.</p>"
57415757
}
5758+
},
5759+
"creationType": {
5760+
"target": "com.amazonaws.omics#ReferenceCreationType",
5761+
"traits": {
5762+
"smithy.api#documentation": "<p>The reference's creation type.</p>"
5763+
}
5764+
},
5765+
"creationJobId": {
5766+
"target": "com.amazonaws.omics#CreationJobId",
5767+
"traits": {
5768+
"smithy.api#documentation": "<p>The reference's creation job ID.</p>"
5769+
}
57425770
}
57435771
},
57445772
"traits": {
@@ -7582,7 +7610,7 @@
75827610
"storageCapacity": {
75837611
"target": "smithy.api#Integer",
75847612
"traits": {
7585-
"smithy.api#documentation": "<p>The workflow's storage capacity in gibibytes.</p>",
7613+
"smithy.api#documentation": "<p>The workflow's default run storage capacity in gibibytes.</p>",
75867614
"smithy.api#range": {
75877615
"min": 0,
75887616
"max": 100000
@@ -7805,6 +7833,12 @@
78057833
"traits": {
78067834
"smithy.api#documentation": "<p>The source's tags.</p>"
78077835
}
7836+
},
7837+
"readSetId": {
7838+
"target": "com.amazonaws.omics#ReadSetId",
7839+
"traits": {
7840+
"smithy.api#documentation": "<p>The source's read set ID.</p>"
7841+
}
78087842
}
78097843
},
78107844
"traits": {
@@ -7941,6 +7975,12 @@
79417975
"traits": {
79427976
"smithy.api#documentation": "<p>The source's tags.</p>"
79437977
}
7978+
},
7979+
"referenceId": {
7980+
"target": "com.amazonaws.omics#ReferenceId",
7981+
"traits": {
7982+
"smithy.api#documentation": "<p>The source's reference ID.</p>"
7983+
}
79447984
}
79457985
},
79467986
"traits": {
@@ -12056,6 +12096,17 @@
1205612096
"smithy.api#pattern": "^$|^arn:.+$"
1205712097
}
1205812098
},
12099+
"com.amazonaws.omics#ReferenceCreationType": {
12100+
"type": "string",
12101+
"traits": {
12102+
"smithy.api#enum": [
12103+
{
12104+
"value": "IMPORT",
12105+
"name": "IMPORT"
12106+
}
12107+
]
12108+
}
12109+
},
1205912110
"com.amazonaws.omics#ReferenceDescription": {
1206012111
"type": "string",
1206112112
"traits": {

0 commit comments

Comments
 (0)