OmicsClient

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

Properties

Link copied to clipboard
abstract override val config: OmicsClient.Config

OmicsClient's configuration

Functions

Link copied to clipboard
Link copied to clipboard
abstract suspend fun acceptShare(input: AcceptShareRequest): AcceptShareResponse

Accepts a share for an analytics store.

Link copied to clipboard

Deletes one or more read sets.

Link copied to clipboard

Cancels an annotation import job.

Link copied to clipboard
abstract suspend fun cancelRun(input: CancelRunRequest): CancelRunResponse

Cancels a run.

Link copied to clipboard

Cancels a variant import job.

Link copied to clipboard

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

Link copied to clipboard

Creates an annotation store.

Link copied to clipboard

Creates a new version of an annotation store.

Link copied to clipboard

Begins a multipart read set upload.

Link copied to clipboard

Creates a reference store.

Link copied to clipboard

Creates a run group.

Link copied to clipboard

Creates a sequence store.

Link copied to clipboard
abstract suspend fun createShare(input: CreateShareRequest): CreateShareResponse

Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.

Link copied to clipboard

Creates a variant store.

Link copied to clipboard

Creates a workflow.

Link copied to clipboard

Deletes an annotation store.

Link copied to clipboard

Deletes one or multiple versions of an annotation store.

Link copied to clipboard

Deletes a genome reference.

Link copied to clipboard

Deletes a genome reference store.

Link copied to clipboard
abstract suspend fun deleteRun(input: DeleteRunRequest): DeleteRunResponse

Deletes a workflow run.

Link copied to clipboard

Deletes a workflow run group.

Link copied to clipboard

Deletes a sequence store.

Link copied to clipboard
abstract suspend fun deleteShare(input: DeleteShareRequest): DeleteShareResponse

Deletes a share of an analytics store.

Link copied to clipboard

Deletes a variant store.

Link copied to clipboard

Deletes a workflow.

Link copied to clipboard

Gets information about an annotation import job.

Link copied to clipboard

Gets information about an annotation store.

Link copied to clipboard

Retrieves the metadata for an annotation store version.

Link copied to clipboard
abstract suspend fun <T> getReadSet(input: GetReadSetRequest, block: suspend (GetReadSetResponse) -> T): T

Gets a file from a read set.

Link copied to clipboard

Gets information about a read set activation job.

Link copied to clipboard

Gets information about a read set export job.

Link copied to clipboard

Gets information about a read set import job.

Link copied to clipboard

Gets details about a read set.

Link copied to clipboard
abstract suspend fun <T> getReference(input: GetReferenceRequest, block: suspend (GetReferenceResponse) -> T): T

Gets a reference file.

Link copied to clipboard

Gets information about a reference import job.

Link copied to clipboard

Gets information about a genome reference's metadata.

Link copied to clipboard

Gets information about a reference store.

Link copied to clipboard
abstract suspend fun getRun(input: GetRunRequest): GetRunResponse

Gets information about a workflow run.

Link copied to clipboard
abstract suspend fun getRunGroup(input: GetRunGroupRequest): GetRunGroupResponse

Gets information about a workflow run group.

Link copied to clipboard
abstract suspend fun getRunTask(input: GetRunTaskRequest): GetRunTaskResponse

Gets information about a workflow run task.

Link copied to clipboard

Gets information about a sequence store.

Link copied to clipboard
abstract suspend fun getShare(input: GetShareRequest): GetShareResponse

Retrieves the metadata for a share.

Link copied to clipboard

Gets information about a variant import job.

Link copied to clipboard

Gets information about a variant store.

Link copied to clipboard
abstract suspend fun getWorkflow(input: GetWorkflowRequest): GetWorkflowResponse

Gets information about a workflow.

Link copied to clipboard
abstract suspend fun listAnnotationImportJobs(input: ListAnnotationImportJobsRequest = ListAnnotationImportJobsRequest { }): ListAnnotationImportJobsResponse

Retrieves a list of annotation import jobs.

Link copied to clipboard
abstract suspend fun listAnnotationStores(input: ListAnnotationStoresRequest = ListAnnotationStoresRequest { }): ListAnnotationStoresResponse

Retrieves a list of annotation stores.

Link copied to clipboard

Lists the versions of an annotation store.

Link copied to clipboard

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 respone.

Link copied to clipboard

Retrieves a list of read set activation jobs.

Link copied to clipboard

Retrieves a list of read set export jobs.

Link copied to clipboard

Retrieves a list of read set import jobs.

Link copied to clipboard

Retrieves a list of read sets.

Link copied to clipboard

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

Link copied to clipboard

Retrieves a list of reference import jobs.

Link copied to clipboard

Retrieves a list of references.

Link copied to clipboard
abstract suspend fun listReferenceStores(input: ListReferenceStoresRequest = ListReferenceStoresRequest { }): ListReferenceStoresResponse

Retrieves a list of reference stores.

Link copied to clipboard
abstract suspend fun listRunGroups(input: ListRunGroupsRequest = ListRunGroupsRequest { }): ListRunGroupsResponse

Retrieves a list of run groups.

Link copied to clipboard
abstract suspend fun listRuns(input: ListRunsRequest = ListRunsRequest { }): ListRunsResponse

Retrieves a list of runs.

Link copied to clipboard

Retrieves a list of tasks for a run.

Link copied to clipboard
abstract suspend fun listSequenceStores(input: ListSequenceStoresRequest = ListSequenceStoresRequest { }): ListSequenceStoresResponse

Retrieves a list of sequence stores.

Link copied to clipboard
abstract suspend fun listShares(input: ListSharesRequest): ListSharesResponse

Lists all shares associated with an account.

Link copied to clipboard

Retrieves a list of tags for a resource.

Link copied to clipboard
abstract suspend fun listVariantImportJobs(input: ListVariantImportJobsRequest = ListVariantImportJobsRequest { }): ListVariantImportJobsResponse

Retrieves a list of variant import jobs.

Link copied to clipboard
abstract suspend fun listVariantStores(input: ListVariantStoresRequest = ListVariantStoresRequest { }): ListVariantStoresResponse

Retrieves a list of variant stores.

Link copied to clipboard
abstract suspend fun listWorkflows(input: ListWorkflowsRequest = ListWorkflowsRequest { }): ListWorkflowsResponse

Retrieves a list of workflows.

Link copied to clipboard

Starts an annotation import job.

Link copied to clipboard

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

Link copied to clipboard

Exports a read set to Amazon S3.

Link copied to clipboard

Starts a read set import job.

Link copied to clipboard

Starts a reference import job.

Link copied to clipboard
abstract suspend fun startRun(input: StartRunRequest): StartRunResponse

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.

Link copied to clipboard

Starts a variant import job.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Tags a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates an annotation store.

Link copied to clipboard

Updates the description of an annotation store version.

Link copied to clipboard

Updates a run group.

Link copied to clipboard

Updates a variant store.

Link copied to clipboard

Updates a workflow.

Link copied to clipboard

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.

Inherited functions

Link copied to clipboard
Link copied to clipboard
inline suspend fun OmicsClient.acceptShare(crossinline block: AcceptShareRequest.Builder.() -> Unit): AcceptShareResponse

Accepts a share for an analytics store.

Link copied to clipboard

Deletes one or more read sets.

Link copied to clipboard

Cancels an annotation import job.

Link copied to clipboard
inline suspend fun OmicsClient.cancelRun(crossinline block: CancelRunRequest.Builder.() -> Unit): CancelRunResponse

Cancels a run.

Link copied to clipboard

Cancels a variant import job.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard

Creates an annotation store.

Link copied to clipboard

Creates a new version of an annotation store.

Link copied to clipboard

Begins a multipart read set upload.

Link copied to clipboard

Creates a reference store.

Link copied to clipboard

Creates a run group.

Link copied to clipboard

Creates a sequence store.

Link copied to clipboard
inline suspend fun OmicsClient.createShare(crossinline block: CreateShareRequest.Builder.() -> Unit): CreateShareResponse

Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.

Link copied to clipboard

Creates a variant store.

Link copied to clipboard

Creates a workflow.

Link copied to clipboard

Deletes an annotation store.

Link copied to clipboard

Deletes one or multiple versions of an annotation store.

Link copied to clipboard

Deletes a genome reference.

Link copied to clipboard

Deletes a genome reference store.

Link copied to clipboard
inline suspend fun OmicsClient.deleteRun(crossinline block: DeleteRunRequest.Builder.() -> Unit): DeleteRunResponse

Deletes a workflow run.

Link copied to clipboard

Deletes a workflow run group.

Link copied to clipboard

Deletes a sequence store.

Link copied to clipboard
inline suspend fun OmicsClient.deleteShare(crossinline block: DeleteShareRequest.Builder.() -> Unit): DeleteShareResponse

Deletes a share of an analytics store.

Link copied to clipboard

Deletes a variant store.

Link copied to clipboard

Deletes a workflow.

Link copied to clipboard

Gets information about an annotation import job.

Link copied to clipboard

Gets information about an annotation store.

Link copied to clipboard

Retrieves the metadata for an annotation store version.

Link copied to clipboard

Gets information about a read set activation job.

Link copied to clipboard

Gets information about a read set export job.

Link copied to clipboard

Gets information about a read set import job.

Link copied to clipboard

Gets details about a read set.

Link copied to clipboard

Gets information about a reference import job.

Link copied to clipboard

Gets information about a genome reference's metadata.

Link copied to clipboard

Gets information about a reference store.

Link copied to clipboard
inline suspend fun OmicsClient.getRun(crossinline block: GetRunRequest.Builder.() -> Unit): GetRunResponse

Gets information about a workflow run.

Link copied to clipboard
inline suspend fun OmicsClient.getRunGroup(crossinline block: GetRunGroupRequest.Builder.() -> Unit): GetRunGroupResponse

Gets information about a workflow run group.

Link copied to clipboard
inline suspend fun OmicsClient.getRunTask(crossinline block: GetRunTaskRequest.Builder.() -> Unit): GetRunTaskResponse

Gets information about a workflow run task.

Link copied to clipboard

Gets information about a sequence store.

Link copied to clipboard
inline suspend fun OmicsClient.getShare(crossinline block: GetShareRequest.Builder.() -> Unit): GetShareResponse

Retrieves the metadata for a share.

Link copied to clipboard

Gets information about a variant import job.

Link copied to clipboard

Gets information about a variant store.

Link copied to clipboard
inline suspend fun OmicsClient.getWorkflow(crossinline block: GetWorkflowRequest.Builder.() -> Unit): GetWorkflowResponse

Gets information about a workflow.

Link copied to clipboard

Retrieves a list of annotation import jobs.

Link copied to clipboard

Retrieves a list of annotation stores.

Link copied to clipboard

Lists the versions of an annotation store.

Link copied to clipboard

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 respone.

Link copied to clipboard

Retrieves a list of read set activation jobs.

Link copied to clipboard

Retrieves a list of read set export jobs.

Link copied to clipboard

Retrieves a list of read set import jobs.

Link copied to clipboard
inline suspend fun OmicsClient.listReadSets(crossinline block: ListReadSetsRequest.Builder.() -> Unit): ListReadSetsResponse

Retrieves a list of read sets.

Link copied to clipboard

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

Link copied to clipboard

Retrieves a list of reference import jobs.

Link copied to clipboard

Retrieves a list of references.

Link copied to clipboard

Retrieves a list of reference stores.

Link copied to clipboard

Retrieves a list of run groups.

Link copied to clipboard
inline suspend fun OmicsClient.listRuns(crossinline block: ListRunsRequest.Builder.() -> Unit): ListRunsResponse

Retrieves a list of runs.

Link copied to clipboard
inline suspend fun OmicsClient.listRunTasks(crossinline block: ListRunTasksRequest.Builder.() -> Unit): ListRunTasksResponse

Retrieves a list of tasks for a run.

Link copied to clipboard

Retrieves a list of sequence stores.

Link copied to clipboard
inline suspend fun OmicsClient.listShares(crossinline block: ListSharesRequest.Builder.() -> Unit): ListSharesResponse

Lists all shares associated with an account.

Link copied to clipboard

Retrieves a list of tags for a resource.

Link copied to clipboard

Retrieves a list of variant import jobs.

Link copied to clipboard

Retrieves a list of variant stores.

Link copied to clipboard

Retrieves a list of workflows.

Link copied to clipboard

Starts an annotation import job.

Link copied to clipboard

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

Link copied to clipboard

Exports a read set to Amazon S3.

Link copied to clipboard

Starts a read set import job.

Link copied to clipboard

Starts a reference import job.

Link copied to clipboard
inline suspend fun OmicsClient.startRun(crossinline block: StartRunRequest.Builder.() -> Unit): StartRunResponse

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.

Link copied to clipboard

Starts a variant import job.

Link copied to clipboard
inline suspend fun OmicsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags a resource.

Link copied to clipboard

Removes tags from a resource.

Link copied to clipboard

Updates an annotation store.

Link copied to clipboard

Updates the description of an annotation store version.

Link copied to clipboard

Updates a run group.

Link copied to clipboard

Updates a variant store.

Link copied to clipboard

Updates a workflow.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.