Amazon Omics
Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate insights from genomics and other biological data. It simplifies and accelerates the process of storing and analyzing genomic information for Amazon Web Services. For an introduction to the service, see What is Amazon Web Services HealthOmics? in the Amazon Web Services HealthOmics User Guide .
Endpoints 107
Sequence store
- DELETEAbort multipart read set upload
/sequencestore/:sequenceStoreId/upload/:uploadId/abortStops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read… - POSTComplete multipart read set upload
/sequencestore/:sequenceStoreId/upload/:uploadId/completeCompletes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all… - POSTCreate multipart read set upload
/sequencestore/:sequenceStoreId/uploadInitiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance… - POSTCreate sequence store
/sequencestoreCreates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM,… - GETGet sequence store
/sequencestore/:idRetrieves metadata for a sequence store using its ID and returns it in JSON format. - DELETEDelete sequence store
/sequencestore/:idDeletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any… - PATCHUpdate sequence store
/sequencestore/:idUpdate one or more parameters for the sequence store. - GETGet read set activation job
/sequencestore/:sequenceStoreId/activationjob/:idReturns detailed information about the status of a read set activation job in JSON format. - GETGet read set export job
/sequencestore/:sequenceStoreId/exportjob/:idRetrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export… - GETGet read set import job
/sequencestore/:sequenceStoreId/importjob/:idGets detailed and status information about a read set import job and returns the data in JSON format. - POSTList multipart read set uploads
/sequencestore/:sequenceStoreId/uploads?maxResults=0&nextToken=stringLists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the… - POSTList read set activation jobs
/sequencestore/:sequenceStoreId/activationjobs?maxResults=0&nextToken=stringRetrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the… - POSTList read set export jobs
/sequencestore/:sequenceStoreId/exportjobs?maxResults=0&nextToken=stringRetrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by… - POSTList read set import jobs
/sequencestore/:sequenceStoreId/importjobs?maxResults=0&nextToken=stringRetrieves a list of read set import jobs and returns the data in JSON format. - POSTList read set upload parts
/sequencestore/:sequenceStoreId/upload/:uploadId/parts?maxResults=0&nextToken=stringLists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output. - POSTList sequence stores
/sequencestores?maxResults=0&nextToken=stringRetrieves a list of sequence stores and returns each sequence store's metadata. For more information, see Creating a HealthOmics sequence store in the Amazon… - POSTStart read set activation job
/sequencestore/:sequenceStoreId/activationjobActivates an archived read set and returns its metadata in a JSON formatted output. Amazon Web Services HealthOmics automatically archives unused read sets… - POSTStart read set export job
/sequencestore/:sequenceStoreId/exportjobStarts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the… - POSTStart read set import job
/sequencestore/:sequenceStoreId/importjobImports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set… - PUTUpload read set part
/sequencestore/:sequenceStoreId/upload/:uploadId/part?partSource=string&partNumber=0Uploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces…
Share
- GETGet share
/share/:shareIdRetrieves the metadata for the specified resource share. - POSTAccept share
/share/:shareIdAccept a resource share request. - DELETEDelete share
/share/:shareIdDeletes 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… - POSTCreate share
/shareCreates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an Amazon Web Services user… - POSTList shares
/shares?nextToken=string&maxResults=0Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.
Read set
- POSTBatch delete read set
/sequencestore/:sequenceStoreId/readset/batch/deleteDeletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets,… - GETGet read set
/sequencestore/:sequenceStoreId/readset/:id?file=string&partNumber=0Retrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to… - GETGet read set metadata
/sequencestore/:sequenceStoreId/readset/:id/metadataRetrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set,… - POSTList read sets
/sequencestore/:sequenceStoreId/readsets?maxResults=0&nextToken=stringRetrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.
Annotation import job
- GETGet annotation import job
/import/annotation/:jobIdAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - DELETECancel annotation import job
/import/annotation/:jobIdAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTList annotation import jobs
/import/annotations?maxResults=0&nextToken=stringAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTStart annotation import job
/import/annotationAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service…
Run
- POSTCancel run
/run/:id/cancelCancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns… - GETGet run
/run/:id?export=Gets detailed information about a specific run using its ID. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service… - DELETEDelete run
/run/:idDeletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED , FAILED , or… - GETList runs
/run?name=string&runGroupId=string&batchId=string&startingToken=string&maxResults=0&status=stringRetrieves a list of runs and returns each run's metadata and status. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by… - POSTStart run
/runStarts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs,…
Run batch
- POSTCancel run batch
/runBatch/cancelCancels all runs within a specified batch. This operation prevents not-yet-submitted runs from starting and submits CancelRun requests for runs that have… - GETGet batch
/runBatch/:batchIdRetrieves details and current status for a specific run batch, including submission progress and run execution counts. - DELETEDelete batch
/runBatch/:batchIdDeletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call DeleteRunBatch… - POSTDelete run batch
/runBatch/deleteDeletes the individual workflow runs within a batch. This operation is separate from DeleteBatch , which removes the batch metadata. Delete is only allowed on… - GETList batch
/runBatch?maxItems=0&startingToken=string&status=string&name=string&runGroupId=stringReturns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is… - POSTStart run batch
/runBatchStarts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting . Per-run… - GETList runs in batch
/runBatch/:batchId/run?maxItems=0&startingToken=string&submissionStatus=string&runSettingId=string&runId=stringReturns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId ,…
Variant import job
- GETGet variant import job
/import/variant/:jobIdAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - DELETECancel variant import job
/import/variant/:jobIdAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTList variant import jobs
/import/variants?maxResults=0&nextToken=stringAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTStart variant import job
/import/variantAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service…
Annotation store
- POSTCreate annotation store
/annotationStoreAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - GETGet annotation store
/annotationStore/:nameAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTUpdate annotation store
/annotationStore/:nameAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - DELETEDelete annotation store
/annotationStore/:name?force=trueAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTList annotation stores
/annotationStores?maxResults=0&nextToken=stringAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service…
Annotation store version
- POSTCreate annotation store version
/annotationStore/:name/versionCreates a new version of an annotation store. - POSTDelete annotation store versions
/annotationStore/:name/versions/delete?force=trueDeletes one or multiple versions of an annotation store. - GETGet annotation store version
/annotationStore/:name/version/:versionNameRetrieves the metadata for an annotation store version. - POSTUpdate annotation store version
/annotationStore/:name/version/:versionNameUpdates the description of an annotation store version. - POSTList annotation store versions
/annotationStore/:name/versions?maxResults=0&nextToken=stringLists the versions of an annotation store.
Configuration
- GETList configurations
/configuration?maxResults=0&startingToken=stringList all configurations for the account. - POSTCreate configuration
/configurationCreate a new configuration. - GETGet configuration
/configuration/:nameRetrieve configuration details for specified name. - DELETEDelete configuration
/configuration/:nameDelete an existing configuration.
Reference store
- POSTCreate reference store
/referencestoreCreates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is… - GETGet reference store
/referencestore/:idGets information about a reference store. - DELETEDelete reference store
/referencestore/:idDeletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain… - GETGet reference import job
/referencestore/:referenceStoreId/importjob/:idMonitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation. - POSTList reference import jobs
/referencestore/:referenceStoreId/importjobs?maxResults=0&nextToken=stringRetrieves the metadata of one or more reference import jobs for a reference store. - POSTList reference stores
/referencestores?maxResults=0&nextToken=stringRetrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in… - POSTStart reference import job
/referencestore/:referenceStoreId/importjobImports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import…
Run cache
- GETList run caches
/runCache?maxResults=0&startingToken=stringRetrieves a list of your run caches and the metadata for each cache. - POSTCreate run cache
/runCacheCreates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves… - GETGet run cache
/runCache/:idRetrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in… - POSTUpdate run cache
/runCache/:idUpdates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the… - DELETEDelete run cache
/runCache/:idDeletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account,…
Run group
- GETList run groups
/runGroup?name=string&startingToken=string&maxResults=0Retrieves a list of all run groups and returns the metadata for each run group. - POSTCreate run group
/runGroupCreates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group. - GETGet run group
/runGroup/:idGets information about a run group and returns its metadata. - POSTUpdate run group
/runGroup/:idUpdates the settings of a run group and returns a response with no body if the operation is successful. You can update the following settings with… - DELETEDelete run group
/runGroup/:idDeletes a run group and returns a response with no body if the operation is successful. To verify that the run group is deleted: Use ListRunGroups to confirm…
Variant store
- POSTCreate variant store
/variantStoreAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - GETGet variant store
/variantStore/:nameAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTUpdate variant store
/variantStore/:nameAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - DELETEDelete variant store
/variantStore/:name?force=trueAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service… - POSTList variant stores
/variantStores?maxResults=0&nextToken=stringAmazon Web Services HealthOmics variant stores and annotation stores are no longer open to new customers. Existing customers can continue to use the service…
Workflow
- GETList workflows
/workflow?type=string&name=string&startingToken=string&maxResults=0Retrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a… - POSTCreate workflow
/workflowCreates a private workflow. Before you create a private workflow, you must create and configure these required resources: Workflow definition file: A workflow… - GETGet workflow
/workflow/:id?type=string&export=&workflowOwnerId=stringGets all information about a workflow using its ID. If a workflow is shared with you, you cannot export the workflow. For more information about your workflow… - POSTUpdate workflow
/workflow/:idUpdates information about a workflow. You can update the following workflow information: Name Description Default storage type Default storage capacity (with… - DELETEDelete workflow
/workflow/:idDeletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful. To verify that the workflow is deleted:…
Workflow version
- GETList workflow versions
/workflow/:workflowId/version?type=string&workflowOwnerId=string&startingToken=string&maxResults=0Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web… - POSTCreate workflow version
/workflow/:workflowId/versionCreates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to… - GETGet workflow version
/workflow/:workflowId/version/:versionName?type=string&export=&workflowOwnerId=stringGets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services… - POSTUpdate workflow version
/workflow/:workflowId/version/:versionNameUpdates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services… - DELETEDelete workflow version
/workflow/:workflowId/version/:versionNameDeletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version. For more information, see…
Reference
- GETGet reference
/referencestore/:referenceStoreId/reference/:id?partNumber=0&file=stringDownloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded. For more information, see Creating a… - DELETEDelete reference
/referencestore/:referenceStoreId/reference/:idDeletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be… - GETGet reference metadata
/referencestore/:referenceStoreId/reference/:id/metadataRetrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return… - POSTList references
/referencestore/:referenceStoreId/references?maxResults=0&nextToken=stringRetrieves the metadata of one or more reference genomes in a reference store. For more information, see Creating a reference store in the Amazon Web Services…
Task
- GETGet run task
/run/:id/task/:taskIdGets detailed information about a run task using its ID. - GETList run tasks
/run/:id/task?status=string&startingToken=string&maxResults=0Returns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.
Tagging
- GETList tags for resource
/tags/:resourceArnRetrieves a list of tags for a resource. - POSTTag resource
/tags/:resourceArnTags a resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes tags from a resource.
- GETGet s3 access policy
/s3accesspolicy/:s3AccessPointArnRetrieves details about an access policy on a given store. - PUTPut s3 access policy
/s3accesspolicy/:s3AccessPointArnAdds an access policy to the specified store. - DELETEDelete s3 access policy
/s3accesspolicy/:s3AccessPointArnDeletes an access policy for the specified store.
API details
- Base URL
https://omics.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 107 operations on 72 pathsPOST 51GET 35DELETE 18PUT 2PATCH 1
- Main resources
- Sequence store 20Reference store 7Run batch 7Annotation store 5Annotation store version 5Run 5Run cache 5Run group 5Share 5Variant store 5
- Description format
- AWS Smithy model, API version
2022-11-28 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Omics in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Omics collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Abort multipart read set upload” (DELETE /sequencestore/:sequenceStoreId/upload/:uploadId/abort), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Omics?
Amazon Web Services HealthOmics is a service that helps users such as bioinformaticians, researchers, and scientists to store, query, analyze, and generate… It is listed under Healthcare and has 107 endpoints.
Who publishes the Amazon Omics?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Omics?
Requests go to https://omics.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Omics?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Omics have?
107 operations on 72 paths (51 POST, 35 GET, 18 DELETE, 2 PUT, 1 PATCH). The largest groups are Sequence store, Reference store, Run batch, Annotation store.
Is forking the Amazon Omics free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.