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
Accepts a share for an analytics store.
-
#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 share offer that can be accepted outside the account by a subscriber.
-
#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 share of an analytics store.
-
#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 a 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 all multipart read set uploads and their statuses.
-
#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
Lists all 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.
385 386 387 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
412 413 414 415 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 412 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
Accepts a share for an analytics store.
440 441 442 443 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 440 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.
475 476 477 478 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 475 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.
497 498 499 500 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 497 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.
519 520 521 522 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 519 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.
541 542 543 544 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 541 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.
584 585 586 587 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 584 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.
679 680 681 682 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 679 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.
756 757 758 759 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 756 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.
845 846 847 848 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 845 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.
906 907 908 909 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 906 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.
969 970 971 972 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 969 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.
1037 1038 1039 1040 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1037 def create_sequence_store(params = {}, = {}) req = build_request(:create_sequence_store, params) req.send_request() end |
#create_share(params = {}) ⇒ Types::CreateShareResponse
Creates a share offer that can be accepted outside the account by a subscriber. The share is created by the owner and accepted by the principal subscriber.
1080 1081 1082 1083 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1080 def create_share(params = {}, = {}) req = build_request(:create_share, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
1139 1140 1141 1142 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1139 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1225 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1257 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.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1297 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.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1323 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
1345 1346 1347 1348 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1345 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
1367 1368 1369 1370 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1367 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1389 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.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1411 def delete_sequence_store(params = {}, = {}) req = build_request(:delete_sequence_store, params) req.send_request() end |
#delete_share(params = {}) ⇒ Types::DeleteShareResponse
Deletes a share of an analytics store.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1439 def delete_share(params = {}, = {}) req = build_request(:delete_share, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1471 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1493 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
1563 1564 1565 1566 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1563 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
1632 1633 1634 1635 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1632 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
1702 1703 1704 1705 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1702 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.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1742 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
1794 1795 1796 1797 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1794 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
1848 1849 1850 1851 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1848 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
1912 1913 1914 1915 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1912 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.
1983 1984 1985 1986 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1983 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
2027 2028 2029 2030 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2027 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
2085 2086 2087 2088 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2085 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.
2140 2141 2142 2143 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2140 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.
2179 2180 2181 2182 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2179 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- run_completed
- run_running
2266 2267 2268 2269 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2266 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.
2311 2312 2313 2314 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2311 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
2371 2372 2373 2374 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2371 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.
2412 2413 2414 2415 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2412 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 a share.
2448 2449 2450 2451 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2448 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
2505 2506 2507 2508 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2505 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
2563 2564 2565 2566 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2563 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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- workflow_active
2640 2641 2642 2643 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2640 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.
2699 2700 2701 2702 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2699 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.
2758 2759 2760 2761 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2758 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.
2818 2819 2820 2821 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2818 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 all multipart read set uploads and their statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2872 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.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2927 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.
2982 2983 2984 2985 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2982 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.
3037 3038 3039 3040 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3037 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.
3102 3103 3104 3105 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3102 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.
3174 3175 3176 3177 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3174 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.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3229 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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3281 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.
3340 3341 3342 3343 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3340 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.
3389 3390 3391 3392 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3389 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.
3444 3445 3446 3447 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3444 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.
3503 3504 3505 3506 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3503 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.
3556 3557 3558 3559 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3556 def list_sequence_stores(params = {}, = {}) req = build_request(:list_sequence_stores, params) req.send_request() end |
#list_shares(params = {}) ⇒ Types::ListSharesResponse
Lists all shares associated with an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3614 3615 3616 3617 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3614 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.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3643 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.
3701 3702 3703 3704 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3701 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.
3760 3761 3762 3763 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3760 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.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3814 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.
3890 3891 3892 3893 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3890 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.
3938 3939 3940 3941 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3938 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.
3995 3996 3997 3998 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3995 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.
4061 4062 4063 4064 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4061 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.
4119 4120 4121 4122 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4119 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.
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.
4224 4225 4226 4227 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4224 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.
4274 4275 4276 4277 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4274 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.
4302 4303 4304 4305 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4302 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4328 4329 4330 4331 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4328 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
4381 4382 4383 4384 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4381 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.
4431 4432 4433 4434 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4431 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.
4473 4474 4475 4476 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4473 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.
4517 4518 4519 4520 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4517 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
4547 4548 4549 4550 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4547 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.
4593 4594 4595 4596 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4593 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 |
4719 4720 4721 4722 4723 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4719 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |