Omics

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.

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.

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.
• "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.
• "sseConfig": Server-side encryption (SSE) settings for the store.
• "tags": Tags for the store.

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:

• "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": A storage capacity for the workflow in gigabytes.
• "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_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_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_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.

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 task's 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_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.

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.

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": Specify 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_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_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.

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_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": The workflows' name.
• "startingToken": Specify the pagination token from a previous request to retrieve the next page of results.
• "type": The workflows' 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:

• "formatOptions": Formatting options for the annotation file.
• "runLeftNormalization": The job's left normalization setting.

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 run.

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.
• "runGroupId": The run's group ID.
• "runId": The run's ID.
• "storageCapacity": A storage capacity for the run in gigabytes.
• "tags": Tags for the run.
• "workflowId": The run's workflow ID.
• "workflowType": The run's workflows 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:

• "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_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.
• "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.