View Source AWS.Omics (aws-elixir v1.0.7)
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.
You can create a run cache to save the task outputs from completed tasks in a run for a private workflow.
You can optionally create a run group to limit the compute resources for the runs that you add to the group.
Creates a sequence store.
Creates a cross-account shared resource.
Creates a variant store.
Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow
Creates a new workflow version for the workflow that you specify with the
workflowId
parameter.
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.
Delete a run cache.
Deletes a workflow run group.
Deletes an access policy for the specified store.
Deletes a sequence store.
Deletes a resource share.
Deletes a variant store.
Deletes a workflow.
Deletes a workflow version.
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.
Retrieve the details for the specified run cache.
Gets information about a workflow run group.
Gets information about a workflow run task.
Retrieves details about an access policy on a given store.
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.
Gets information about a workflow version.
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 your run caches.
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.
Lists the workflow versions for the specified workflow.
Retrieves a list of workflows.
Adds an access policy to the specified store.
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 new run or duplicates an existing 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.
Update a run cache.
Updates a run group.
Update one or more parameters for the sequence store.
Updates a variant store.
Updates information about a workflow.
Updates information about the workflow version.
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.
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).
For more information, see Creating a run cache in the Amazon Web Services HealthOmics User Guide.
You can optionally create a run group to limit the compute resources for the runs that you add to the group.
Creates a sequence store.
Creates a variant store.
Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:
Input data: Input data for the workflow, stored in an S3 bucket or a Amazon Web Services HealthOmics sequence store.
Workflow definition files: Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements.
Parameter template files: Define run parameters using a parameter template file (written in JSON).
ECR container images: Create one or more container images for the workflow. Store the images in a private ECR repository.
(Optional) Sentieon licenses: Request a Sentieon license if you plan to use Sentieon software in a private workflow.
For more information, see Creating or updating a private workflow in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
create_workflow_version(client, workflow_id, input, options \\ [])
View SourceCreates a new workflow version for the workflow that you specify with the
workflowId
parameter.
When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
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.
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 Amazon Web Services HealthOmics User Guide.
Deletes a workflow run group.
delete_s3_access_policy(client, s3_access_point_arn, input, options \\ [])
View SourceDeletes an access policy for the specified store.
Deletes a sequence store.
Deletes a variant store.
Deletes a workflow.
delete_workflow_version(client, version_name, workflow_id, input, options \\ [])
View SourceDeletes a workflow version.
Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
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.
Amazon Web Services 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 in the Amazon Web Services HealthOmics User Guide.
Retrieve the details for the specified run cache.
For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.
Gets information about a workflow run group.
Gets information about a workflow run task.
Retrieves details about an access policy on a given store.
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.
get_workflow_version(client, version_name, workflow_id, export \\ nil, type \\ nil, workflow_owner_id \\ nil, options \\ [])
View SourceGets information about a workflow version.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
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_caches(client, max_results \\ nil, starting_token \\ nil, options \\ [])
View SourceRetrieves a list of your run caches.
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.
Amazon Web Services 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 Amazon Web Services HealthOmics User Guide.
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_workflow_versions(client, workflow_id, max_results \\ nil, starting_token \\ nil, type \\ nil, workflow_owner_id \\ nil, options \\ [])
View SourceLists 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.
list_workflows(client, max_results \\ nil, name \\ nil, starting_token \\ nil, type \\ nil, options \\ [])
View SourceRetrieves a list of workflows.
put_s3_access_policy(client, s3_access_point_arn, input, options \\ [])
View SourceAdds an access policy to the specified store.
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 new run or duplicates an existing run.
For a new run, specify a unique requestId
, the workflowId
, and a role ARN.
If you're using static run storage (the default), specify the required
storageCapacity
.
You duplicate a run by specifing a unique requestId
, the runID
of the run to
duplicate, and a role ARN.
For more information about the optional parameters in the StartRun request, see Starting a run in the Amazon Web Services 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.
Update a run cache.
Updates a run group.
Update one or more parameters for the sequence store.
Updates a variant store.
Updates information about a workflow.
For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.
update_workflow_version(client, version_name, workflow_id, input, options \\ [])
View SourceUpdates information about the workflow version.
For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
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.