Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-omics

@aws-sdk/client-omics

Description

AWS SDK for JavaScript Omics Client for Node.js, Browser and React Native.

This is the AWS HealthOmics API Reference. For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.

Installing

To install the this package, simply type add or install @aws-sdk/client-omics using your favorite package manager:

  • npm install @aws-sdk/client-omics
  • yarn add @aws-sdk/client-omics
  • pnpm add @aws-sdk/client-omics

Getting Started

Import

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 AbortMultipartReadSetUploadCommand:

// ES5 example
const { OmicsClient, AbortMultipartReadSetUploadCommand } = require("@aws-sdk/client-omics");
// ES6+ example
import { OmicsClient, AbortMultipartReadSetUploadCommand } from "@aws-sdk/client-omics";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new OmicsClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new AbortMultipartReadSetUploadCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-omics";
const client = new AWS.Omics({ region: "REGION" });

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

// Promises.
client
.abortMultipartReadSetUpload(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.abortMultipartReadSetUpload(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-omics package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AbortMultipartReadSetUpload

Command API Reference / Input / Output

AcceptShare

Command API Reference / Input / Output

BatchDeleteReadSet

Command API Reference / Input / Output

CancelAnnotationImportJob

Command API Reference / Input / Output

CancelRun

Command API Reference / Input / Output

CancelVariantImportJob

Command API Reference / Input / Output

CompleteMultipartReadSetUpload

Command API Reference / Input / Output

CreateAnnotationStore

Command API Reference / Input / Output

CreateAnnotationStoreVersion

Command API Reference / Input / Output

CreateMultipartReadSetUpload

Command API Reference / Input / Output

CreateReferenceStore

Command API Reference / Input / Output

CreateRunGroup

Command API Reference / Input / Output

CreateSequenceStore

Command API Reference / Input / Output

CreateShare

Command API Reference / Input / Output

CreateVariantStore

Command API Reference / Input / Output

CreateWorkflow

Command API Reference / Input / Output

DeleteAnnotationStore

Command API Reference / Input / Output

DeleteAnnotationStoreVersions

Command API Reference / Input / Output

DeleteReference

Command API Reference / Input / Output

DeleteReferenceStore

Command API Reference / Input / Output

DeleteRun

Command API Reference / Input / Output

DeleteRunGroup

Command API Reference / Input / Output

DeleteSequenceStore

Command API Reference / Input / Output

DeleteShare

Command API Reference / Input / Output

DeleteVariantStore

Command API Reference / Input / Output

DeleteWorkflow

Command API Reference / Input / Output

GetAnnotationImportJob

Command API Reference / Input / Output

GetAnnotationStore

Command API Reference / Input / Output

GetAnnotationStoreVersion

Command API Reference / Input / Output

GetReadSet

Command API Reference / Input / Output

GetReadSetActivationJob

Command API Reference / Input / Output

GetReadSetExportJob

Command API Reference / Input / Output

GetReadSetImportJob

Command API Reference / Input / Output

GetReadSetMetadata

Command API Reference / Input / Output

GetReference

Command API Reference / Input / Output

GetReferenceImportJob

Command API Reference / Input / Output

GetReferenceMetadata

Command API Reference / Input / Output

GetReferenceStore

Command API Reference / Input / Output

GetRun

Command API Reference / Input / Output

GetRunGroup

Command API Reference / Input / Output

GetRunTask

Command API Reference / Input / Output

GetSequenceStore

Command API Reference / Input / Output

GetShare

Command API Reference / Input / Output

GetVariantImportJob

Command API Reference / Input / Output

GetVariantStore

Command API Reference / Input / Output

GetWorkflow

Command API Reference / Input / Output

ListAnnotationImportJobs

Command API Reference / Input / Output

ListAnnotationStores

Command API Reference / Input / Output

ListAnnotationStoreVersions

Command API Reference / Input / Output

ListMultipartReadSetUploads

Command API Reference / Input / Output

ListReadSetActivationJobs

Command API Reference / Input / Output

ListReadSetExportJobs

Command API Reference / Input / Output

ListReadSetImportJobs

Command API Reference / Input / Output

ListReadSets

Command API Reference / Input / Output

ListReadSetUploadParts

Command API Reference / Input / Output

ListReferenceImportJobs

Command API Reference / Input / Output

ListReferences

Command API Reference / Input / Output

ListReferenceStores

Command API Reference / Input / Output

ListRunGroups

Command API Reference / Input / Output

ListRuns

Command API Reference / Input / Output

ListRunTasks

Command API Reference / Input / Output

ListSequenceStores

Command API Reference / Input / Output

ListShares

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListVariantImportJobs

Command API Reference / Input / Output

ListVariantStores

Command API Reference / Input / Output

ListWorkflows

Command API Reference / Input / Output

StartAnnotationImportJob

Command API Reference / Input / Output

StartReadSetActivationJob

Command API Reference / Input / Output

StartReadSetExportJob

Command API Reference / Input / Output

StartReadSetImportJob

Command API Reference / Input / Output

StartReferenceImportJob

Command API Reference / Input / Output

StartRun

Command API Reference / Input / Output

StartVariantImportJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAnnotationStore

Command API Reference / Input / Output

UpdateAnnotationStoreVersion

Command API Reference / Input / Output

UpdateRunGroup

Command API Reference / Input / Output

UpdateVariantStore

Command API Reference / Input / Output

UpdateWorkflow

Command API Reference / Input / Output

UploadReadSetPart

Command API Reference / Input / Output