Skip to content

Commit f47a1b2

Browse files
author
awstools
committed
feat(client-omics): Add support for workflow sharing and dynamic run storage
1 parent c709983 commit f47a1b2

12 files changed

+383
-167
lines changed

Diff for: clients/client-omics/src/commands/AcceptShareCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ export interface AcceptShareCommandInput extends AcceptShareRequest {}
2727
export interface AcceptShareCommandOutput extends AcceptShareResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Accepts a share for an analytics store.
32-
* </p>
30+
* <p>Accept a resource share request.</p>
3331
* @example
3432
* Use a bare-bones client and the command you need to make an API call.
3533
* ```javascript

Diff for: clients/client-omics/src/commands/CreateShareCommand.ts

+14-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,20 @@ export interface CreateShareCommandInput extends CreateShareRequest {}
2727
export interface CreateShareCommandOutput extends CreateShareResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.
32-
* </p>
30+
* <p>Creates a cross-account shared resource. The resource owner makes an offer to share the resource
31+
* with the principal subscriber (an AWS user with a different account than the resource owner).</p>
32+
* <p>The following resources support cross-account sharing:</p>
33+
* <ul>
34+
* <li>
35+
* <p>Healthomics variant stores</p>
36+
* </li>
37+
* <li>
38+
* <p>Healthomics annotation stores</p>
39+
* </li>
40+
* <li>
41+
* <p>Private workflows</p>
42+
* </li>
43+
* </ul>
3344
* @example
3445
* Use a bare-bones client and the command you need to make an API call.
3546
* ```javascript

Diff for: clients/client-omics/src/commands/DeleteShareCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@ export interface DeleteShareCommandInput extends DeleteShareRequest {}
2727
export interface DeleteShareCommandOutput extends DeleteShareResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Deletes a share of an analytics store.
32-
* </p>
30+
* <p>Deletes a resource share. If you are the resource owner, the subscriber will no longer have
31+
* access to the shared resource. If you are the subscriber, this operation deletes your access to the share.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

Diff for: clients/client-omics/src/commands/GetRunCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {}
2828

2929
/**
3030
* <p>Gets information about a workflow run.</p>
31+
* <p>If a workflow is shared with you, you cannot export information about the run.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript
@@ -79,6 +80,8 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {}
7980
* // },
8081
* // uuid: "STRING_VALUE",
8182
* // runOutputUri: "STRING_VALUE",
83+
* // storageType: "STRING_VALUE",
84+
* // workflowOwnerId: "STRING_VALUE",
8285
* // };
8386
*
8487
* ```

Diff for: clients/client-omics/src/commands/GetShareCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ export interface GetShareCommandInput extends GetShareRequest {}
2727
export interface GetShareCommandOutput extends GetShareResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Retrieves the metadata for a share.
32-
* </p>
30+
* <p>Retrieves the metadata for the specified resource share.</p>
3331
* @example
3432
* Use a bare-bones client and the command you need to make an API call.
3533
* ```javascript
@@ -45,6 +43,7 @@ export interface GetShareCommandOutput extends GetShareResponse, __MetadataBeare
4543
* // share: { // ShareDetails
4644
* // shareId: "STRING_VALUE",
4745
* // resourceArn: "STRING_VALUE",
46+
* // resourceId: "STRING_VALUE",
4847
* // principalSubscriber: "STRING_VALUE",
4948
* // ownerId: "STRING_VALUE",
5049
* // status: "STRING_VALUE",

Diff for: clients/client-omics/src/commands/GetWorkflowCommand.ts

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat
2828

2929
/**
3030
* <p>Gets information about a workflow.</p>
31+
* <p>If a workflow is shared with you, you cannot export the workflow.</p>
3132
* @example
3233
* Use a bare-bones client and the command you need to make an API call.
3334
* ```javascript
@@ -40,6 +41,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat
4041
* export: [ // WorkflowExportList
4142
* "STRING_VALUE",
4243
* ],
44+
* workflowOwnerId: "STRING_VALUE",
4345
* };
4446
* const command = new GetWorkflowCommand(input);
4547
* const response = await client.send(command);

Diff for: clients/client-omics/src/commands/ListRunsCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ export interface ListRunsCommandOutput extends ListRunsResponse, __MetadataBeare
5656
* // creationTime: new Date("TIMESTAMP"),
5757
* // startTime: new Date("TIMESTAMP"),
5858
* // stopTime: new Date("TIMESTAMP"),
59+
* // storageType: "STRING_VALUE",
5960
* // },
6061
* // ],
6162
* // nextToken: "STRING_VALUE",

Diff for: clients/client-omics/src/commands/ListSharesCommand.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@ export interface ListSharesCommandInput extends ListSharesRequest {}
2727
export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>
31-
* Lists all shares associated with an account.
32-
* </p>
30+
* <p>Retrieves the resource shares associated with an account. Use the filter parameter to
31+
* retrieve a specific subset of the shares.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -45,6 +44,9 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB
4544
* status: [ // StatusList
4645
* "STRING_VALUE",
4746
* ],
47+
* type: [ // TypeList
48+
* "STRING_VALUE",
49+
* ],
4850
* },
4951
* nextToken: "STRING_VALUE",
5052
* maxResults: Number("int"),
@@ -56,6 +58,7 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB
5658
* // { // ShareDetails
5759
* // shareId: "STRING_VALUE",
5860
* // resourceArn: "STRING_VALUE",
61+
* // resourceId: "STRING_VALUE",
5962
* // principalSubscriber: "STRING_VALUE",
6063
* // ownerId: "STRING_VALUE",
6164
* // status: "STRING_VALUE",

Diff for: clients/client-omics/src/commands/StartRunCommand.ts

+8
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,15 @@ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBeare
2929
/**
3030
* <p>Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The
3131
* remaining parameters are copied from the previous run.</p>
32+
* <p>StartRun will not support re-run for a workflow that is shared with you.</p>
3233
* <p>The total number of runs in your account is subject to a quota per Region. To avoid
3334
* needing to delete runs manually, you can set the retention mode to <code>REMOVE</code>.
3435
* Runs with this setting are deleted automatically when the run quoata is exceeded.</p>
36+
* <p>By default, the run uses STATIC storage. For STATIC storage, set the <code>storageCapacity</code> field.
37+
* You can set the storage type to DYNAMIC. You do not set <code>storageCapacity</code>,
38+
* because HealthOmics dynamically scales the storage up or down as required.
39+
* 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>
40+
* in the <i>AWS HealthOmics User Guide</i>.</p>
3541
* @example
3642
* Use a bare-bones client and the command you need to make an API call.
3743
* ```javascript
@@ -55,6 +61,8 @@ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBeare
5561
* },
5662
* requestId: "STRING_VALUE", // required
5763
* retentionMode: "STRING_VALUE",
64+
* storageType: "STRING_VALUE",
65+
* workflowOwnerId: "STRING_VALUE",
5866
* };
5967
* const command = new StartRunCommand(input);
6068
* const response = await client.send(command);

0 commit comments

Comments
 (0)