Package-level declarations

Types

Link copied to clipboard

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.

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 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 API operation to check that it is no longer listed.

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 cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file.

Link copied to clipboard

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

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. Before you create a private workflow, you must create and configure these required resources:

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 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 CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch.

Link copied to clipboard

Deletes 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, but does not 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 run group and returns a response with no body if the operation is successful.

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 by specifying its ID. No response is returned if the deletion is successful.

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 detailed information about a specific run using its ID.

Link copied to clipboard
inline suspend fun OmicsClient.getRunCache(crossinline block: GetRunCacheRequest.Builder.() -> Unit): GetRunCacheResponse

Retrieves detailed information about the specified run cache using its ID.

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

Gets information about a run group and returns its metadata.

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

Gets detailed information about a run task using its ID.

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 all information about a workflow using its ID.

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 and the metadata for each cache.

Link copied to clipboard

Retrieves a list of all run groups and returns the metadata for each run group.

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

Retrieves a list of runs and returns each run's metadata and status.

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

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

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 existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing 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 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, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.

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 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 default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation.

Link copied to clipboard

Updates the settings of a run group and returns a response with no body if the operation is successful.

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.

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.