Class: Aws::Omics::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Omics::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb
Overview
An API client for Omics. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Omics::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
-
#accept_share(params = {}) ⇒ Types::AcceptShareResponse
Accept a resource share request.
-
#batch_delete_read_set(params = {}) ⇒ Types::BatchDeleteReadSetResponse
Deletes one or more read sets.
-
#cancel_annotation_import_job(params = {}) ⇒ Struct
Cancels an annotation import job.
-
#cancel_run(params = {}) ⇒ Struct
Cancels a run.
-
#cancel_variant_import_job(params = {}) ⇒ Struct
Cancels a variant import job.
-
#complete_multipart_read_set_upload(params = {}) ⇒ Types::CompleteMultipartReadSetUploadResponse
Concludes a multipart upload once you have uploaded all the components.
-
#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse
Creates an annotation store.
-
#create_annotation_store_version(params = {}) ⇒ Types::CreateAnnotationStoreVersionResponse
Creates a new version of an annotation store.
-
#create_multipart_read_set_upload(params = {}) ⇒ Types::CreateMultipartReadSetUploadResponse
Begins a multipart read set upload.
-
#create_reference_store(params = {}) ⇒ Types::CreateReferenceStoreResponse
Creates a reference store.
-
#create_run_group(params = {}) ⇒ Types::CreateRunGroupResponse
Creates a run group.
-
#create_sequence_store(params = {}) ⇒ Types::CreateSequenceStoreResponse
Creates a sequence store.
-
#create_share(params = {}) ⇒ Types::CreateShareResponse
Creates a cross-account shared resource.
-
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
-
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
-
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
-
#delete_annotation_store_versions(params = {}) ⇒ Types::DeleteAnnotationStoreVersionsResponse
Deletes one or multiple versions of an annotation store.
-
#delete_reference(params = {}) ⇒ Struct
Deletes a genome reference.
-
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
-
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
-
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
-
#delete_sequence_store(params = {}) ⇒ Struct
Deletes a sequence store.
-
#delete_share(params = {}) ⇒ Types::DeleteShareResponse
Deletes a resource share.
-
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
-
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
-
#get_annotation_import_job(params = {}) ⇒ Types::GetAnnotationImportResponse
Gets information about an annotation import job.
-
#get_annotation_store(params = {}) ⇒ Types::GetAnnotationStoreResponse
Gets information about an annotation store.
-
#get_annotation_store_version(params = {}) ⇒ Types::GetAnnotationStoreVersionResponse
Retrieves the metadata for an annotation store version.
-
#get_read_set(params = {}) ⇒ Types::GetReadSetResponse
Gets a file from a read set.
-
#get_read_set_activation_job(params = {}) ⇒ Types::GetReadSetActivationJobResponse
Gets information about a read set activation job.
-
#get_read_set_export_job(params = {}) ⇒ Types::GetReadSetExportJobResponse
Gets information about a read set export job.
-
#get_read_set_import_job(params = {}) ⇒ Types::GetReadSetImportJobResponse
Gets information about a read set import job.
-
#get_read_set_metadata(params = {}) ⇒ Types::GetReadSetMetadataResponse
Gets details about a read set.
-
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
-
#get_reference_import_job(params = {}) ⇒ Types::GetReferenceImportJobResponse
Gets information about a reference import job.
-
#get_reference_metadata(params = {}) ⇒ Types::GetReferenceMetadataResponse
Gets information about a genome reference's metadata.
-
#get_reference_store(params = {}) ⇒ Types::GetReferenceStoreResponse
Gets information about a reference store.
-
#get_run(params = {}) ⇒ Types::GetRunResponse
Gets information about a workflow run.
-
#get_run_group(params = {}) ⇒ Types::GetRunGroupResponse
Gets information about a workflow run group.
-
#get_run_task(params = {}) ⇒ Types::GetRunTaskResponse
Gets information about a workflow run task.
-
#get_sequence_store(params = {}) ⇒ Types::GetSequenceStoreResponse
Gets information about a sequence store.
-
#get_share(params = {}) ⇒ Types::GetShareResponse
Retrieves the metadata for the specified resource share.
-
#get_variant_import_job(params = {}) ⇒ Types::GetVariantImportResponse
Gets information about a variant import job.
-
#get_variant_store(params = {}) ⇒ Types::GetVariantStoreResponse
Gets information about a variant store.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Gets information about a workflow.
-
#list_annotation_import_jobs(params = {}) ⇒ Types::ListAnnotationImportJobsResponse
Retrieves a list of annotation import jobs.
-
#list_annotation_store_versions(params = {}) ⇒ Types::ListAnnotationStoreVersionsResponse
Lists the versions of an annotation store.
-
#list_annotation_stores(params = {}) ⇒ Types::ListAnnotationStoresResponse
Retrieves a list of annotation stores.
-
#list_multipart_read_set_uploads(params = {}) ⇒ Types::ListMultipartReadSetUploadsResponse
Lists multipart read set uploads and for in progress uploads.
-
#list_read_set_activation_jobs(params = {}) ⇒ Types::ListReadSetActivationJobsResponse
Retrieves a list of read set activation jobs.
-
#list_read_set_export_jobs(params = {}) ⇒ Types::ListReadSetExportJobsResponse
Retrieves a list of read set export jobs.
-
#list_read_set_import_jobs(params = {}) ⇒ Types::ListReadSetImportJobsResponse
Retrieves a list of read set import jobs.
-
#list_read_set_upload_parts(params = {}) ⇒ Types::ListReadSetUploadPartsResponse
This operation will list all parts in a requested multipart upload for a sequence store.
-
#list_read_sets(params = {}) ⇒ Types::ListReadSetsResponse
Retrieves a list of read sets.
-
#list_reference_import_jobs(params = {}) ⇒ Types::ListReferenceImportJobsResponse
Retrieves a list of reference import jobs.
-
#list_reference_stores(params = {}) ⇒ Types::ListReferenceStoresResponse
Retrieves a list of reference stores.
-
#list_references(params = {}) ⇒ Types::ListReferencesResponse
Retrieves a list of references.
-
#list_run_groups(params = {}) ⇒ Types::ListRunGroupsResponse
Retrieves a list of run groups.
-
#list_run_tasks(params = {}) ⇒ Types::ListRunTasksResponse
Retrieves a list of tasks for a run.
-
#list_runs(params = {}) ⇒ Types::ListRunsResponse
Retrieves a list of runs.
-
#list_sequence_stores(params = {}) ⇒ Types::ListSequenceStoresResponse
Retrieves a list of sequence stores.
-
#list_shares(params = {}) ⇒ Types::ListSharesResponse
Retrieves the resource shares associated with an account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for a resource.
-
#list_variant_import_jobs(params = {}) ⇒ Types::ListVariantImportJobsResponse
Retrieves a list of variant import jobs.
-
#list_variant_stores(params = {}) ⇒ Types::ListVariantStoresResponse
Retrieves a list of variant stores.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Retrieves a list of workflows.
-
#start_annotation_import_job(params = {}) ⇒ Types::StartAnnotationImportResponse
Starts an annotation import job.
-
#start_read_set_activation_job(params = {}) ⇒ Types::StartReadSetActivationJobResponse
Activates an archived read set.
-
#start_read_set_export_job(params = {}) ⇒ Types::StartReadSetExportJobResponse
Exports a read set to Amazon S3.
-
#start_read_set_import_job(params = {}) ⇒ Types::StartReadSetImportJobResponse
Starts a read set import job.
-
#start_reference_import_job(params = {}) ⇒ Types::StartReferenceImportJobResponse
Starts a reference import job.
-
#start_run(params = {}) ⇒ Types::StartRunResponse
Starts a workflow run.
-
#start_variant_import_job(params = {}) ⇒ Types::StartVariantImportResponse
Starts a variant import job.
-
#tag_resource(params = {}) ⇒ Struct
Tags a resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
-
#update_annotation_store_version(params = {}) ⇒ Types::UpdateAnnotationStoreVersionResponse
Updates the description of an annotation store version.
-
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
-
#update_variant_store(params = {}) ⇒ Types::UpdateVariantStoreResponse
Updates a variant store.
-
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
-
#upload_read_set_part(params = {}) ⇒ Types::UploadReadSetPartResponse
This operation uploads a specific part of a read set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
437 438 439 440 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 437 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.
465 466 467 468 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 465 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.
500 501 502 503 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 500 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.
522 523 524 525 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 522 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.
544 545 546 547 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 544 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.
566 567 568 569 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 566 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.
609 610 611 612 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 609 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.
704 705 706 707 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 704 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.
781 782 783 784 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 781 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.
870 871 872 873 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 870 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.
931 932 933 934 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 931 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.
994 995 996 997 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 994 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.
1068 1069 1070 1071 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1068 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
1119 1120 1121 1122 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1119 def create_share(params = {}, = {}) req = build_request(:create_share, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1178 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1264 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
1296 1297 1298 1299 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1296 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.
1336 1337 1338 1339 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1336 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.
1362 1363 1364 1365 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1362 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1384 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1406 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1428 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.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1450 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.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1480 def delete_share(params = {}, = {}) req = build_request(:delete_share, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1512 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1534 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
1604 1605 1606 1607 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1604 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
1673 1674 1675 1676 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1673 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
1743 1744 1745 1746 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1743 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.
1783 1784 1785 1786 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1783 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
1835 1836 1837 1838 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1835 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
1889 1890 1891 1892 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1889 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
1953 1954 1955 1956 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1953 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.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2031 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2075 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
2133 2134 2135 2136 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2133 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.
2190 2191 2192 2193 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2190 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.
2229 2230 2231 2232 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2229 def get_reference_store(params = {}, = {}) req = build_request(:get_reference_store, params) req.send_request() end |
#get_run(params = {}) ⇒ Types::GetRunResponse
Gets information about a workflow run.
If a workflow is shared with you, you cannot export information about the run.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- run_completed
- run_running
2332 2333 2334 2335 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2332 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.
2377 2378 2379 2380 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2377 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
2439 2440 2441 2442 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2439 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.
2485 2486 2487 2488 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2485 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.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2522 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
2579 2580 2581 2582 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2579 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
2637 2638 2639 2640 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2637 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
2720 2721 2722 2723 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2720 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.
2779 2780 2781 2782 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2779 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.
2838 2839 2840 2841 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2838 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.
2898 2899 2900 2901 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2898 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.
2954 2955 2956 2957 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2954 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.
3009 3010 3011 3012 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3009 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.
3064 3065 3066 3067 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3064 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.
3119 3120 3121 3122 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3119 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.
3184 3185 3186 3187 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3184 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.
3259 3260 3261 3262 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3259 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.
3314 3315 3316 3317 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3314 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.
3366 3367 3368 3369 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3366 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.
3425 3426 3427 3428 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3425 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.
3474 3475 3476 3477 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3474 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.
3529 3530 3531 3532 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3529 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.
3589 3590 3591 3592 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3589 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.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3643 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.
3705 3706 3707 3708 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3705 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.
3734 3735 3736 3737 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3734 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.
3792 3793 3794 3795 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3792 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.
3851 3852 3853 3854 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3851 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.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3905 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.
3981 3982 3983 3984 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3981 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.
4029 4030 4031 4032 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4029 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.
4086 4087 4088 4089 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4086 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.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4152 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.
4210 4211 4212 4213 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4210 def start_reference_import_job(params = {}, = {}) req = build_request(:start_reference_import_job, params) req.send_request() end |
#start_run(params = {}) ⇒ Types::StartRunResponse
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.
StartRun will not support re-run for a workflow that is shared with you.
The total number of runs in your account is subject to a quota per
Region. To avoid needing to delete runs manually, you can set the
retention mode to REMOVE
. Runs with this setting are deleted
automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the
storageCapacity
field. You can set the storage type to DYNAMIC. You
do not set storageCapacity
, because HealthOmics dynamically scales
the storage up or down as required. For more information about static
and dynamic storage, see Running workflows in the AWS
HealthOmics User Guide.
4346 4347 4348 4349 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4346 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.
4396 4397 4398 4399 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4396 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.
4424 4425 4426 4427 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4424 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4450 4451 4452 4453 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4450 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
4503 4504 4505 4506 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4503 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.
4553 4554 4555 4556 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4553 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.
4595 4596 4597 4598 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4595 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.
4639 4640 4641 4642 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4639 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
4669 4670 4671 4672 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4669 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.
4715 4716 4717 4718 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4715 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 |
4841 4842 4843 4844 4845 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4841 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |