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_cache(params = {}) ⇒ Types::CreateRunCacheResponse
You can create a run cache to save the task outputs from completed tasks in a run for a private workflow.
-
#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse
You can optionally create a run group to limit the compute resources for the runs that you add to the 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_cache(params = {}) ⇒ Struct
Delete a run cache.
-
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
-
#delete_s3_access_policy(params = {}) ⇒ Struct
Deletes an access policy for the specified store.
-
#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_cache(params = {}) ⇒ Types::GetRunCacheResponse
Retrieve the details for the specified run cache.
-
#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_s3_access_policy(params = {}) ⇒ Types::GetS3AccessPolicyResponse
Retrieves details about an access policy on a given store.
-
#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_caches(params = {}) ⇒ Types::ListRunCachesResponse
Retrieves a list of your run caches.
-
#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.
-
#put_s3_access_policy(params = {}) ⇒ Types::PutS3AccessPolicyResponse
Adds an access policy to the specified store.
-
#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_cache(params = {}) ⇒ Struct
Update a run cache.
-
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
-
#update_sequence_store(params = {}) ⇒ Types::UpdateSequenceStoreResponse
Update one or more parameters for the sequence store.
-
#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.
467 468 469 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 467 def initialize(*args) super end |
Instance Method Details
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
494 495 496 497 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 494 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.
522 523 524 525 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 522 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.
557 558 559 560 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 557 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.
579 580 581 582 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 579 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.
601 602 603 604 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 601 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.
623 624 625 626 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 623 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.
666 667 668 669 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 666 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.
761 762 763 764 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 761 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.
838 839 840 841 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 838 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.
927 928 929 930 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 927 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.
988 989 990 991 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 988 def create_reference_store(params = {}, = {}) req = build_request(:create_reference_store, params) req.send_request() end |
#create_run_cache(params = {}) ⇒ Types::CreateRunCacheResponse
You can create a run cache to save the task outputs from completed tasks in a run for a private workflow. Subsequent runs use the task outputs from the cache, rather than computing the task outputs again. You specify an Amazon S3 location where HealthOmics saves the cached data. This data must be immediately accessible (not in an archived state).
For more information, see Creating a run cache in the AWS HealthOmics User Guide.
1092 1093 1094 1095 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1092 def create_run_cache(params = {}, = {}) req = build_request(:create_run_cache, params) req.send_request() end |
#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse
You can optionally create a run group to limit the compute resources for the runs that you add to the group.
1159 1160 1161 1162 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1159 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1258 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
1309 1310 1311 1312 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1309 def create_share(params = {}, = {}) req = build_request(:create_share, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
1368 1369 1370 1371 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1368 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
1454 1455 1456 1457 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1454 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1486 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.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1526 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1552 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1574 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1596 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_cache(params = {}) ⇒ Struct
Delete a run cache. This action removes the cache metadata stored in
the service account, but doesn't delete the data in Amazon S3. You
can access the cache data in Amazon S3, for inspection or to
troubleshoot issues. You can remove old cache data using standard S3
Delete
operations.
For more information, see Deleting a run cache in the AWS HealthOmics User Guide.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1629 def delete_run_cache(params = {}, = {}) req = build_request(:delete_run_cache, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1651 def delete_run_group(params = {}, = {}) req = build_request(:delete_run_group, params) req.send_request() end |
#delete_s3_access_policy(params = {}) ⇒ Struct
Deletes an access policy for the specified store.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1673 def delete_s3_access_policy(params = {}, = {}) req = build_request(:delete_s3_access_policy, params) req.send_request() end |
#delete_sequence_store(params = {}) ⇒ Struct
Deletes a sequence store.
1695 1696 1697 1698 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1695 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.
1725 1726 1727 1728 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1725 def delete_share(params = {}, = {}) req = build_request(:delete_share, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1757 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1779 1780 1781 1782 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1779 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
1849 1850 1851 1852 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1849 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
1918 1919 1920 1921 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1918 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
1988 1989 1990 1991 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1988 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.
2028 2029 2030 2031 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2028 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
2080 2081 2082 2083 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2080 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
2134 2135 2136 2137 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2134 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
2199 2200 2201 2202 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2199 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.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2279 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
2323 2324 2325 2326 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2323 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
2382 2383 2384 2385 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2382 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.
2443 2444 2445 2446 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2443 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.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2482 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.
HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- run_completed
- run_running
2601 2602 2603 2604 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2601 def get_run(params = {}, = {}) req = build_request(:get_run, params) req.send_request() end |
#get_run_cache(params = {}) ⇒ Types::GetRunCacheResponse
Retrieve the details for the specified run cache.
For more information, see Call caching for HealthOmics runs in the AWS HealthOmics User Guide.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2655 def get_run_cache(params = {}, = {}) req = build_request(:get_run_cache, params) req.send_request() end |
#get_run_group(params = {}) ⇒ Types::GetRunGroupResponse
Gets information about a workflow run group.
2700 2701 2702 2703 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2700 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
2766 2767 2768 2769 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2766 def get_run_task(params = {}, = {}) req = build_request(:get_run_task, params) req.send_request() end |
#get_s3_access_policy(params = {}) ⇒ Types::GetS3AccessPolicyResponse
Retrieves details about an access policy on a given store.
2802 2803 2804 2805 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2802 def get_s3_access_policy(params = {}, = {}) req = build_request(:get_s3_access_policy, params) req.send_request() end |
#get_sequence_store(params = {}) ⇒ Types::GetSequenceStoreResponse
Gets information about a sequence store.
2858 2859 2860 2861 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2858 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.
2895 2896 2897 2898 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2895 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
2952 2953 2954 2955 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2952 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
3010 3011 3012 3013 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3010 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
3093 3094 3095 3096 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3093 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.
3152 3153 3154 3155 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3152 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.
3211 3212 3213 3214 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3211 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.
3271 3272 3273 3274 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3271 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.
3327 3328 3329 3330 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3327 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.
3382 3383 3384 3385 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3382 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.
3437 3438 3439 3440 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3437 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.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3492 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.
3557 3558 3559 3560 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3557 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.
3632 3633 3634 3635 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3632 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.
3687 3688 3689 3690 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3687 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.
3739 3740 3741 3742 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3739 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.
3798 3799 3800 3801 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3798 def list_references(params = {}, = {}) req = build_request(:list_references, params) req.send_request() end |
#list_run_caches(params = {}) ⇒ Types::ListRunCachesResponse
Retrieves a list of your run caches.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3842 3843 3844 3845 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3842 def list_run_caches(params = {}, = {}) req = build_request(:list_run_caches, 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.
3891 3892 3893 3894 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3891 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.
3948 3949 3950 3951 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3948 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.
HealthOmics stores a fixed number of runs that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4018 4019 4020 4021 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4018 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.
4078 4079 4080 4081 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4078 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.
4140 4141 4142 4143 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4140 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.
4169 4170 4171 4172 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4169 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.
4227 4228 4229 4230 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4227 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.
4286 4287 4288 4289 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4286 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.
4340 4341 4342 4343 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4340 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#put_s3_access_policy(params = {}) ⇒ Types::PutS3AccessPolicyResponse
Adds an access policy to the specified store.
4380 4381 4382 4383 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4380 def put_s3_access_policy(params = {}, = {}) req = build_request(:put_s3_access_policy, params) req.send_request() end |
#start_annotation_import_job(params = {}) ⇒ Types::StartAnnotationImportResponse
Starts an annotation import job.
4456 4457 4458 4459 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4456 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.
4504 4505 4506 4507 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4504 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.
4561 4562 4563 4564 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4561 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.
4627 4628 4629 4630 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4627 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.
4685 4686 4687 4688 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4685 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.
HealthOmics stores a fixed number of runs that are available to the
console and API. By default, HealthOmics doesn't any remove any runs.
If HealthOmics reaches the maximum number of runs, you must manually
remove runs. To have older runs removed automatically, set the
retention mode to REMOVE
.
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.
4853 4854 4855 4856 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4853 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.
4903 4904 4905 4906 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4903 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.
4931 4932 4933 4934 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4931 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4957 4958 4959 4960 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4957 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
5010 5011 5012 5013 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5010 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.
5060 5061 5062 5063 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5060 def update_annotation_store_version(params = {}, = {}) req = build_request(:update_annotation_store_version, params) req.send_request() end |
#update_run_cache(params = {}) ⇒ Struct
Update a run cache.
5094 5095 5096 5097 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5094 def update_run_cache(params = {}, = {}) req = build_request(:update_run_cache, params) req.send_request() end |
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
5136 5137 5138 5139 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5136 def update_run_group(params = {}, = {}) req = build_request(:update_run_group, params) req.send_request() end |
#update_sequence_store(params = {}) ⇒ Types::UpdateSequenceStoreResponse
Update one or more parameters for the sequence store.
5224 5225 5226 5227 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5224 def update_sequence_store(params = {}, = {}) req = build_request(:update_sequence_store, params) req.send_request() end |
#update_variant_store(params = {}) ⇒ Types::UpdateVariantStoreResponse
Updates a variant store.
5268 5269 5270 5271 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5268 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
5298 5299 5300 5301 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5298 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.
5344 5345 5346 5347 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5344 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 |
5475 5476 5477 5478 5479 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 5475 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |