Package-level declarations

Types

Link copied to clipboard

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
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

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

Accept a resource share request.

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

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

You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).

Link copied to clipboard

You can optionally create a run group to limit the compute resources for the runs that you add to the 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 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).

Link copied to clipboard

Creates a variant store.

Link copied to clipboard

Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:

Link copied to clipboard

Creates a new workflow version for the workflow that you specify with the workflowId parameter.

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

Delete a run cache. This action removes the cache metadata stored in the service account, but doesn't delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations.

Link copied to clipboard

Deletes a workflow run group.

Link copied to clipboard

Deletes an access policy for the specified store.

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

Link copied to clipboard

Deletes a variant store.

Link copied to clipboard

Deletes a workflow.

Link copied to clipboard

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.

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.getRunCache(crossinline block: GetRunCacheRequest.Builder.() -> Unit): GetRunCacheResponse

Retrieve the details for the specified run cache.

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

Retrieves details about an access policy on a given store.

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 the specified resource 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

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

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

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 your run caches.

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

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

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

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Link copied to clipboard

Adds an access policy to the specified store.

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 new run or duplicates an existing 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

Update a run cache.

Link copied to clipboard

Updates a run group.

Link copied to clipboard

Update one or more parameters for the sequence store.

Link copied to clipboard

Updates a variant store.

Link copied to clipboard

Updates information about a workflow. For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.

Link copied to clipboard

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

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.