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
-
Cryptographically sign your service requests
-
Retry requests
-
Handle error responses
The following resources provide additional information about the HealthOmics API.
-
Amazon Web Services General Reference
-
AWS Command Line Interface
-
Quotas for HealthOmics API operations
See API quotas in the HealthOmics User Guide.
Topics
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.
Workflows |
CreateWorkflow, StartRun, StartRun, StartRun, StartRun |
Workflow versions |
CreateWorkflow, StartRun, StartRun, StartRun, StartRun |
Runs |
StartRun, StartRun, CancelRun, GetRun, ListRuns |
Run tasks |
GetRunTask, ListRunTasks |
Run cache |
StartRun, StartRun, StartRun, StartRun, StartRun |
Run groups |
CreateRunGroup, UpdateRunGroup, DeleteRunGroup, GetRunGroup, ListRunGroups |
Storage API operations
The following API operations apply to sequence stores, reference store, and read sets.
Sequence stores |
CreateSequenceStore;, DeleteSequenceStore;, GetSequenceStore;, ListSequenceStores |
Reference stores |
CreateReferenceStore, DeleteReferenceStore, ListReferenceStores |
References |
DeleteReference, GetReference, ListReferences, GetReferenceMetadata |
Reference import jobs; |
StartReferencetImportJob, GetReferenceImportJob, ListReferenceImportJobs |
Read sets |
GetReadSet, GetReadSetMetadata, ListReadSets |
Read set import jobs |
StartReadSetImportJob, GetReadSetImportJob, ListReadSetImportJobs, BatchDeleteReadSet, UploadReadSetPart |
Read set export jobs |
StartReadSetExportJob, GetReadSetExportJob, ListReadSetExportJobs |
Read set activation jobs |
StartReadsetActivationJob, ListReadsetActivationJobs, GetReadSetActivationJob |
Multipart read set Uploads |
CreateMultipartReadSetUpload, CompleteMultipartReadSetUpload, AbortMultipartReadSetUpload, ListMultipartReadSetUploads, ListReadSetUploadParts |
Analytics API operations
Analytics API operation |
---|
CreateVariantStore, DeleteVariantStore, GetVariantStore, ListVariantStores, UpdateVariantStore |
StartVariantImportJob, CancelVariantImportJob, GetVariantImportJob, ListVariantImportJobs |
CreateAnnotationStore, DeleteAnnotationStore, GetAnnotationStore, ListAnnotationStores, UpdateAnnotationStore |
StartAnnotationImportJob, ListAnnotationImportJobs, GetAnnotationImportJob, CancelAnnotationImportJob |