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
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_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.
444 445 446 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 444 def initialize(*args) super end |
Instance Method Details
#abort_multipart_read_set_upload(params = {}) ⇒ Struct
Stops a multipart upload.
471 472 473 474 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 471 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.
499 500 501 502 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 499 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.
534 535 536 537 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 534 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.
556 557 558 559 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 556 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.
578 579 580 581 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 578 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.
600 601 602 603 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 600 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.
643 644 645 646 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 643 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.
738 739 740 741 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 738 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.
815 816 817 818 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 815 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.
904 905 906 907 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 904 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.
965 966 967 968 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 965 def create_reference_store(params = {}, = {}) req = build_request(:create_reference_store, 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.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1032 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.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1106 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
1157 1158 1159 1160 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1157 def create_share(params = {}, = {}) req = build_request(:create_share, params) req.send_request() end |
#create_variant_store(params = {}) ⇒ Types::CreateVariantStoreResponse
Creates a variant store.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1216 def create_variant_store(params = {}, = {}) req = build_request(:create_variant_store, params) req.send_request() end |
#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse
Creates a workflow.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1302 def create_workflow(params = {}, = {}) req = build_request(:create_workflow, params) req.send_request() end |
#delete_annotation_store(params = {}) ⇒ Types::DeleteAnnotationStoreResponse
Deletes an annotation store.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1334 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.
1374 1375 1376 1377 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1374 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.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1400 def delete_reference(params = {}, = {}) req = build_request(:delete_reference, params) req.send_request() end |
#delete_reference_store(params = {}) ⇒ Struct
Deletes a genome reference store.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1422 def delete_reference_store(params = {}, = {}) req = build_request(:delete_reference_store, params) req.send_request() end |
#delete_run(params = {}) ⇒ Struct
Deletes a workflow run.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1444 def delete_run(params = {}, = {}) req = build_request(:delete_run, params) req.send_request() end |
#delete_run_group(params = {}) ⇒ Struct
Deletes a workflow run group.
1466 1467 1468 1469 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1466 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.
1488 1489 1490 1491 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1488 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.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1518 def delete_share(params = {}, = {}) req = build_request(:delete_share, params) req.send_request() end |
#delete_variant_store(params = {}) ⇒ Types::DeleteVariantStoreResponse
Deletes a variant store.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1550 def delete_variant_store(params = {}, = {}) req = build_request(:delete_variant_store, params) req.send_request() end |
#delete_workflow(params = {}) ⇒ Struct
Deletes a workflow.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1572 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
1642 1643 1644 1645 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1642 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
1711 1712 1713 1714 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1711 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
1781 1782 1783 1784 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1781 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1821 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
1873 1874 1875 1876 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1873 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
1927 1928 1929 1930 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1927 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
1992 1993 1994 1995 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 1992 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.
2072 2073 2074 2075 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2072 def (params = {}, = {}) req = build_request(:get_read_set_metadata, params) req.send_request() end |
#get_reference(params = {}) ⇒ Types::GetReferenceResponse
Gets a reference file.
2116 2117 2118 2119 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2116 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
2175 2176 2177 2178 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2175 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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2236 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.
2275 2276 2277 2278 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2275 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
2378 2379 2380 2381 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2378 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.
2423 2424 2425 2426 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2423 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
2485 2486 2487 2488 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2485 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.
2531 2532 2533 2534 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2531 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.
2568 2569 2570 2571 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2568 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
2625 2626 2627 2628 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2625 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
2683 2684 2685 2686 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2683 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
2766 2767 2768 2769 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2766 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.
2825 2826 2827 2828 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2825 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.
2884 2885 2886 2887 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2884 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.
2944 2945 2946 2947 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 2944 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.
3000 3001 3002 3003 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3000 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.
3055 3056 3057 3058 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3055 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.
3110 3111 3112 3113 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3110 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.
3165 3166 3167 3168 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3165 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.
3230 3231 3232 3233 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3230 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.
3305 3306 3307 3308 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3305 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.
3360 3361 3362 3363 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3360 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.
3412 3413 3414 3415 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3412 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.
3471 3472 3473 3474 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3471 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.
3520 3521 3522 3523 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3520 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.
3575 3576 3577 3578 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3575 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.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3635 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.
3689 3690 3691 3692 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3689 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.
3751 3752 3753 3754 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3751 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.
3780 3781 3782 3783 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3780 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.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3838 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.
3897 3898 3899 3900 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3897 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.
3951 3952 3953 3954 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 3951 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.
4027 4028 4029 4030 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4027 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.
4075 4076 4077 4078 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4075 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.
4132 4133 4134 4135 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4132 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.
4198 4199 4200 4201 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4198 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.
4256 4257 4258 4259 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4256 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.
4392 4393 4394 4395 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4392 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.
4442 4443 4444 4445 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4442 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.
4470 4471 4472 4473 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4470 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
4496 4497 4498 4499 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4496 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_annotation_store(params = {}) ⇒ Types::UpdateAnnotationStoreResponse
Updates an annotation store.
4549 4550 4551 4552 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4549 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.
4599 4600 4601 4602 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4599 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.
4641 4642 4643 4644 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4641 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.
4685 4686 4687 4688 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4685 def update_variant_store(params = {}, = {}) req = build_request(:update_variant_store, params) req.send_request() end |
#update_workflow(params = {}) ⇒ Struct
Updates a workflow.
4715 4716 4717 4718 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4715 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.
4761 4762 4763 4764 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4761 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 |
4892 4893 4894 4895 4896 |
# File 'gems/aws-sdk-omics/lib/aws-sdk-omics/client.rb', line 4892 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |