Class: Aws::Omics::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Omics::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb
Overview
An API client for Omics. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Omics::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
-
#accept_share(params = {}) ⇒ Types::AcceptShareResponse
Accept a resource share request.
-
#batch_delete_read_set(params = {}) ⇒ Types::BatchDeleteReadSetResponse
Deletes one or more read sets.
-
#cancel_annotation_import_job(params = {}) ⇒ Struct
Cancels an annotation import job.
-
#cancel_run(params = {}) ⇒ Struct
Cancels a run.
-
#cancel_variant_import_job(params = {}) ⇒ Struct
Cancels a variant import job.
-
#complete_multipart_read_set_upload(params = {}) ⇒ Types::CompleteMultipartReadSetUploadResponse
Concludes a multipart upload once you have uploaded all the components.
-
#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse
Creates an annotation store.
-
#create_annotation_store_version(params = {}) ⇒ Types::CreateAnnotationStoreVersionResponse
Creates a new version of an annotation store.
-
#create_multipart_read_set_upload(params = {}) ⇒ Types::CreateMultipartReadSetUploadResponse
Begins a multipart read set upload.
-
#create_reference_store(params = {}) ⇒ Types::CreateReferenceStoreResponse
Creates a reference store.
-
#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse
Creates a run group.
-
#create_sequence_store(params = {}) ⇒ Types::CreateSequenceStoreResponse
Creates a sequence store.
-
#create_share(params = {}) ⇒ Types::CreateShareResponse
Creates a cross-account shared resource.
-
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
-
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
-
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
-
#delete_annotation_store_versions(params = {}) ⇒ Types::DeleteAnnotationStoreVersionsResponse
Deletes one or multiple versions of an annotation store.
-
#delete_reference(params = {}) ⇒ Struct
Deletes a genome reference.
-
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
-
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
-
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
-
#delete_sequence_store(params = {}) ⇒ Struct
Deletes a sequence store.
-
#delete_share(params = {}) ⇒ Types::DeleteShareResponse
Deletes a resource share.
-
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
-
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
-
#get_annotation_import_job(params = {}) ⇒ Types::GetAnnotationImportResponse
Gets information about an annotation import job.
-
#get_annotation_store(params = {}) ⇒ Types::GetAnnotationStoreResponse
Gets information about an annotation store.
-
#get_annotation_store_version(params = {}) ⇒ Types::GetAnnotationStoreVersionResponse
Retrieves the metadata for an annotation store version.
-
#get_read_set(params = {}) ⇒ Types::GetReadSetResponse
Gets a file from a read set.
-
#get_read_set_activation_job(params = {}) ⇒ Types::GetReadSetActivationJobResponse
Gets information about a read set activation job.
-
#get_read_set_export_job(params = {}) ⇒ Types::GetReadSetExportJobResponse
Gets information about a read set export job.
-
#get_read_set_import_job(params = {}) ⇒ Types::GetReadSetImportJobResponse
Gets information about a read set import job.
-
#get_read_set_metadata(params = {}) ⇒ Types::GetReadSetMetadataResponse
Gets details about a read set.
-
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
-
#get_reference_import_job(params = {}) ⇒ Types::GetReferenceImportJobResponse
Gets information about a reference import job.
-
#get_reference_metadata(params = {}) ⇒ Types::GetReferenceMetadataResponse
Gets information about a genome reference's metadata.
-
#get_reference_store(params = {}) ⇒ Types::GetReferenceStoreResponse
Gets information about a reference store.
-
#get_run(params = {}) ⇒ Types::GetRunResponse
Gets information about a workflow run.
-
#get_run_group(params = {}) ⇒ Types::GetRunGroupResponse
Gets information about a workflow run group.
-
#get_run_task(params = {}) ⇒ Types::GetRunTaskResponse
Gets information about a workflow run task.
-
#get_sequence_store(params = {}) ⇒ Types::GetSequenceStoreResponse
Gets information about a sequence store.
-
#get_share(params = {}) ⇒ Types::GetShareResponse
Retrieves the metadata for the specified resource share.
-
#get_variant_import_job(params = {}) ⇒ Types::GetVariantImportResponse
Gets information about a variant import job.
-
#get_variant_store(params = {}) ⇒ Types::GetVariantStoreResponse
Gets information about a variant store.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Gets information about a workflow.
-
#list_annotation_import_jobs(params = {}) ⇒ Types::ListAnnotationImportJobsResponse
Retrieves a list of annotation import jobs.
-
#list_annotation_store_versions(params = {}) ⇒ Types::ListAnnotationStoreVersionsResponse
Lists the versions of an annotation store.
-
#list_annotation_stores(params = {}) ⇒ Types::ListAnnotationStoresResponse
Retrieves a list of annotation stores.
-
#list_multipart_read_set_uploads(params = {}) ⇒ Types::ListMultipartReadSetUploadsResponse
Lists multipart read set uploads and for in progress uploads.
-
#list_read_set_activation_jobs(params = {}) ⇒ Types::ListReadSetActivationJobsResponse
Retrieves a list of read set activation jobs.
-
#list_read_set_export_jobs(params = {}) ⇒ Types::ListReadSetExportJobsResponse
Retrieves a list of read set export jobs.
-
#list_read_set_import_jobs(params = {}) ⇒ Types::ListReadSetImportJobsResponse
Retrieves a list of read set import jobs.
-
#list_read_set_upload_parts(params = {}) ⇒ Types::ListReadSetUploadPartsResponse
This operation will list all parts in a requested multipart upload for a sequence store.
-
#list_read_sets(params = {}) ⇒ Types::ListReadSetsResponse
Retrieves a list of read sets.
-
#list_reference_import_jobs(params = {}) ⇒ Types::ListReferenceImportJobsResponse
Retrieves a list of reference import jobs.
-
#list_reference_stores(params = {}) ⇒ Types::ListReferenceStoresResponse
Retrieves a list of reference stores.
-
#list_references(params = {}) ⇒ Types::ListReferencesResponse
Retrieves a list of references.
-
#list_run_groups(params = {}) ⇒ Types::ListRunGroupsResponse
Retrieves a list of run groups.
-
#list_run_tasks(params = {}) ⇒ Types::ListRunTasksResponse
Retrieves a list of tasks for a run.
-
#list_runs(params = {}) ⇒ Types::ListRunsResponse
Retrieves a list of runs.
-
#list_sequence_stores(params = {}) ⇒ Types::ListSequenceStoresResponse
Retrieves a list of sequence stores.
-
#list_shares(params = {}) ⇒ Types::ListSharesResponse
Retrieves the resource shares associated with an account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for a resource.
-
#list_variant_import_jobs(params = {}) ⇒ Types::ListVariantImportJobsResponse
Retrieves a list of variant import jobs.
-
#list_variant_stores(params = {}) ⇒ Types::ListVariantStoresResponse
Retrieves a list of variant stores.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Retrieves a list of workflows.
-
#start_annotation_import_job(params = {}) ⇒ Types::StartAnnotationImportResponse
Starts an annotation import job.
-
#start_read_set_activation_job(params = {}) ⇒ Types::StartReadSetActivationJobResponse
Activates an archived read set.
-
#start_read_set_export_job(params = {}) ⇒ Types::StartReadSetExportJobResponse
Exports a read set to Amazon S3.
-
#start_read_set_import_job(params = {}) ⇒ Types::StartReadSetImportJobResponse
Starts a read set import job.
-
#start_reference_import_job(params = {}) ⇒ Types::StartReferenceImportJobResponse
Starts a reference import job.
-
#start_run(params = {}) ⇒ Types::StartRunResponse
Starts a workflow run.
-
#start_variant_import_job(params = {}) ⇒ Types::StartVariantImportResponse
Starts a variant import job.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
-
#update_annotation_store_version(params = {}) ⇒ Types::UpdateAnnotationStoreVersionResponse
Updates the description of an annotation store version.
-
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
-
#update_variant_store(params = {}) ⇒ Types::UpdateVariantStoreResponse
Updates a variant store.
-
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
-
#upload_read_set_part(params = {}) ⇒ Types::UploadReadSetPartResponse
This operation uploads a specific part of a read set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
436 437 438 439 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 436 def abort_multipart_read_set_upload(params = {}, = {}) req = build_request(:abort_multipart_read_set_upload, params) req.send_request() end |
#accept_share(params = {}) ⇒ Types::AcceptShareResponse
Accept a resource share request.
464 465 466 467 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 464 def accept_share(params = {}, = {}) req = build_request(:accept_share, params) req.send_request() end |
#batch_delete_read_set(params = {}) ⇒ Types::BatchDeleteReadSetResponse
Deletes one or more read sets.
499 500 501 502 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 499 def batch_delete_read_set(params = {}, = {}) req = build_request(:batch_delete_read_set, params) req.send_request() end |
#cancel_annotation_import_job(params = {}) ⇒ Struct
Cancels an annotation import job.
521 522 523 524 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 521 def cancel_annotation_import_job(params = {}, = {}) req = build_request(:cancel_annotation_import_job, params) req.send_request() end |
#cancel_run(params = {}) ⇒ Struct
Cancels a run.
543 544 545 546 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 543 def cancel_run(params = {}, = {}) req = build_request(:cancel_run, params) req.send_request() end |
#cancel_variant_import_job(params = {}) ⇒ Struct
Cancels a variant import job.
565 566 567 568 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 565 def cancel_variant_import_job(params = {}, = {}) req = build_request(:cancel_variant_import_job, params) req.send_request() end |
#complete_multipart_read_set_upload(params = {}) ⇒ Types::CompleteMultipartReadSetUploadResponse
Concludes a multipart upload once you have uploaded all the components.
608 609 610 611 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 608 def complete_multipart_read_set_upload(params = {}, = {}) req = build_request(:complete_multipart_read_set_upload, params) req.send_request() end |
#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse
Creates an annotation store.
703 704 705 706 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 703 def create_annotation_store(params = {}, = {}) req = build_request(:create_annotation_store, params) req.send_request() end |
#create_annotation_store_version(params = {}) ⇒ Types::CreateAnnotationStoreVersionResponse
Creates a new version of an annotation store.
780 781 782 783 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 780 def create_annotation_store_version(params = {}, = {}) req = build_request(:create_annotation_store_version, params) req.send_request() end |
#create_multipart_read_set_upload(params = {}) ⇒ Types::CreateMultipartReadSetUploadResponse
Begins a multipart read set upload.
869 870 871 872 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 869 def create_multipart_read_set_upload(params = {}, = {}) req = build_request(:create_multipart_read_set_upload, params) req.send_request() end |
#create_reference_store(params = {}) ⇒ Types::CreateReferenceStoreResponse
Creates a reference store.
930 931 932 933 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 930 def create_reference_store(params = {}, = {}) req = build_request(:create_reference_store, params) req.send_request() end |
#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse
Creates a run group.
993 994 995 996 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 993 def create_run_group(params = {}, = {}) req = build_request(:create_run_group, params) req.send_request() end |
#create_sequence_store(params = {}) ⇒ Types::CreateSequenceStoreResponse
Creates a sequence store.
1067 1068 1069 1070 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1067 def create_sequence_store(params = {}, = {}) req = build_request(:create_sequence_store, params) req.send_request() end |
#create_share(params = {}) ⇒ Types::CreateShareResponse
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
1118 1119 1120 1121 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1118 def create_share(params = {}, = {}) req = build_request(:create_share, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1177 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
1263 1264 1265 1266 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1263 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
1295 1296 1297 1298 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1295 def delete_annotation_store(params = {}, = {}) req = build_request(:delete_annotation_store, params) req.send_request() end |
#delete_annotation_store_versions(params = {}) ⇒ Types::DeleteAnnotationStoreVersionsResponse
Deletes one or multiple versions of an annotation store.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1335 def delete_annotation_store_versions(params = {}, = {}) req = build_request(:delete_annotation_store_versions, params) req.send_request() end |
#delete_reference(params = {}) ⇒ Struct
Deletes a genome reference.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1361 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1383 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
1405 1406 1407 1408 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1405 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1427 1428 1429 1430 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1427 def delete_run_group(params = {}, = {}) req = build_request(:delete_run_group, params) req.send_request() end |
#delete_sequence_store(params = {}) ⇒ Struct
Deletes a sequence store.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1449 def delete_sequence_store(params = {}, = {}) req = build_request(:delete_sequence_store, params) req.send_request() end |
#delete_share(params = {}) ⇒ Types::DeleteShareResponse
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.
1479 1480 1481 1482 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1479 def delete_share(params = {}, = {}) req = build_request(:delete_share, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1511 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1533 def delete_workflow(params = {}, = {}) req = build_request(:delete_workflow, params) req.send_request() end |
#get_annotation_import_job(params = {}) ⇒ Types::GetAnnotationImportResponse
Gets information about an annotation import job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- annotation_import_job_created
1603 1604 1605 1606 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1603 def get_annotation_import_job(params = {}, = {}) req = build_request(:get_annotation_import_job, params) req.send_request() end |
#get_annotation_store(params = {}) ⇒ Types::GetAnnotationStoreResponse
Gets information about an annotation store.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- annotation_store_created
- annotation_store_deleted
1672 1673 1674 1675 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1672 def get_annotation_store(params = {}, = {}) req = build_request(:get_annotation_store, params) req.send_request() end |
#get_annotation_store_version(params = {}) ⇒ Types::GetAnnotationStoreVersionResponse
Retrieves the metadata for an annotation store version.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- annotation_store_version_created
- annotation_store_version_deleted
1742 1743 1744 1745 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1742 def get_annotation_store_version(params = {}, = {}) req = build_request(:get_annotation_store_version, params) req.send_request() end |
#get_read_set(params = {}) ⇒ Types::GetReadSetResponse
Gets a file from a read set.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1782 def get_read_set(params = {}, = {}, &block) req = build_request(:get_read_set, params) req.send_request(, &block) end |
#get_read_set_activation_job(params = {}) ⇒ Types::GetReadSetActivationJobResponse
Gets information about a read set activation job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- read_set_activation_job_completed
1834 1835 1836 1837 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1834 def get_read_set_activation_job(params = {}, = {}) req = build_request(:get_read_set_activation_job, params) req.send_request() end |
#get_read_set_export_job(params = {}) ⇒ Types::GetReadSetExportJobResponse
Gets information about a read set export job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- read_set_export_job_completed
1888 1889 1890 1891 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1888 def get_read_set_export_job(params = {}, = {}) req = build_request(:get_read_set_export_job, params) req.send_request() end |
#get_read_set_import_job(params = {}) ⇒ Types::GetReadSetImportJobResponse
Gets information about a read set import job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- read_set_import_job_completed
1952 1953 1954 1955 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1952 def get_read_set_import_job(params = {}, = {}) req = build_request(:get_read_set_import_job, params) req.send_request() end |
#get_read_set_metadata(params = {}) ⇒ Types::GetReadSetMetadataResponse
Gets details about a read set.
2030 2031 2032 2033 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2030 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2074 def get_reference(params = {}, = {}, &block) req = build_request(:get_reference, params) req.send_request(, &block) end |
#get_reference_import_job(params = {}) ⇒ Types::GetReferenceImportJobResponse
Gets information about a reference import job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- reference_import_job_completed
2132 2133 2134 2135 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2132 def get_reference_import_job(params = {}, = {}) req = build_request(:get_reference_import_job, params) req.send_request() end |
#get_reference_metadata(params = {}) ⇒ Types::GetReferenceMetadataResponse
Gets information about a genome reference's metadata.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2189 def (params = {}, = {}) req = build_request(:get_reference_metadata, params) req.send_request() end |
#get_reference_store(params = {}) ⇒ Types::GetReferenceStoreResponse
Gets information about a reference store.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2228 def get_reference_store(params = {}, = {}) req = build_request(:get_reference_store, params) req.send_request() end |
#get_run(params = {}) ⇒ Types::GetRunResponse
Gets information about a workflow run.
If a workflow is shared with you, you cannot export information about the run.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- run_completed
- run_running
2331 2332 2333 2334 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2331 def get_run(params = {}, = {}) req = build_request(:get_run, params) req.send_request() end |
#get_run_group(params = {}) ⇒ Types::GetRunGroupResponse
Gets information about a workflow run group.
2376 2377 2378 2379 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2376 def get_run_group(params = {}, = {}) req = build_request(:get_run_group, params) req.send_request() end |
#get_run_task(params = {}) ⇒ Types::GetRunTaskResponse
Gets information about a workflow run task.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- task_completed
- task_running
2438 2439 2440 2441 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2438 def get_run_task(params = {}, = {}) req = build_request(:get_run_task, params) req.send_request() end |
#get_sequence_store(params = {}) ⇒ Types::GetSequenceStoreResponse
Gets information about a sequence store.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2484 def get_sequence_store(params = {}, = {}) req = build_request(:get_sequence_store, params) req.send_request() end |
#get_share(params = {}) ⇒ Types::GetShareResponse
Retrieves the metadata for the specified resource share.
2521 2522 2523 2524 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2521 def get_share(params = {}, = {}) req = build_request(:get_share, params) req.send_request() end |
#get_variant_import_job(params = {}) ⇒ Types::GetVariantImportResponse
Gets information about a variant import job.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- variant_import_job_created
2578 2579 2580 2581 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2578 def get_variant_import_job(params = {}, = {}) req = build_request(:get_variant_import_job, params) req.send_request() end |
#get_variant_store(params = {}) ⇒ Types::GetVariantStoreResponse
Gets information about a variant store.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- variant_store_created
- variant_store_deleted
2636 2637 2638 2639 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2636 def get_variant_store(params = {}, = {}) req = build_request(:get_variant_store, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Gets information about a workflow.
If a workflow is shared with you, you cannot export the workflow.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- workflow_active
2719 2720 2721 2722 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2719 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#list_annotation_import_jobs(params = {}) ⇒ Types::ListAnnotationImportJobsResponse
Retrieves a list of annotation import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2778 2779 2780 2781 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2778 def list_annotation_import_jobs(params = {}, = {}) req = build_request(:list_annotation_import_jobs, params) req.send_request() end |
#list_annotation_store_versions(params = {}) ⇒ Types::ListAnnotationStoreVersionsResponse
Lists the versions of an annotation store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2837 def list_annotation_store_versions(params = {}, = {}) req = build_request(:list_annotation_store_versions, params) req.send_request() end |
#list_annotation_stores(params = {}) ⇒ Types::ListAnnotationStoresResponse
Retrieves a list of annotation stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2897 def list_annotation_stores(params = {}, = {}) req = build_request(:list_annotation_stores, params) req.send_request() end |
#list_multipart_read_set_uploads(params = {}) ⇒ Types::ListMultipartReadSetUploadsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2953 2954 2955 2956 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2953 def list_multipart_read_set_uploads(params = {}, = {}) req = build_request(:list_multipart_read_set_uploads, params) req.send_request() end |
#list_read_set_activation_jobs(params = {}) ⇒ Types::ListReadSetActivationJobsResponse
Retrieves a list of read set activation jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3008 def list_read_set_activation_jobs(params = {}, = {}) req = build_request(:list_read_set_activation_jobs, params) req.send_request() end |
#list_read_set_export_jobs(params = {}) ⇒ Types::ListReadSetExportJobsResponse
Retrieves a list of read set export jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3063 3064 3065 3066 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3063 def list_read_set_export_jobs(params = {}, = {}) req = build_request(:list_read_set_export_jobs, params) req.send_request() end |
#list_read_set_import_jobs(params = {}) ⇒ Types::ListReadSetImportJobsResponse
Retrieves a list of read set import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3118 3119 3120 3121 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3118 def list_read_set_import_jobs(params = {}, = {}) req = build_request(:list_read_set_import_jobs, params) req.send_request() end |
#list_read_set_upload_parts(params = {}) ⇒ Types::ListReadSetUploadPartsResponse
This operation will list all parts in a requested multipart upload for a sequence store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3183 3184 3185 3186 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3183 def list_read_set_upload_parts(params = {}, = {}) req = build_request(:list_read_set_upload_parts, params) req.send_request() end |
#list_read_sets(params = {}) ⇒ Types::ListReadSetsResponse
Retrieves a list of read sets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3258 3259 3260 3261 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3258 def list_read_sets(params = {}, = {}) req = build_request(:list_read_sets, params) req.send_request() end |
#list_reference_import_jobs(params = {}) ⇒ Types::ListReferenceImportJobsResponse
Retrieves a list of reference import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3313 3314 3315 3316 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3313 def list_reference_import_jobs(params = {}, = {}) req = build_request(:list_reference_import_jobs, params) req.send_request() end |
#list_reference_stores(params = {}) ⇒ Types::ListReferenceStoresResponse
Retrieves a list of reference stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3365 3366 3367 3368 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3365 def list_reference_stores(params = {}, = {}) req = build_request(:list_reference_stores, params) req.send_request() end |
#list_references(params = {}) ⇒ Types::ListReferencesResponse
Retrieves a list of references.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3424 3425 3426 3427 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3424 def list_references(params = {}, = {}) req = build_request(:list_references, params) req.send_request() end |
#list_run_groups(params = {}) ⇒ Types::ListRunGroupsResponse
Retrieves a list of run groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3473 3474 3475 3476 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3473 def list_run_groups(params = {}, = {}) req = build_request(:list_run_groups, params) req.send_request() end |
#list_run_tasks(params = {}) ⇒ Types::ListRunTasksResponse
Retrieves a list of tasks for a run.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3528 3529 3530 3531 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3528 def list_run_tasks(params = {}, = {}) req = build_request(:list_run_tasks, params) req.send_request() end |
#list_runs(params = {}) ⇒ Types::ListRunsResponse
Retrieves a list of runs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3588 3589 3590 3591 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3588 def list_runs(params = {}, = {}) req = build_request(:list_runs, params) req.send_request() end |
#list_sequence_stores(params = {}) ⇒ Types::ListSequenceStoresResponse
Retrieves a list of sequence stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3642 3643 3644 3645 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3642 def list_sequence_stores(params = {}, = {}) req = build_request(:list_sequence_stores, params) req.send_request() end |
#list_shares(params = {}) ⇒ Types::ListSharesResponse
Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3704 3705 3706 3707 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3704 def list_shares(params = {}, = {}) req = build_request(:list_shares, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for a resource.
3733 3734 3735 3736 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3733 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_variant_import_jobs(params = {}) ⇒ Types::ListVariantImportJobsResponse
Retrieves a list of variant import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3791 3792 3793 3794 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3791 def list_variant_import_jobs(params = {}, = {}) req = build_request(:list_variant_import_jobs, params) req.send_request() end |
#list_variant_stores(params = {}) ⇒ Types::ListVariantStoresResponse
Retrieves a list of variant stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3850 3851 3852 3853 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3850 def list_variant_stores(params = {}, = {}) req = build_request(:list_variant_stores, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Retrieves a list of workflows.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3904 3905 3906 3907 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3904 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#start_annotation_import_job(params = {}) ⇒ Types::StartAnnotationImportResponse
Starts an annotation import job.
3980 3981 3982 3983 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3980 def start_annotation_import_job(params = {}, = {}) req = build_request(:start_annotation_import_job, params) req.send_request() end |
#start_read_set_activation_job(params = {}) ⇒ Types::StartReadSetActivationJobResponse
Activates an archived read set. To reduce storage charges, Amazon Omics archives unused read sets after 30 days.
4028 4029 4030 4031 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4028 def start_read_set_activation_job(params = {}, = {}) req = build_request(:start_read_set_activation_job, params) req.send_request() end |
#start_read_set_export_job(params = {}) ⇒ Types::StartReadSetExportJobResponse
Exports a read set to Amazon S3.
4085 4086 4087 4088 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4085 def start_read_set_export_job(params = {}, = {}) req = build_request(:start_read_set_export_job, params) req.send_request() end |
#start_read_set_import_job(params = {}) ⇒ Types::StartReadSetImportJobResponse
Starts a read set import job.
4151 4152 4153 4154 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4151 def start_read_set_import_job(params = {}, = {}) req = build_request(:start_read_set_import_job, params) req.send_request() end |
#start_reference_import_job(params = {}) ⇒ Types::StartReferenceImportJobResponse
Starts a reference import job.
4209 4210 4211 4212 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4209 def start_reference_import_job(params = {}, = {}) req = build_request(:start_reference_import_job, params) req.send_request() end |
#start_run(params = {}) ⇒ Types::StartRunResponse
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.
4345 4346 4347 4348 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4345 def start_run(params = {}, = {}) req = build_request(:start_run, params) req.send_request() end |
#start_variant_import_job(params = {}) ⇒ Types::StartVariantImportResponse
Starts a variant import job.
4395 4396 4397 4398 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4395 def start_variant_import_job(params = {}, = {}) req = build_request(:start_variant_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a resource.
4423 4424 4425 4426 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4423 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4449 4450 4451 4452 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4449 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
4502 4503 4504 4505 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4502 def update_annotation_store(params = {}, = {}) req = build_request(:update_annotation_store, params) req.send_request() end |
#update_annotation_store_version(params = {}) ⇒ Types::UpdateAnnotationStoreVersionResponse
Updates the description of an annotation store version.
4552 4553 4554 4555 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4552 def update_annotation_store_version(params = {}, = {}) req = build_request(:update_annotation_store_version, params) req.send_request() end |
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
4594 4595 4596 4597 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4594 def update_run_group(params = {}, = {}) req = build_request(:update_run_group, params) req.send_request() end |
#update_variant_store(params = {}) ⇒ Types::UpdateVariantStoreResponse
Updates a variant store.
4638 4639 4640 4641 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4638 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
4668 4669 4670 4671 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4668 def update_workflow(params = {}, = {}) req = build_request(:update_workflow, params) req.send_request() end |
#upload_read_set_part(params = {}) ⇒ Types::UploadReadSetPartResponse
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.
4714 4715 4716 4717 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4714 def upload_read_set_part(params = {}, = {}) req = build_request(:upload_read_set_part, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
annotation_import_job_created | #get_annotation_import_job | 30 | 20 |
annotation_store_created | #get_annotation_store | 30 | 20 |
annotation_store_deleted | #get_annotation_store | 30 | 20 |
annotation_store_version_created | #get_annotation_store_version | 30 | 20 |
annotation_store_version_deleted | #get_annotation_store_version | 30 | 20 |
read_set_activation_job_completed | #get_read_set_activation_job | 30 | 20 |
read_set_export_job_completed | #get_read_set_export_job | 30 | 20 |
read_set_import_job_completed | #get_read_set_import_job | 30 | 20 |
reference_import_job_completed | #get_reference_import_job | 30 | 20 |
run_completed | #get_run | 30 | 20 |
run_running | #get_run | 30 | 20 |
task_completed | #get_run_task | 30 | 20 |
task_running | #get_run_task | 30 | 20 |
variant_import_job_created | #get_variant_import_job | 30 | 20 |
variant_store_created | #get_variant_store | 30 | 20 |
variant_store_deleted | #get_variant_store | 30 | 20 |
workflow_active | #get_workflow | 3 | 10 |
4840 4841 4842 4843 4844 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4840 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |