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
-
#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.
-
#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse
Creates an annotation store.
-
#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_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_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_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_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_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_stores(params = {}) ⇒ Types::ListAnnotationStoresResponse
Retrieves a list of annotation stores.
-
#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_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_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 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_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.
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.
365 366 367 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#batch_delete_read_set(params = {}) ⇒ Types::BatchDeleteReadSetResponse
Deletes one or more read sets.
401 402 403 404 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 401 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.
423 424 425 426 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 423 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.
445 446 447 448 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 445 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.
467 468 469 470 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 467 def cancel_variant_import_job(params = {}, = {}) req = build_request(:cancel_variant_import_job, params) req.send_request() end |
#create_annotation_store(params = {}) ⇒ Types::CreateAnnotationStoreResponse
Creates an annotation store.
555 556 557 558 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 555 def create_annotation_store(params = {}, = {}) req = build_request(:create_annotation_store, params) req.send_request() end |
#create_reference_store(params = {}) ⇒ Types::CreateReferenceStoreResponse
Creates a reference store.
616 617 618 619 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 616 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.
675 676 677 678 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 675 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.
736 737 738 739 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 736 def create_sequence_store(params = {}, = {}) req = build_request(:create_sequence_store, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
795 796 797 798 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 795 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
877 878 879 880 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 877 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
909 910 911 912 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 909 def delete_annotation_store(params = {}, = {}) req = build_request(:delete_annotation_store, params) req.send_request() end |
#delete_reference(params = {}) ⇒ Struct
Deletes a genome reference.
935 936 937 938 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 935 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
957 958 959 960 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 957 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
979 980 981 982 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 979 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1001 1002 1003 1004 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1001 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.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1023 def delete_sequence_store(params = {}, = {}) req = build_request(:delete_sequence_store, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1055 1056 1057 1058 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1055 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1077 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
1142 1143 1144 1145 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1142 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
1209 1210 1211 1212 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1209 def get_annotation_store(params = {}, = {}) req = build_request(:get_annotation_store, params) req.send_request() end |
#get_read_set(params = {}) ⇒ Types::GetReadSetResponse
Gets a file from a read set.
1249 1250 1251 1252 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1249 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
1301 1302 1303 1304 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1301 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
1355 1356 1357 1358 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1355 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
1419 1420 1421 1422 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1419 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.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1486 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1530 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
1588 1589 1590 1591 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1588 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.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1643 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.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1682 def get_reference_store(params = {}, = {}) req = build_request(:get_reference_store, params) req.send_request() end |
#get_run(params = {}) ⇒ Types::GetRunResponse
Gets information about a workflow run.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- run_completed
- run_running
1765 1766 1767 1768 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1765 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.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1808 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
1864 1865 1866 1867 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1864 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.
1903 1904 1905 1906 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1903 def get_sequence_store(params = {}, = {}) req = build_request(:get_sequence_store, 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
1957 1958 1959 1960 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1957 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
2015 2016 2017 2018 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2015 def get_variant_store(params = {}, = {}) req = build_request(:get_variant_store, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Gets information about a workflow.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- workflow_active
2087 2088 2089 2090 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2087 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.
2143 2144 2145 2146 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2143 def list_annotation_import_jobs(params = {}, = {}) req = build_request(:list_annotation_import_jobs, 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.
2203 2204 2205 2206 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2203 def list_annotation_stores(params = {}, = {}) req = build_request(:list_annotation_stores, 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.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2258 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.
2313 2314 2315 2316 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2313 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.
2368 2369 2370 2371 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2368 def list_read_set_import_jobs(params = {}, = {}) req = build_request(:list_read_set_import_jobs, 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.
2434 2435 2436 2437 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2434 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.
2489 2490 2491 2492 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2489 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.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2541 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.
2600 2601 2602 2603 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2600 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.
2648 2649 2650 2651 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2648 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.
2701 2702 2703 2704 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2701 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.
2756 2757 2758 2759 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2756 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.
2808 2809 2810 2811 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2808 def list_sequence_stores(params = {}, = {}) req = build_request(:list_sequence_stores, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves a list of tags for a resource.
2837 2838 2839 2840 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2837 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.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2893 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.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2952 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.
3004 3005 3006 3007 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3004 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.
3070 3071 3072 3073 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3070 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.
3118 3119 3120 3121 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3118 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.
3175 3176 3177 3178 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3175 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.
3241 3242 3243 3244 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3241 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.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3299 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 run.
3394 3395 3396 3397 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3394 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.
3438 3439 3440 3441 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3438 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.
3466 3467 3468 3469 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3466 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3492 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
3545 3546 3547 3548 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3545 def update_annotation_store(params = {}, = {}) req = build_request(:update_annotation_store, params) req.send_request() end |
#update_run_group(params = {}) ⇒ Struct
Updates a run group.
3583 3584 3585 3586 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3583 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.
3627 3628 3629 3630 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3627 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
3657 3658 3659 3660 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3657 def update_workflow(params = {}, = {}) req = build_request(:update_workflow, 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 |
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 |
3781 3782 3783 3784 3785 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3781 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |