Omics

abort_multipart_read_set_upload(sequence_store_id, upload_id)
abort_multipart_read_set_upload(sequence_store_id, upload_id, params::Dict{String,<:Any})

Stops a multipart upload.

Arguments

• sequence_store_id: The sequence store ID for the store involved in the multipart upload.
• upload_id: The ID for the multipart upload.

accept_share(share_id)
accept_share(share_id, params::Dict{String,<:Any})

Accept a resource share request.

Arguments

• share_id: The ID of the resource share.

batch_delete_read_set(ids, sequence_store_id)
batch_delete_read_set(ids, sequence_store_id, params::Dict{String,<:Any})

Deletes one or more read sets.

Arguments

• ids: The read sets' IDs.
• sequence_store_id: The read sets' sequence store ID.

cancel_annotation_import_job(job_id)
cancel_annotation_import_job(job_id, params::Dict{String,<:Any})

Cancels an annotation import job.

Arguments

• job_id: The job's ID.

cancel_run(id)
cancel_run(id, params::Dict{String,<:Any})

Cancels a run.

Arguments

• id: The run's ID.

cancel_variant_import_job(job_id)
cancel_variant_import_job(job_id, params::Dict{String,<:Any})

Cancels a variant import job.

Arguments

• job_id: The job's ID.

complete_multipart_read_set_upload(parts, sequence_store_id, upload_id)
complete_multipart_read_set_upload(parts, sequence_store_id, upload_id, params::Dict{String,<:Any})

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

Arguments

• parts: The individual uploads or parts of a multipart upload.
• sequence_store_id: The sequence store ID for the store involved in the multipart upload.
• upload_id: The ID for the multipart upload.

create_annotation_store(store_format)
create_annotation_store(store_format, params::Dict{String,<:Any})

Creates an annotation store.

Arguments

• store_format: The annotation file format of the store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description for the store.
• "name": A name for the store.
• "reference": The genome reference for the store's annotations.
• "sseConfig": Server-side encryption (SSE) settings for the store.
• "storeOptions": File parsing options for the annotation store.
• "tags": Tags for the store.
• "versionName": The name given to an annotation store version to distinguish it from other versions.

create_annotation_store_version(name, version_name)
create_annotation_store_version(name, version_name, params::Dict{String,<:Any})

Creates a new version of an annotation store.

Arguments

• name: The name of an annotation store version from which versions are being created.
• version_name: The name given to an annotation store version to distinguish it from other versions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of an annotation store version.
• "tags": Any tags added to annotation store version.
• "versionOptions": The options for an annotation store version.

create_multipart_read_set_upload(name, sample_id, sequence_store_id, source_file_type, subject_id)
create_multipart_read_set_upload(name, sample_id, sequence_store_id, source_file_type, subject_id, params::Dict{String,<:Any})

Begins a multipart read set upload.

Arguments

• name: The name of the read set.
• sample_id: The source's sample ID.
• sequence_store_id: The sequence store ID for the store that is the destination of the multipart uploads.
• source_file_type: The type of file being uploaded.
• subject_id: The source's subject ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": An idempotency token that can be used to avoid triggering multiple multipart uploads.
• "description": The description of the read set.
• "generatedFrom": Where the source originated.
• "referenceArn": The ARN of the reference.
• "tags": Any tags to add to the read set.

create_reference_store(name)
create_reference_store(name, params::Dict{String,<:Any})

Creates a reference store.

Arguments

• name: A name for the store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that requests don't run multiple times, specify a unique token for each request.
• "description": A description for the store.
• "sseConfig": Server-side encryption (SSE) settings for the store.
• "tags": Tags for the store.

create_run_group(request_id)
create_run_group(request_id, params::Dict{String,<:Any})

Creates a run group.

Arguments

• request_id: To ensure that requests don't run multiple times, specify a unique ID for each request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxCpus": The maximum number of CPUs to use in the group.
• "maxDuration": A maximum run time for the group in minutes.
• "maxGpus": The maximum GPUs that can be used by a run group.
• "maxRuns": The maximum number of concurrent runs for the group.
• "name": A name for the group.
• "tags": Tags for the group.

create_sequence_store(name)
create_sequence_store(name, params::Dict{String,<:Any})

Creates a sequence store.

Arguments

• name: A name for the store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that requests don't run multiple times, specify a unique token for each request.
• "description": A description for the store.
• "eTagAlgorithmFamily": The ETag algorithm family to use for ingested read sets.
• "fallbackLocation": An S3 location that is used to store files that have failed a direct upload.
• "sseConfig": Server-side encryption (SSE) settings for the store.
• "tags": Tags for the store.

create_share(principal_subscriber, resource_arn)
create_share(principal_subscriber, resource_arn, params::Dict{String,<:Any})

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

Arguments

• principal_subscriber: The principal subscriber is the account being offered shared access to the resource.
• resource_arn: The ARN of the resource to be shared.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "shareName": A name that the owner defines for the share.

create_variant_store(reference)
create_variant_store(reference, params::Dict{String,<:Any})

Creates a variant store.

Arguments

• reference: The genome reference for the store's variants.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description for the store.
• "name": A name for the store.
• "sseConfig": Server-side encryption (SSE) settings for the store.
• "tags": Tags for the store.

create_workflow(request_id)
create_workflow(request_id, params::Dict{String,<:Any})

Creates a workflow.

Arguments

• request_id: To ensure that requests don't run multiple times, specify a unique ID for each request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "accelerators": The computational accelerator specified to run the workflow.
• "definitionUri": The URI of a definition for the workflow.
• "definitionZip": A ZIP archive for the workflow.
• "description": A description for the workflow.
• "engine": An engine for the workflow.
• "main": The path of the main definition file for the workflow.
• "name": A name for the workflow.
• "parameterTemplate": A parameter template for the workflow.
• "storageCapacity": The storage capacity for the workflow in gibibytes.
• "tags": Tags for the workflow.

delete_annotation_store(name)
delete_annotation_store(name, params::Dict{String,<:Any})

Deletes an annotation store.

Arguments

• name: The store's name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "force": Whether to force deletion.

delete_annotation_store_versions(name, versions)
delete_annotation_store_versions(name, versions, params::Dict{String,<:Any})

Deletes one or multiple versions of an annotation store.

Arguments

• name: The name of the annotation store from which versions are being deleted.
• versions: The versions of an annotation store to be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "force": Forces the deletion of an annotation store version when imports are in-progress..

delete_reference(id, reference_store_id)
delete_reference(id, reference_store_id, params::Dict{String,<:Any})

Deletes a genome reference.

Arguments

• id: The reference's ID.
• reference_store_id: The reference's store ID.

delete_reference_store(id)
delete_reference_store(id, params::Dict{String,<:Any})

Deletes a genome reference store.

Arguments

• id: The store's ID.

delete_run(id)
delete_run(id, params::Dict{String,<:Any})

Deletes a workflow run.

Arguments

• id: The run's ID.

delete_run_group(id)
delete_run_group(id, params::Dict{String,<:Any})

Deletes a workflow run group.

Arguments

• id: The run group's ID.

delete_sequence_store(id)
delete_sequence_store(id, params::Dict{String,<:Any})

Deletes a sequence store.

Arguments

• id: The sequence store's ID.

delete_share(share_id)
delete_share(share_id, params::Dict{String,<:Any})

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.

Arguments

• share_id: The ID for the resource share to be deleted.

delete_variant_store(name)
delete_variant_store(name, params::Dict{String,<:Any})

Deletes a variant store.

Arguments

• name: The store's name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "force": Whether to force deletion.

delete_workflow(id)
delete_workflow(id, params::Dict{String,<:Any})

Deletes a workflow.

Arguments

• id: The workflow's ID.

get_annotation_import_job(job_id)
get_annotation_import_job(job_id, params::Dict{String,<:Any})

Gets information about an annotation import job.

Arguments

• job_id: The job's ID.

get_annotation_store(name)
get_annotation_store(name, params::Dict{String,<:Any})

Gets information about an annotation store.

Arguments

• name: The store's name.

get_annotation_store_version(name, version_name)
get_annotation_store_version(name, version_name, params::Dict{String,<:Any})

Retrieves the metadata for an annotation store version.

Arguments

• name: The name given to an annotation store version to distinguish it from others.
• version_name: The name given to an annotation store version to distinguish it from others.

get_read_set(id, part_number, sequence_store_id)
get_read_set(id, part_number, sequence_store_id, params::Dict{String,<:Any})

Gets a file from a read set.

Arguments

• id: The read set's ID.
• part_number: The part number to retrieve.
• sequence_store_id: The read set's sequence store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "file": The file to retrieve.

get_read_set_activation_job(id, sequence_store_id)
get_read_set_activation_job(id, sequence_store_id, params::Dict{String,<:Any})

Gets information about a read set activation job.

Arguments

• id: The job's ID.
• sequence_store_id: The job's sequence store ID.

get_read_set_export_job(id, sequence_store_id)
get_read_set_export_job(id, sequence_store_id, params::Dict{String,<:Any})

Gets information about a read set export job.

Arguments

• id: The job's ID.
• sequence_store_id: The job's sequence store ID.

get_read_set_import_job(id, sequence_store_id)
get_read_set_import_job(id, sequence_store_id, params::Dict{String,<:Any})

Gets information about a read set import job.

Arguments

• id: The job's ID.
• sequence_store_id: The job's sequence store ID.

get_read_set_metadata(id, sequence_store_id)
get_read_set_metadata(id, sequence_store_id, params::Dict{String,<:Any})

Gets details about a read set.

Arguments

• id: The read set's ID.
• sequence_store_id: The read set's sequence store ID.

get_reference(id, part_number, reference_store_id)
get_reference(id, part_number, reference_store_id, params::Dict{String,<:Any})

Gets a reference file.

Arguments

• id: The reference's ID.
• part_number: The part number to retrieve.
• reference_store_id: The reference's store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Range": The range to retrieve.
• "file": The file to retrieve.

get_reference_import_job(id, reference_store_id)
get_reference_import_job(id, reference_store_id, params::Dict{String,<:Any})

Gets information about a reference import job.

Arguments

• id: The job's ID.
• reference_store_id: The job's reference store ID.

get_reference_metadata(id, reference_store_id)
get_reference_metadata(id, reference_store_id, params::Dict{String,<:Any})

Gets information about a genome reference's metadata.

Arguments

• id: The reference's ID.
• reference_store_id: The reference's reference store ID.

get_reference_store(id)
get_reference_store(id, params::Dict{String,<:Any})

Gets information about a reference store.

Arguments

• id: The store's ID.

get_run(id)
get_run(id, params::Dict{String,<:Any})

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

Arguments

• id: The run's ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "export": The run's export format.

get_run_group(id)
get_run_group(id, params::Dict{String,<:Any})

Gets information about a workflow run group.

Arguments

• id: The group's ID.

get_run_task(id, task_id)
get_run_task(id, task_id, params::Dict{String,<:Any})

Gets information about a workflow run task.

Arguments

• id: The workflow run ID.
• task_id: The task's ID.

get_sequence_store(id)
get_sequence_store(id, params::Dict{String,<:Any})

Gets information about a sequence store.

Arguments

• id: The store's ID.

get_share(share_id)
get_share(share_id, params::Dict{String,<:Any})

Retrieves the metadata for the specified resource share.

Arguments

• share_id: The ID of the share.

get_variant_import_job(job_id)
get_variant_import_job(job_id, params::Dict{String,<:Any})

Gets information about a variant import job.

Arguments

• job_id: The job's ID.

get_variant_store(name)
get_variant_store(name, params::Dict{String,<:Any})

Gets information about a variant store.

Arguments

• name: The store's name.

get_workflow(id)
get_workflow(id, params::Dict{String,<:Any})

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

Arguments

• id: The workflow's ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "export": The export format for the workflow.
• "type": The workflow's type.
• "workflowOwnerId": The ID of the workflow owner.

list_annotation_import_jobs()
list_annotation_import_jobs(params::Dict{String,<:Any})

Retrieves a list of annotation import jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "ids": IDs of annotation import jobs to retrieve.
• "maxResults": The maximum number of jobs to return in one page of results.
• "nextToken": Specifies the pagination token from a previous request to retrieve the next page of results.

list_annotation_store_versions(name)
list_annotation_store_versions(name, params::Dict{String,<:Any})

Lists the versions of an annotation store.

Arguments

• name: The name of an annotation store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list of annotation store versions.
• "maxResults": The maximum number of annotation store versions to return in one page of results.
• "nextToken": Specifies the pagination token from a previous request to retrieve the next page of results.

list_annotation_stores()
list_annotation_stores(params::Dict{String,<:Any})

Retrieves a list of annotation stores.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "ids": IDs of stores to list.
• "maxResults": The maximum number of stores to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_multipart_read_set_uploads(sequence_store_id)
list_multipart_read_set_uploads(sequence_store_id, params::Dict{String,<:Any})

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.

Arguments

• sequence_store_id: The Sequence Store ID used for the multipart uploads.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of multipart uploads returned in a page.
• "nextToken": Next token returned in the response of a previous ListMultipartReadSetUploads call. Used to get the next page of results.

list_read_set_activation_jobs(sequence_store_id)
list_read_set_activation_jobs(sequence_store_id, params::Dict{String,<:Any})

Retrieves a list of read set activation jobs.

Arguments

• sequence_store_id: The read set's sequence store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of read set activation jobs to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_read_set_export_jobs(sequence_store_id)
list_read_set_export_jobs(sequence_store_id, params::Dict{String,<:Any})

Retrieves a list of read set export jobs.

Arguments

• sequence_store_id: The jobs' sequence store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of jobs to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_read_set_import_jobs(sequence_store_id)
list_read_set_import_jobs(sequence_store_id, params::Dict{String,<:Any})

Retrieves a list of read set import jobs.

Arguments

• sequence_store_id: The jobs' sequence store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of jobs to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_read_set_upload_parts(part_source, sequence_store_id, upload_id)
list_read_set_upload_parts(part_source, sequence_store_id, upload_id, params::Dict{String,<:Any})

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

Arguments

• part_source: The source file for the upload part.
• sequence_store_id: The Sequence Store ID used for the multipart uploads.
• upload_id: The ID for the initiated multipart upload.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": Attributes used to filter for a specific subset of read set part uploads.
• "maxResults": The maximum number of read set upload parts returned in a page.
• "nextToken": Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

list_read_sets(sequence_store_id)
list_read_sets(sequence_store_id, params::Dict{String,<:Any})

Retrieves a list of read sets.

Arguments

• sequence_store_id: The jobs' sequence store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of read sets to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_reference_import_jobs(reference_store_id)
list_reference_import_jobs(reference_store_id, params::Dict{String,<:Any})

Retrieves a list of reference import jobs.

Arguments

• reference_store_id: The job's reference store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of jobs to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_reference_stores()
list_reference_stores(params::Dict{String,<:Any})

Retrieves a list of reference stores.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of stores to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_references(reference_store_id)
list_references(reference_store_id, params::Dict{String,<:Any})

Retrieves a list of references.

Arguments

• reference_store_id: The references' reference store ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of references to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_run_groups()
list_run_groups(params::Dict{String,<:Any})

Retrieves a list of run groups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of run groups to return in one page of results.
• "name": The run groups' name.
• "startingToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_run_tasks(id)
list_run_tasks(id, params::Dict{String,<:Any})

Retrieves a list of tasks for a run.

Arguments

• id: The run's ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of run tasks to return in one page of results.
• "startingToken": Specify the pagination token from a previous request to retrieve the next page of results.
• "status": Filter the list by status.

list_runs()
list_runs(params::Dict{String,<:Any})

Retrieves a list of runs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of runs to return in one page of results.
• "name": Filter the list by run name.
• "runGroupId": Filter the list by run group ID.
• "startingToken": Specify the pagination token from a previous request to retrieve the next page of results.
• "status": The status of a run.

list_sequence_stores()
list_sequence_stores(params::Dict{String,<:Any})

Retrieves a list of sequence stores.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "maxResults": The maximum number of stores to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_shares(resource_owner)
list_shares(resource_owner, params::Dict{String,<:Any})

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

Arguments

• resource_owner: The account that owns the resource shares.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": Attributes that you use to filter for a specific subset of resource shares.
• "maxResults": The maximum number of shares to return in one page of results.
• "nextToken": Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Retrieves a list of tags for a resource.

Arguments

• resource_arn: The resource's ARN.

list_variant_import_jobs()
list_variant_import_jobs(params::Dict{String,<:Any})

Retrieves a list of variant import jobs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "ids": A list of job IDs.
• "maxResults": The maximum number of import jobs to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_variant_stores()
list_variant_stores(params::Dict{String,<:Any})

Retrieves a list of variant stores.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filter": A filter to apply to the list.
• "ids": A list of store IDs.
• "maxResults": The maximum number of stores to return in one page of results.
• "nextToken": Specify the pagination token from a previous request to retrieve the next page of results.

list_workflows()
list_workflows(params::Dict{String,<:Any})

Retrieves a list of workflows.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": The maximum number of workflows to return in one page of results.
• "name": Filter the list by workflow name.
• "startingToken": Specify the pagination token from a previous request to retrieve the next page of results.
• "type": Filter the list by workflow type.

start_annotation_import_job(destination_name, items, role_arn)
start_annotation_import_job(destination_name, items, role_arn, params::Dict{String,<:Any})

Starts an annotation import job.

Arguments

• destination_name: A destination annotation store for the job.
• items: Items to import.
• role_arn: A service role for the job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "annotationFields": The annotation schema generated by the parsed annotation data.
• "formatOptions": Formatting options for the annotation file.
• "runLeftNormalization": The job's left normalization setting.
• "versionName": The name of the annotation store version.

start_read_set_activation_job(sequence_store_id, sources)
start_read_set_activation_job(sequence_store_id, sources, params::Dict{String,<:Any})

Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.

Arguments

• sequence_store_id: The read set's sequence store ID.
• sources: The job's source files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that jobs don't run multiple times, specify a unique token for each job.

start_read_set_export_job(destination, role_arn, sequence_store_id, sources)
start_read_set_export_job(destination, role_arn, sequence_store_id, sources, params::Dict{String,<:Any})

Exports a read set to Amazon S3.

Arguments

• destination: A location for exported files in Amazon S3.
• role_arn: A service role for the job.
• sequence_store_id: The read set's sequence store ID.
• sources: The job's source files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that jobs don't run multiple times, specify a unique token for each job.

start_read_set_import_job(role_arn, sequence_store_id, sources)
start_read_set_import_job(role_arn, sequence_store_id, sources, params::Dict{String,<:Any})

Starts a read set import job.

Arguments

• role_arn: A service role for the job.
• sequence_store_id: The read set's sequence store ID.
• sources: The job's source files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that jobs don't run multiple times, specify a unique token for each job.

start_reference_import_job(reference_store_id, role_arn, sources)
start_reference_import_job(reference_store_id, role_arn, sources, params::Dict{String,<:Any})

Starts a reference import job.

Arguments

• reference_store_id: The job's reference store ID.
• role_arn: A service role for the job.
• sources: The job's source files.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "clientToken": To ensure that jobs don't run multiple times, specify a unique token for each job.

start_run(request_id, role_arn)
start_run(request_id, role_arn, params::Dict{String,<:Any})

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.

Arguments

• request_id: To ensure that requests don't run multiple times, specify a unique ID for each request.
• role_arn: A service role for the run.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "logLevel": A log level for the run.
• "name": A name for the run.
• "outputUri": An output URI for the run.
• "parameters": Parameters for the run.
• "priority": A priority for the run.
• "retentionMode": The retention mode for the run.
• "runGroupId": The run's group ID.
• "runId": The ID of a run to duplicate.
• "storageCapacity": A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).
• "storageType": The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.
• "tags": Tags for the run.
• "workflowId": The run's workflow ID.
• "workflowOwnerId": The ID of the workflow owner.
• "workflowType": The run's workflow type.

start_variant_import_job(destination_name, items, role_arn)
start_variant_import_job(destination_name, items, role_arn, params::Dict{String,<:Any})

Starts a variant import job.

Arguments

• destination_name: The destination variant store for the job.
• items: Items to import.
• role_arn: A service role for the job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "annotationFields": The annotation schema generated by the parsed annotation data.
• "runLeftNormalization": The job's left normalization setting.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Tags a resource.

Arguments

• resource_arn: The resource's ARN.
• tags: Tags for the resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a resource.

Arguments

• resource_arn: The resource's ARN.
• tag_keys: Keys of tags to remove.

update_annotation_store(name)
update_annotation_store(name, params::Dict{String,<:Any})

Updates an annotation store.

Arguments

• name: A name for the store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description for the store.

update_annotation_store_version(name, version_name)
update_annotation_store_version(name, version_name, params::Dict{String,<:Any})

Updates the description of an annotation store version.

Arguments

• name: The name of an annotation store.
• version_name: The name of an annotation store version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of an annotation store.

update_run_group(id)
update_run_group(id, params::Dict{String,<:Any})

Updates a run group.

Arguments

• id: The group's ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxCpus": The maximum number of CPUs to use.
• "maxDuration": A maximum run time for the group in minutes.
• "maxGpus": The maximum GPUs that can be used by a run group.
• "maxRuns": The maximum number of concurrent runs for the group.
• "name": A name for the group.

update_variant_store(name)
update_variant_store(name, params::Dict{String,<:Any})

Updates a variant store.

Arguments

• name: A name for the store.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description for the store.

update_workflow(id)
update_workflow(id, params::Dict{String,<:Any})

Updates a workflow.

Arguments

• id: The workflow's ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description for the workflow.
• "name": A name for the workflow.

upload_read_set_part(part_number, part_source, payload, sequence_store_id, upload_id)
upload_read_set_part(part_number, part_source, payload, sequence_store_id, upload_id, params::Dict{String,<:Any})

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.

Arguments

• part_number: The number of the part being uploaded.
• part_source: The source file for an upload part.
• payload: The read set data to upload for a part.
• sequence_store_id: The Sequence Store ID used for the multipart upload.
• upload_id: The ID for the initiated multipart upload.