View Source AWS.Omics (aws-elixir v1.0.2)
This is the AWS HealthOmics API Reference.
For an introduction to the service, see What is AWS HealthOmics? in the AWS HealthOmics User Guide.
Link to this section Summary
Functions
Stops a multipart upload.
Accept a resource share request.
Deletes one or more read sets.
Cancels an annotation import job.
Cancels a run.
Cancels a variant import job.
Concludes a multipart upload once you have uploaded all the components.
Creates an annotation store.
Creates a new version of an annotation store.
Begins a multipart read set upload.
Creates a reference store.
Creates a run group.
Creates a sequence store.
Creates a cross-account shared resource.
Creates a variant store.
Creates a workflow.
Deletes an annotation store.
Deletes one or multiple versions of an annotation store.
Deletes a genome reference.
Deletes a genome reference store.
Deletes a workflow run.
Deletes a workflow run group.
Deletes a sequence store.
Deletes a resource share.
Deletes a variant store.
Deletes a workflow.
Gets information about an annotation import job.
Gets information about an annotation store.
Retrieves the metadata for an annotation store version.
Gets a file from a read set.
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 details about a read set.
Gets a reference file.
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 the specified resource share.
Gets information about a variant import job.
Gets information about a variant store.
Gets information about a workflow.
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.
Retrieves a list of read set activation jobs.
Retrieves a list of read set export jobs.
Retrieves a list of read set import jobs.
This operation will list all parts in a requested multipart upload for a sequence store.
Retrieves a list of read sets.
Retrieves a list of reference import jobs.
Retrieves a list of reference stores.
Retrieves a list of references.
Retrieves a list of run groups.
Retrieves a list of tasks for a run.
Retrieves a list of runs.
Retrieves a list of sequence stores.
Retrieves the resource 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.
Retrieves a list of workflows.
Starts an annotation import job.
Activates an archived read set.
Exports a read set to Amazon S3.
Starts a read set import job.
Starts a reference import job.
Starts a workflow run.
Starts a variant import job.
Tags a resource.
Removes tags from a resource.
Updates an annotation store.
Updates the description of an annotation store version.
Updates a run group.
Updates a variant store.
Updates a workflow.
This operation uploads a specific part of a read set.
Link to this section Functions
abort_multipart_read_set_upload(client, sequence_store_id, upload_id, input, options \\ [])
View SourceStops a multipart upload.
batch_delete_read_set(client, sequence_store_id, input, options \\ [])
View SourceDeletes one or more read sets.
cancel_annotation_import_job(client, job_id, input, options \\ [])
View SourceCancels an annotation import job.
Cancels a run.
Cancels a variant import job.
complete_multipart_read_set_upload(client, sequence_store_id, upload_id, input, options \\ [])
View SourceConcludes a multipart upload once you have uploaded all the components.
Creates an annotation store.
create_annotation_store_version(client, name, input, options \\ [])
View SourceCreates a new version of an annotation store.
create_multipart_read_set_upload(client, sequence_store_id, input, options \\ [])
View SourceBegins a multipart read set upload.
Creates a reference store.
Creates a run group.
Creates a sequence store.
Creates a variant store.
Creates a workflow.
Deletes an annotation store.
delete_annotation_store_versions(client, name, input, options \\ [])
View SourceDeletes one or multiple versions of an annotation store.
delete_reference(client, id, reference_store_id, input, options \\ [])
View SourceDeletes a genome reference.
Deletes a genome reference store.
Deletes a workflow run.
Deletes a workflow run group.
Deletes a sequence store.
Deletes a variant store.
Deletes a workflow.
Gets information about an annotation import job.
Gets information about an annotation store.
get_annotation_store_version(client, name, version_name, options \\ [])
View SourceRetrieves the metadata for an annotation store version.
get_read_set(client, id, sequence_store_id, file \\ nil, part_number, options \\ [])
View SourceGets a file from a read set.
get_read_set_activation_job(client, id, sequence_store_id, options \\ [])
View SourceGets information about a read set activation job.
get_read_set_export_job(client, id, sequence_store_id, options \\ [])
View SourceGets information about a read set export job.
get_read_set_import_job(client, id, sequence_store_id, options \\ [])
View SourceGets information about a read set import job.
get_read_set_metadata(client, id, sequence_store_id, options \\ [])
View SourceGets details about a read set.
get_reference(client, id, reference_store_id, file \\ nil, part_number, range \\ nil, options \\ [])
View SourceGets a reference file.
get_reference_import_job(client, id, reference_store_id, options \\ [])
View SourceGets information about a reference import job.
get_reference_metadata(client, id, reference_store_id, options \\ [])
View SourceGets information about a genome reference's metadata.
Gets information about a reference store.
Gets information about a workflow run.
If a workflow is shared with you, you cannot export information about the run.
Gets information about a workflow run group.
Gets information about a workflow run task.
Gets information about a sequence store.
Gets information about a variant import job.
Gets information about a variant store.
get_workflow(client, id, export \\ nil, type \\ nil, workflow_owner_id \\ nil, options \\ [])
View SourceGets information about a workflow.
If a workflow is shared with you, you cannot export the workflow.
Retrieves a list of annotation import jobs.
list_annotation_store_versions(client, name, input, options \\ [])
View SourceLists the versions of an annotation store.
Retrieves a list of annotation stores.
list_multipart_read_set_uploads(client, sequence_store_id, input, options \\ [])
View SourceLists 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 \\ [])
View SourceRetrieves a list of read set activation jobs.
list_read_set_export_jobs(client, sequence_store_id, input, options \\ [])
View SourceRetrieves a list of read set export jobs.
list_read_set_import_jobs(client, sequence_store_id, input, options \\ [])
View SourceRetrieves a list of read set import jobs.
list_read_set_upload_parts(client, sequence_store_id, upload_id, input, options \\ [])
View SourceThis operation will list all parts in a requested multipart upload for a sequence store.
Retrieves a list of read sets.
list_reference_import_jobs(client, reference_store_id, input, options \\ [])
View SourceRetrieves a list of reference import jobs.
Retrieves a list of reference stores.
Retrieves a list of references.
list_run_groups(client, max_results \\ nil, name \\ nil, starting_token \\ nil, options \\ [])
View SourceRetrieves a list of run groups.
list_run_tasks(client, id, max_results \\ nil, starting_token \\ nil, status \\ nil, options \\ [])
View SourceRetrieves 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 \\ [])
View SourceRetrieves a list of runs.
Retrieves a list of sequence stores.
Retrieves a list of tags for a resource.
Retrieves a list of variant import jobs.
Retrieves a list of variant stores.
list_workflows(client, max_results \\ nil, name \\ nil, starting_token \\ nil, type \\ nil, options \\ [])
View SourceRetrieves a list of workflows.
Starts an annotation import job.
start_read_set_activation_job(client, sequence_store_id, input, options \\ [])
View SourceActivates 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 \\ [])
View SourceExports a read set to Amazon S3.
start_read_set_import_job(client, sequence_store_id, input, options \\ [])
View SourceStarts a read set import job.
start_reference_import_job(client, reference_store_id, input, options \\ [])
View SourceStarts a reference import job.
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.
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.
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.
Starts a variant import job.
Tags a resource.
Removes tags from a resource.
Updates an annotation store.
update_annotation_store_version(client, name, version_name, input, options \\ [])
View SourceUpdates the description of an annotation store version.
Updates a run group.
Updates a variant store.
Updates a workflow.
upload_read_set_part(client, sequence_store_id, upload_id, input, options \\ [])
View SourceThis 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.