Skip to content

Commit

Permalink
feat(client-omics): Add support for workflow sharing and dynamic run …
Browse files Browse the repository at this point in the history
…storage
  • Loading branch information
awstools committed Apr 30, 2024
1 parent c709983 commit f47a1b2
Show file tree
Hide file tree
Showing 12 changed files with 383 additions and 167 deletions.
4 changes: 1 addition & 3 deletions clients/client-omics/src/commands/AcceptShareCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ export interface AcceptShareCommandInput extends AcceptShareRequest {}
export interface AcceptShareCommandOutput extends AcceptShareResponse, __MetadataBearer {}

/**
* <p>
* Accepts a share for an analytics store.
* </p>
* <p>Accept a resource share request.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
17 changes: 14 additions & 3 deletions clients/client-omics/src/commands/CreateShareCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,20 @@ export interface CreateShareCommandInput extends CreateShareRequest {}
export interface CreateShareCommandOutput extends CreateShareResponse, __MetadataBearer {}

/**
* <p>
* 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.
* </p>
* <p>Creates a cross-account shared resource. The resource owner makes an offer to share the resource
* with the principal subscriber (an AWS user with a different account than the resource owner).</p>
* <p>The following resources support cross-account sharing:</p>
* <ul>
* <li>
* <p>Healthomics variant stores</p>
* </li>
* <li>
* <p>Healthomics annotation stores</p>
* </li>
* <li>
* <p>Private workflows</p>
* </li>
* </ul>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
5 changes: 2 additions & 3 deletions clients/client-omics/src/commands/DeleteShareCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ export interface DeleteShareCommandInput extends DeleteShareRequest {}
export interface DeleteShareCommandOutput extends DeleteShareResponse, __MetadataBearer {}

/**
* <p>
* Deletes a share of an analytics store.
* </p>
* <p>Deletes a resource share. If you are the resource owner, the subscriber will no longer have
* access to the shared resource. If you are the subscriber, this operation deletes your access to the share.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-omics/src/commands/GetRunCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {}

/**
* <p>Gets information about a workflow run.</p>
* <p>If a workflow is shared with you, you cannot export information about the run.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -79,6 +80,8 @@ export interface GetRunCommandOutput extends GetRunResponse, __MetadataBearer {}
* // },
* // uuid: "STRING_VALUE",
* // runOutputUri: "STRING_VALUE",
* // storageType: "STRING_VALUE",
* // workflowOwnerId: "STRING_VALUE",
* // };
*
* ```
Expand Down
5 changes: 2 additions & 3 deletions clients/client-omics/src/commands/GetShareCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ export interface GetShareCommandInput extends GetShareRequest {}
export interface GetShareCommandOutput extends GetShareResponse, __MetadataBearer {}

/**
* <p>
* Retrieves the metadata for a share.
* </p>
* <p>Retrieves the metadata for the specified resource share.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -45,6 +43,7 @@ export interface GetShareCommandOutput extends GetShareResponse, __MetadataBeare
* // share: { // ShareDetails
* // shareId: "STRING_VALUE",
* // resourceArn: "STRING_VALUE",
* // resourceId: "STRING_VALUE",
* // principalSubscriber: "STRING_VALUE",
* // ownerId: "STRING_VALUE",
* // status: "STRING_VALUE",
Expand Down
2 changes: 2 additions & 0 deletions clients/client-omics/src/commands/GetWorkflowCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat

/**
* <p>Gets information about a workflow.</p>
* <p>If a workflow is shared with you, you cannot export the workflow.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -40,6 +41,7 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat
* export: [ // WorkflowExportList
* "STRING_VALUE",
* ],
* workflowOwnerId: "STRING_VALUE",
* };
* const command = new GetWorkflowCommand(input);
* const response = await client.send(command);
Expand Down
1 change: 1 addition & 0 deletions clients/client-omics/src/commands/ListRunsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ export interface ListRunsCommandOutput extends ListRunsResponse, __MetadataBeare
* // creationTime: new Date("TIMESTAMP"),
* // startTime: new Date("TIMESTAMP"),
* // stopTime: new Date("TIMESTAMP"),
* // storageType: "STRING_VALUE",
* // },
* // ],
* // nextToken: "STRING_VALUE",
Expand Down
9 changes: 6 additions & 3 deletions clients/client-omics/src/commands/ListSharesCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ export interface ListSharesCommandInput extends ListSharesRequest {}
export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataBearer {}

/**
* <p>
* Lists all shares associated with an account.
* </p>
* <p>Retrieves the resource shares associated with an account. Use the filter parameter to
* retrieve a specific subset of the shares.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -45,6 +44,9 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB
* status: [ // StatusList
* "STRING_VALUE",
* ],
* type: [ // TypeList
* "STRING_VALUE",
* ],
* },
* nextToken: "STRING_VALUE",
* maxResults: Number("int"),
Expand All @@ -56,6 +58,7 @@ export interface ListSharesCommandOutput extends ListSharesResponse, __MetadataB
* // { // ShareDetails
* // shareId: "STRING_VALUE",
* // resourceArn: "STRING_VALUE",
* // resourceId: "STRING_VALUE",
* // principalSubscriber: "STRING_VALUE",
* // ownerId: "STRING_VALUE",
* // status: "STRING_VALUE",
Expand Down
8 changes: 8 additions & 0 deletions clients/client-omics/src/commands/StartRunCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBeare
/**
* <p>Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The
* remaining parameters are copied from the previous run.</p>
* <p>StartRun will not support re-run for a workflow that is shared with you.</p>
* <p>The total number of runs in your account is subject to a quota per Region. To avoid
* needing to delete runs manually, you can set the retention mode to <code>REMOVE</code>.
* Runs with this setting are deleted automatically when the run quoata is exceeded.</p>
* <p>By default, the run uses STATIC storage. For STATIC storage, set the <code>storageCapacity</code> field.
* You can set the storage type to DYNAMIC. You do not set <code>storageCapacity</code>,
* because HealthOmics dynamically scales the storage up or down as required.
* 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>AWS HealthOmics User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -55,6 +61,8 @@ export interface StartRunCommandOutput extends StartRunResponse, __MetadataBeare
* },
* requestId: "STRING_VALUE", // required
* retentionMode: "STRING_VALUE",
* storageType: "STRING_VALUE",
* workflowOwnerId: "STRING_VALUE",
* };
* const command = new StartRunCommand(input);
* const response = await client.send(command);
Expand Down
Loading

0 comments on commit f47a1b2

Please sign in to comment.