Skip to content

Commit

Permalink
feat(client-omics): This release provides support for Ready2Run and G…
Browse files Browse the repository at this point in the history 
…PU workflows, an improved read set filter, the direct upload of read sets into Omics Storage, and annotation parsing for analytics stores.
  • Loading branch information
awstools committed May 11, 2023
1 parent e0f0af1 commit c64a34c
Show file tree
Hide file tree
Showing 38 changed files with 4,675 additions and 252 deletions.
64 changes: 56 additions & 8 deletions clients/client-omics/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
AWS SDK for JavaScript Omics Client for Node.js, Browser and React Native.

<p>This is the <i>Amazon Omics API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/omics/latest/dev/">What is Amazon Omics?</a> in the
<i>Amazon Omics Developer Guide</i>.</p>
<i>Amazon Omics User Guide</i>.</p>

## Installing

Expand All @@ -24,16 +24,16 @@ using your favorite package manager:

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the `OmicsClient` and
the commands you need, for example `BatchDeleteReadSetCommand`:
the commands you need, for example `AbortMultipartReadSetUploadCommand`:

```js
// ES5 example
const { OmicsClient, BatchDeleteReadSetCommand } = require("@aws-sdk/client-omics");
const { OmicsClient, AbortMultipartReadSetUploadCommand } = require("@aws-sdk/client-omics");
```

```ts
// ES6+ example
import { OmicsClient, BatchDeleteReadSetCommand } from "@aws-sdk/client-omics";
import { OmicsClient, AbortMultipartReadSetUploadCommand } from "@aws-sdk/client-omics";
```

### Usage
Expand All @@ -52,7 +52,7 @@ const client = new OmicsClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new BatchDeleteReadSetCommand(params);
const command = new AbortMultipartReadSetUploadCommand(params);
```

#### Async/await
Expand Down Expand Up @@ -131,15 +131,15 @@ const client = new AWS.Omics({ region: "REGION" });

// async/await.
try {
const data = await client.batchDeleteReadSet(params);
const data = await client.abortMultipartReadSetUpload(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.batchDeleteReadSet(params)
.abortMultipartReadSetUpload(params)
.then((data) => {
// process data.
})
Expand All @@ -148,7 +148,7 @@ client
});

// callbacks.
client.batchDeleteReadSet(params, (err, data) => {
client.abortMultipartReadSetUpload(params, (err, data) => {
// process err and data.
});
```
Expand Down Expand Up @@ -204,6 +204,14 @@ see LICENSE for more information.

## Client Commands (Operations List)

<details>
<summary>
AbortMultipartReadSetUpload
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/abortmultipartreadsetuploadcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/abortmultipartreadsetuploadcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/abortmultipartreadsetuploadcommandoutput.html)

</details>
<details>
<summary>
BatchDeleteReadSet
Expand Down Expand Up @@ -235,6 +243,14 @@ CancelVariantImportJob

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/cancelvariantimportjobcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/cancelvariantimportjobcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/cancelvariantimportjobcommandoutput.html)

</details>
<details>
<summary>
CompleteMultipartReadSetUpload
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/completemultipartreadsetuploadcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/completemultipartreadsetuploadcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/completemultipartreadsetuploadcommandoutput.html)

</details>
<details>
<summary>
Expand All @@ -243,6 +259,14 @@ CreateAnnotationStore

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/createannotationstorecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/createannotationstorecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/createannotationstorecommandoutput.html)

</details>
<details>
<summary>
CreateMultipartReadSetUpload
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/createmultipartreadsetuploadcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/createmultipartreadsetuploadcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/createmultipartreadsetuploadcommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -507,6 +531,14 @@ ListAnnotationStores

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/listannotationstorescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listannotationstorescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listannotationstorescommandoutput.html)

</details>
<details>
<summary>
ListMultipartReadSetUploads
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/listmultipartreadsetuploadscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listmultipartreadsetuploadscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listmultipartreadsetuploadscommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -539,6 +571,14 @@ ListReadSets

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/listreadsetscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listreadsetscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listreadsetscommandoutput.html)

</details>
<details>
<summary>
ListReadSetUploadParts
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/listreadsetuploadpartscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listreadsetuploadpartscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/listreadsetuploadpartscommandoutput.html)

</details>
<details>
<summary>
Expand Down Expand Up @@ -732,3 +772,11 @@ UpdateWorkflow
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/updateworkflowcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/updateworkflowcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/updateworkflowcommandoutput.html)

</details>
<details>
<summary>
UploadReadSetPart
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/classes/uploadreadsetpartcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/uploadreadsetpartcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-omics/interfaces/uploadreadsetpartcommandoutput.html)

</details>
Loading

0 comments on commit c64a34c

Please sign in to comment.