HealthOmics API Reference - HealthOmics API Reference

HealthOmics API Reference

This document provides detailed information about the AWS HealthOmics API actions and their parameters.

For information about the IAM access control permissions you need to use this API, see Using IAM identity policies to manage permissions.

You can use AWS SDKs to access HealthOmics APIs using your favorite programming language. The SDKs automatically perform useful tasks for you, such as:

  • Cryptographically sign your service requests

  • Retry requests

  • Handle error responses

The following resources provide additional information about the HealthOmics API.

HealthOmics service endpoints

The Amazon Web Services General Reference lists the HealthOmics service endpoints for each region. See Service quotas and endpoints for HealthOmics. For each region, HealthOmics provides separate API endpoints for storage API operations, analytics API operations, and workflow API operations. The endpoints take the following format:

storage-omics.region.amazonaws.com analytics-omics.region.amazonaws.com workflows-omics.region.amazonaws.com Examples: storage-omics.us-east-1.amazonaws.com analytics-omics.eu-west-1.amazonaws.com workflows-omics.ap-southeast-1.amazonaws.com

HealthOmics operations for storage, workflows, and analytics

To help you identify the API operations that apply to workflows, storage, and analytics, see the following sections.

Workflow API operations

The following API operations apply to workflows, workflow versions, runs, run cache, and run groups.

Storage API operations

The following API operations apply to sequence stores, reference store, and read sets.

Analytics API operations

Analytics API operation
CreateVariantStore, DeleteVariantStore, GetVariantStore, ListVariantStores, UpdateVariantStore
StartVariantImportJob, CancelVariantImportJob, GetVariantImportJob, ListVariantImportJobs
CreateAnnotationStore, DeleteAnnotationStore, GetAnnotationStore, ListAnnotationStores, UpdateAnnotationStore
StartAnnotationImportJob, ListAnnotationImportJobs, GetAnnotationImportJob, CancelAnnotationImportJob