AWS.Omics — AWS SDK for JavaScript (original) (raw)

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

abortMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Stops a multipart upload.

acceptShare(params = {}, callback) ⇒ AWS.Request

Accept a resource share request.

batchDeleteReadSet(params = {}, callback) ⇒ AWS.Request

Deletes one or more read sets.

cancelAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Cancels an annotation import job.

cancelVariantImportJob(params = {}, callback) ⇒ AWS.Request

Cancels a variant import job.

completeMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Concludes a multipart upload once you have uploaded all the components.

createAnnotationStore(params = {}, callback) ⇒ AWS.Request

Creates an annotation store.

createAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Creates a new version of an annotation store.

createMultipartReadSetUpload(params = {}, callback) ⇒ AWS.Request

Begins a multipart read set upload.

createReferenceStore(params = {}, callback) ⇒ AWS.Request

Creates a reference store.

createRunGroup(params = {}, callback) ⇒ AWS.Request

You can optionally create a run group to limit the compute resources for the runs that you add to the group.

createSequenceStore(params = {}, callback) ⇒ AWS.Request

Creates a sequence store.

createShare(params = {}, callback) ⇒ AWS.Request

Creates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber (an AWS user with a different account than the resource owner).

The following resources support cross-account sharing:

• HealthOmics variant stores
• HealthOmics annotation stores
• Private workflows

createVariantStore(params = {}, callback) ⇒ AWS.Request

createWorkflow(params = {}, callback) ⇒ AWS.Request

deleteAnnotationStore(params = {}, callback) ⇒ AWS.Request

Deletes an annotation store.

deleteAnnotationStoreVersions(params = {}, callback) ⇒ AWS.Request

Deletes one or multiple versions of an annotation store.

deleteReference(params = {}, callback) ⇒ AWS.Request

Deletes a genome reference.

deleteReferenceStore(params = {}, callback) ⇒ AWS.Request

Deletes a genome reference store.

deleteRunGroup(params = {}, callback) ⇒ AWS.Request

Deletes a workflow run group.

deleteSequenceStore(params = {}, callback) ⇒ AWS.Request

Deletes a sequence store.

deleteShare(params = {}, callback) ⇒ AWS.Request

Deletes 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 operation deletes your access to the share.

deleteVariantStore(params = {}, callback) ⇒ AWS.Request

deleteWorkflow(params = {}, callback) ⇒ AWS.Request

getAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about an annotation import job.

getAnnotationStore(params = {}, callback) ⇒ AWS.Request

Gets information about an annotation store.

getAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Retrieves the metadata for an annotation store version.

getReadSet(params = {}, callback) ⇒ AWS.Request

Gets a file from a read set.

getReadSetActivationJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set activation job.

getReadSetExportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set export job.

getReadSetImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a read set import job.

getReadSetMetadata(params = {}, callback) ⇒ AWS.Request

Gets details about a read set.

getReferenceImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a reference import job.

getReferenceMetadata(params = {}, callback) ⇒ AWS.Request

Gets information about a genome reference's metadata.

getReferenceStore(params = {}, callback) ⇒ AWS.Request

Gets information about a reference store.

getRun(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

getRunGroup(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run group.

getRunTask(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow run task.

getSequenceStore(params = {}, callback) ⇒ AWS.Request

Gets information about a sequence store.

getShare(params = {}, callback) ⇒ AWS.Request

Retrieves the metadata for the specified resource share.

getVariantImportJob(params = {}, callback) ⇒ AWS.Request

Gets information about a variant import job.

getVariantStore(params = {}, callback) ⇒ AWS.Request

Gets information about a variant store.

getWorkflow(params = {}, callback) ⇒ AWS.Request

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

listAnnotationImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of annotation import jobs.

listAnnotationStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of annotation stores.

listAnnotationStoreVersions(params = {}, callback) ⇒ AWS.Request

Lists the versions of an annotation store.

listMultipartReadSetUploads(params = {}, callback) ⇒ AWS.Request

Lists multipart read set uploads and for in progress uploads. Once the upload is completed, a read set is created and the upload will no longer be returned in the response.

listReadSetActivationJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set activation jobs.

listReadSetExportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set export jobs.

listReadSetImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read set import jobs.

listReadSets(params = {}, callback) ⇒ AWS.Request

Retrieves a list of read sets.

listReadSetUploadParts(params = {}, callback) ⇒ AWS.Request

This operation will list all parts in a requested multipart upload for a sequence store.

listReferenceImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of reference import jobs.

listReferences(params = {}, callback) ⇒ AWS.Request

Retrieves a list of references.

listReferenceStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of reference stores.

listRunGroups(params = {}, callback) ⇒ AWS.Request

Retrieves a list of run groups.

listRuns(params = {}, callback) ⇒ AWS.Request

Retrieves a list of runs.

listRunTasks(params = {}, callback) ⇒ AWS.Request

Retrieves a list of tasks for a run.

listSequenceStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of sequence stores.

listShares(params = {}, callback) ⇒ AWS.Request

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves a list of tags for a resource.

listVariantImportJobs(params = {}, callback) ⇒ AWS.Request

Retrieves a list of variant import jobs.

listVariantStores(params = {}, callback) ⇒ AWS.Request

Retrieves a list of variant stores.

listWorkflows(params = {}, callback) ⇒ AWS.Request

Retrieves a list of workflows.

startAnnotationImportJob(params = {}, callback) ⇒ AWS.Request

Starts an annotation import job.

startReadSetActivationJob(params = {}, callback) ⇒ AWS.Request

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

startReadSetExportJob(params = {}, callback) ⇒ AWS.Request

Exports a read set to Amazon S3.

startReadSetImportJob(params = {}, callback) ⇒ AWS.Request

Starts a read set import job.

startReferenceImportJob(params = {}, callback) ⇒ AWS.Request

Starts a reference import job.

startRun(params = {}, callback) ⇒ AWS.Request

Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.

StartRun will not support re-run for a workflow that is shared with you.

The total number of runs in your account is subject to a quota per Region. To avoid needing to delete runs manually, you can set the retention mode to REMOVE. Runs with this setting are deleted automatically when the run quoata is exceeded.

By default, the run uses STATIC storage. For STATIC storage, set the storageCapacity field. You can set the storage type to DYNAMIC. You do not set storageCapacity, because HealthOmics dynamically scales the storage up or down as required. For more information about static and dynamic storage, see Running workflows in the AWS HealthOmics User Guide.

startVariantImportJob(params = {}, callback) ⇒ AWS.Request

Starts a variant import job.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

updateAnnotationStore(params = {}, callback) ⇒ AWS.Request

Updates an annotation store.

updateAnnotationStoreVersion(params = {}, callback) ⇒ AWS.Request

Updates the description of an annotation store version.

updateRunGroup(params = {}, callback) ⇒ AWS.Request

updateVariantStore(params = {}, callback) ⇒ AWS.Request

updateWorkflow(params = {}, callback) ⇒ AWS.Request

uploadReadSetPart(params = {}, callback) ⇒ AWS.Request

This operation uploads a specific part of a read set. If you upload a new part using a previously used part number, the previously uploaded part will be overwritten.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Omics resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Waiter Resource Details

omics.waitFor('annotationImportJobCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationImportJobCreated state by periodically calling the underlyingOmics.getAnnotationImportJob() operation every 30 seconds (at most 20 times).

omics.waitFor('annotationStoreCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreCreated state by periodically calling the underlyingOmics.getAnnotationStore() operation every 30 seconds (at most 20 times).

omics.waitFor('annotationStoreDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreDeleted state by periodically calling the underlyingOmics.getAnnotationStore() operation every 30 seconds (at most 20 times).

omics.waitFor('annotationStoreVersionCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreVersionCreated state by periodically calling the underlyingOmics.getAnnotationStoreVersion() operation every 30 seconds (at most 20 times).

omics.waitFor('annotationStoreVersionDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the annotationStoreVersionDeleted state by periodically calling the underlyingOmics.getAnnotationStoreVersion() operation every 30 seconds (at most 20 times).

omics.waitFor('readSetActivationJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetActivationJobCompleted state by periodically calling the underlyingOmics.getReadSetActivationJob() operation every 30 seconds (at most 20 times).

omics.waitFor('readSetExportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetExportJobCompleted state by periodically calling the underlyingOmics.getReadSetExportJob() operation every 30 seconds (at most 20 times).

omics.waitFor('readSetImportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the readSetImportJobCompleted state by periodically calling the underlyingOmics.getReadSetImportJob() operation every 30 seconds (at most 20 times).

omics.waitFor('referenceImportJobCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the referenceImportJobCompleted state by periodically calling the underlyingOmics.getReferenceImportJob() operation every 30 seconds (at most 20 times).

omics.waitFor('runCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the runCompleted state by periodically calling the underlyingOmics.getRun() operation every 30 seconds (at most 20 times).

omics.waitFor('runRunning', params = {}, [callback]) ⇒ AWS.Request

Waits for the runRunning state by periodically calling the underlyingOmics.getRun() operation every 30 seconds (at most 20 times).

omics.waitFor('taskCompleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the taskCompleted state by periodically calling the underlyingOmics.getRunTask() operation every 30 seconds (at most 20 times).

omics.waitFor('taskRunning', params = {}, [callback]) ⇒ AWS.Request

Waits for the taskRunning state by periodically calling the underlyingOmics.getRunTask() operation every 30 seconds (at most 20 times).

omics.waitFor('variantImportJobCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantImportJobCreated state by periodically calling the underlyingOmics.getVariantImportJob() operation every 30 seconds (at most 20 times).

omics.waitFor('variantStoreCreated', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantStoreCreated state by periodically calling the underlyingOmics.getVariantStore() operation every 30 seconds (at most 20 times).

omics.waitFor('variantStoreDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the variantStoreDeleted state by periodically calling the underlyingOmics.getVariantStore() operation every 30 seconds (at most 20 times).

omics.waitFor('workflowActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the workflowActive state by periodically calling the underlyingOmics.getWorkflow() operation every 3 seconds (at most 10 times).