View Source AWS.Omics (aws-elixir v1.0.4)

Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).

For more information, see Creating a run cache in the AWS HealthOmics User Guide.

create_run_group(client, input, options \\ [])

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

create_sequence_store(client, input, options \\ [])

Creates a sequence store.

create_share(client, input, options \\ [])

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

create_variant_store(client, input, options \\ [])

Creates a variant store.

create_workflow(client, input, options \\ [])

Creates a workflow.

delete_annotation_store(client, name, input, options \\ [])

Deletes an annotation store.

delete_annotation_store_versions(client, name, input, options \\ [])

Deletes one or multiple versions of an annotation store.

delete_reference(client, id, reference_store_id, input, options \\ [])

Deletes a genome reference.

delete_reference_store(client, id, input, options \\ [])

Deletes a genome reference store.

delete_run(client, id, input, options \\ [])

Deletes a workflow run.

delete_run_cache(client, id, input, options \\ [])

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.

For more information, see Deleting a run cache in the AWS HealthOmics User Guide.

delete_run_group(client, id, input, options \\ [])

Deletes a workflow run group.

delete_s3_access_policy(client, s3_access_point_arn, input, options \\ [])

Deletes an access policy for the specified store.

delete_sequence_store(client, id, input, options \\ [])

Deletes a sequence store.

delete_share(client, share_id, input, options \\ [])

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.

delete_variant_store(client, name, input, options \\ [])

Deletes a variant store.

delete_workflow(client, id, input, options \\ [])

Deletes a workflow.

get_annotation_import_job(client, job_id, options \\ [])

Gets information about an annotation import job.

get_annotation_store(client, name, options \\ [])

Gets information about an annotation store.

get_annotation_store_version(client, name, version_name, options \\ [])

Retrieves the metadata for an annotation store version.

get_read_set(client, id, sequence_store_id, file \\ nil, part_number, options \\ [])

Gets a file from a read set.

get_read_set_activation_job(client, id, sequence_store_id, options \\ [])

Gets information about a read set activation job.

get_read_set_export_job(client, id, sequence_store_id, options \\ [])

Gets information about a read set export job.

get_read_set_import_job(client, id, sequence_store_id, options \\ [])

Gets information about a read set import job.

get_read_set_metadata(client, id, sequence_store_id, options \\ [])

Gets details about a read set.

get_reference(client, id, reference_store_id, file \\ nil, part_number, range \\ nil, options \\ [])

Gets a reference file.

get_reference_import_job(client, id, reference_store_id, options \\ [])

Gets information about a reference import job.

get_reference_metadata(client, id, reference_store_id, options \\ [])

Gets information about a genome reference's metadata.

get_reference_store(client, id, options \\ [])

Gets information about a reference store.

get_run(client, id, export \\ nil, options \\ [])

Gets information about a workflow run.

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

HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide.

get_run_cache(client, id, options \\ [])

Retrieve the details for the specified run cache.

For more information, see Call caching for HealthOmics runs in the AWS HealthOmics User Guide.

get_run_group(client, id, options \\ [])

Gets information about a workflow run group.

get_run_task(client, id, task_id, options \\ [])

Gets information about a workflow run task.

get_s3_access_policy(client, s3_access_point_arn, options \\ [])

Retrieves details about an access policy on a given store.

get_sequence_store(client, id, options \\ [])

Gets information about a sequence store.

get_share(client, share_id, options \\ [])

Retrieves the metadata for the specified resource share.

get_variant_import_job(client, job_id, options \\ [])

Gets information about a variant import job.

get_variant_store(client, name, options \\ [])

Gets information about a variant store.

get_workflow(client, id, export \\ nil, type \\ nil, workflow_owner_id \\ nil, options \\ [])

Gets information about a workflow.

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

list_annotation_import_jobs(client, input, options \\ [])

Retrieves a list of annotation import jobs.

list_annotation_store_versions(client, name, input, options \\ [])

Lists the versions of an annotation store.

list_annotation_stores(client, input, options \\ [])

Retrieves a list of annotation stores.

list_multipart_read_set_uploads(client, sequence_store_id, input, options \\ [])

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.

list_read_set_activation_jobs(client, sequence_store_id, input, options \\ [])

Retrieves a list of read set activation jobs.

list_read_set_export_jobs(client, sequence_store_id, input, options \\ [])

Retrieves a list of read set export jobs.

list_read_set_import_jobs(client, sequence_store_id, input, options \\ [])

Retrieves a list of read set import jobs.

list_read_set_upload_parts(client, sequence_store_id, upload_id, input, options \\ [])

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

list_read_sets(client, sequence_store_id, input, options \\ [])

Retrieves a list of read sets.

list_reference_import_jobs(client, reference_store_id, input, options \\ [])

Retrieves a list of reference import jobs.

list_reference_stores(client, input, options \\ [])

Retrieves a list of reference stores.

list_references(client, reference_store_id, input, options \\ [])

Retrieves a list of references.

list_run_caches(client, max_results \\ nil, starting_token \\ nil, options \\ [])

Retrieves a list of your run caches.

list_run_groups(client, max_results \\ nil, name \\ nil, starting_token \\ nil, options \\ [])

Retrieves a list of run groups.

list_run_tasks(client, id, max_results \\ nil, starting_token \\ nil, status \\ nil, options \\ [])

Retrieves a list of tasks for a run.

list_runs(client, max_results \\ nil, name \\ nil, run_group_id \\ nil, starting_token \\ nil, status \\ nil, options \\ [])

Retrieves a list of runs.

HealthOmics stores a fixed number of runs that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide.

list_sequence_stores(client, input, options \\ [])

Retrieves a list of sequence stores.

list_shares(client, input, options \\ [])

Retrieves the resource shares associated with an account.

Use the filter parameter to retrieve a specific subset of the shares.

list_tags_for_resource(client, resource_arn, options \\ [])

Retrieves a list of tags for a resource.

list_variant_import_jobs(client, input, options \\ [])

Retrieves a list of variant import jobs.

list_variant_stores(client, input, options \\ [])

Retrieves a list of variant stores.

list_workflows(client, max_results \\ nil, name \\ nil, starting_token \\ nil, type \\ nil, options \\ [])

Retrieves a list of workflows.

metadata()

put_s3_access_policy(client, s3_access_point_arn, input, options \\ [])

Adds an access policy to the specified store.

start_annotation_import_job(client, input, options \\ [])

Starts an annotation import job.

start_read_set_activation_job(client, sequence_store_id, input, options \\ [])

Activates an archived read set.

To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

start_read_set_export_job(client, sequence_store_id, input, options \\ [])

Exports a read set to Amazon S3.

start_read_set_import_job(client, sequence_store_id, input, options \\ [])

Starts a read set import job.

start_reference_import_job(client, reference_store_id, input, options \\ [])

Starts a reference import job.

start_run(client, input, options \\ [])

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.

HealthOmics stores a fixed number of runs that are available to the console and API. By default, HealthOmics doesn't any remove any runs. If HealthOmics reaches the maximum number of runs, you must manually remove runs. To have older runs removed automatically, set the retention mode to REMOVE.

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.

start_variant_import_job(client, input, options \\ [])

Starts a variant import job.

tag_resource(client, resource_arn, input, options \\ [])

Tags a resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from a resource.

update_annotation_store(client, name, input, options \\ [])

Updates an annotation store.

update_annotation_store_version(client, name, version_name, input, options \\ [])

Updates the description of an annotation store version.

update_run_cache(client, id, input, options \\ [])

Update a run cache.

update_run_group(client, id, input, options \\ [])

Updates a run group.

update_sequence_store(client, id, input, options \\ [])

Update one or more parameters for the sequence store.

update_variant_store(client, name, input, options \\ [])

Updates a variant store.

update_workflow(client, id, input, options \\ [])

Updates a workflow.

upload_read_set_part(client, sequence_store_id, upload_id, input, options \\ [])

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.

Settings View Source AWS.Omics (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

abort_multipart_read_set_upload(client, sequence_store_id, upload_id, input, options \\ [])

accept_share(client, share_id, input, options \\ [])

batch_delete_read_set(client, sequence_store_id, input, options \\ [])

cancel_annotation_import_job(client, job_id, input, options \\ [])

cancel_run(client, id, input, options \\ [])

cancel_variant_import_job(client, job_id, input, options \\ [])

complete_multipart_read_set_upload(client, sequence_store_id, upload_id, input, options \\ [])

create_annotation_store(client, input, options \\ [])

create_annotation_store_version(client, name, input, options \\ [])

create_multipart_read_set_upload(client, sequence_store_id, input, options \\ [])

create_reference_store(client, input, options \\ [])

create_run_cache(client, input, options \\ [])