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

This is the AWS HealthOmics API Reference.

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

Summary

Functions

Accepts a share for an analytics store.

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

Creates a new version of an annotation store.

Creates a share offer that can be accepted outside the account by a subscriber.

Deletes one or multiple versions of an annotation store.

Deletes a share of an analytics store.

Gets information about an annotation import job.

Gets information about an annotation store.

Retrieves the metadata for an annotation store version.

Gets information about a read set activation job.

Gets information about a read set export job.

Gets information about a read set import job.

Gets information about a reference import job.

Gets information about a genome reference's metadata.

Gets information about a reference store.

Gets information about a workflow run.

Gets information about a workflow run group.

Gets information about a workflow run task.

Gets information about a sequence store.

Retrieves the metadata for a share.

Gets information about a variant import job.

Gets information about a variant store.

Retrieves a list of annotation import jobs.

Lists the versions of an annotation store.

Retrieves a list of annotation stores.

Lists multipart read set uploads and for in progress uploads.

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

Retrieves a list of reference stores.

Retrieves a list of sequence stores.

Lists all shares associated with an account.

Retrieves a list of tags for a resource.

Retrieves a list of variant import jobs.

Retrieves a list of variant stores.

Updates the description of an annotation store version.

This operation uploads a specific part of a read set.

Functions

Link to this function

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

View Source

Stops a multipart upload.

Link to this function

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

View Source

Accepts a share for an analytics store.

Link to this function

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

View Source

Deletes one or more read sets.

Link to this function

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

View Source

Cancels an annotation import job.

Link to this function

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

View Source

Cancels a run.

Link to this function

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

View Source

Cancels a variant import job.

Link to this function

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

View Source

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

Link to this function

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

View Source

Creates an annotation store.

Link to this function

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

View Source

Creates a new version of an annotation store.

Link to this function

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

View Source

Begins a multipart read set upload.

Link to this function

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

View Source

Creates a reference store.

Link to this function

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

View Source

Creates a run group.

Link to this function

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

View Source

Creates a sequence store.

Link to this function

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

View Source

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 to this function

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

View Source

Creates a variant store.

Link to this function

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

View Source

Creates a workflow.

Link to this function

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

View Source

Deletes an annotation store.

Link to this function

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

View Source

Deletes one or multiple versions of an annotation store.

Link to this function

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

View Source

Deletes a genome reference.

Link to this function

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

View Source

Deletes a genome reference store.

Link to this function

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

View Source

Deletes a workflow run.

Link to this function

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

View Source

Deletes a workflow run group.

Link to this function

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

View Source

Deletes a sequence store.

Link to this function

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

View Source

Deletes a share of an analytics store.

Link to this function

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

View Source

Deletes a variant store.

Link to this function

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

View Source

Deletes a workflow.

Link to this function

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

View Source

Gets information about an annotation import job.

Link to this function

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

View Source

Gets information about an annotation store.

Link to this function

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

View Source

Retrieves the metadata for an annotation store version.

Link to this function

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

View Source

Gets a file from a read set.

Link to this function

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

View Source

Gets information about a read set activation job.

Link to this function

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

View Source

Gets information about a read set export job.

Link to this function

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

View Source

Gets information about a read set import job.

Link to this function

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

View Source

Gets details about a read set.

Link to this function

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

View Source

Gets a reference file.

Link to this function

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

View Source

Gets information about a reference import job.

Link to this function

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

View Source

Gets information about a genome reference's metadata.

Link to this function

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

View Source

Gets information about a reference store.

Link to this function

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

View Source

Gets information about a workflow run.

Link to this function

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

View Source

Gets information about a workflow run group.

Link to this function

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

View Source

Gets information about a workflow run task.

Link to this function

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

View Source

Gets information about a sequence store.

Link to this function

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

View Source

Retrieves the metadata for a share.

Link to this function

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

View Source

Gets information about a variant import job.

Link to this function

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

View Source

Gets information about a variant store.

Link to this function

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

View Source

Gets information about a workflow.

Link to this function

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

View Source

Retrieves a list of annotation import jobs.

Link to this function

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

View Source

Lists the versions of an annotation store.

Link to this function

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

View Source

Retrieves a list of annotation stores.

Link to this function

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

View Source

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 to this function

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

View Source

Retrieves a list of read set activation jobs.

Link to this function

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

View Source

Retrieves a list of read set export jobs.

Link to this function

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

View Source

Retrieves a list of read set import jobs.

Link to this function

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

View Source

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

Link to this function

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

View Source

Retrieves a list of read sets.

Link to this function

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

View Source

Retrieves a list of reference import jobs.

Link to this function

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

View Source

Retrieves a list of reference stores.

Link to this function

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

View Source

Retrieves a list of references.

Link to this function

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

View Source

Retrieves a list of run groups.

Link to this function

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

View Source

Retrieves a list of tasks for a run.

Link to this function

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

View Source

Retrieves a list of runs.

Link to this function

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

View Source

Retrieves a list of sequence stores.

Link to this function

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

View Source

Lists all shares associated with an account.

Link to this function

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

View Source

Retrieves a list of tags for a resource.

Link to this function

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

View Source

Retrieves a list of variant import jobs.

Link to this function

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

View Source

Retrieves a list of variant stores.

Link to this function

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

View Source

Retrieves a list of workflows.

Link to this function

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

View Source

Starts an annotation import job.

Link to this function

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

View Source

Activates an archived read set.

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

Link to this function

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

View Source

Exports a read set to Amazon S3.

Link to this function

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

View Source

Starts a read set import job.

Link to this function

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

View Source

Starts a reference import job.

Link to this function

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

View Source

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.

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.

Link to this function

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

View Source

Starts a variant import job.

Link to this function

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

View Source

Tags a resource.

Link to this function

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

View Source

Removes tags from a resource.

Link to this function

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

View Source

Updates an annotation store.

Link to this function

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

View Source

Updates the description of an annotation store version.

Link to this function

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

View Source

Updates a run group.

Link to this function

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

View Source

Updates a variant store.

Link to this function

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

View Source

Updates a workflow.

Link to this function

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

View Source

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.