Class: Aws::MedicalImaging::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MedicalImaging::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb
Overview
An API client for MedicalImaging. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MedicalImaging::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
-
#copy_image_set(params = {}) ⇒ Types::CopyImageSetResponse
Copy an image set.
-
#create_datastore(params = {}) ⇒ Types::CreateDatastoreResponse
Create a data store.
-
#delete_datastore(params = {}) ⇒ Types::DeleteDatastoreResponse
Delete a data store.
-
#delete_image_set(params = {}) ⇒ Types::DeleteImageSetResponse
Delete an image set.
-
#get_datastore(params = {}) ⇒ Types::GetDatastoreResponse
Get data store properties.
-
#get_dicom_import_job(params = {}) ⇒ Types::GetDICOMImportJobResponse
Get the import job properties to learn more about the job or job progress.
-
#get_image_frame(params = {}) ⇒ Types::GetImageFrameResponse
Get an image frame (pixel data) for an image set.
-
#get_image_set(params = {}) ⇒ Types::GetImageSetResponse
Get image set properties.
-
#get_image_set_metadata(params = {}) ⇒ Types::GetImageSetMetadataResponse
Get metadata attributes for an image set.
-
#list_datastores(params = {}) ⇒ Types::ListDatastoresResponse
List data stores.
-
#list_dicom_import_jobs(params = {}) ⇒ Types::ListDICOMImportJobsResponse
List import jobs created for a specific data store.
-
#list_image_set_versions(params = {}) ⇒ Types::ListImageSetVersionsResponse
List image set versions.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a medical imaging resource.
-
#search_image_sets(params = {}) ⇒ Types::SearchImageSetsResponse
Search image sets based on defined input attributes.
-
#start_dicom_import_job(params = {}) ⇒ Types::StartDICOMImportJobResponse
Start importing bulk data into an
ACTIVE
data store. -
#tag_resource(params = {}) ⇒ Struct
Adds a user-specifed key and value tag to a medical imaging resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a medical imaging resource.
-
#update_image_set_metadata(params = {}) ⇒ Types::UpdateImageSetMetadataResponse
Update image set metadata attributes.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#copy_image_set(params = {}) ⇒ Types::CopyImageSetResponse
Copy an image set.
471 472 473 474 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 471 def copy_image_set(params = {}, = {}) req = build_request(:copy_image_set, params) req.send_request() end |
#create_datastore(params = {}) ⇒ Types::CreateDatastoreResponse
Create a data store.
519 520 521 522 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 519 def create_datastore(params = {}, = {}) req = build_request(:create_datastore, params) req.send_request() end |
#delete_datastore(params = {}) ⇒ Types::DeleteDatastoreResponse
Delete a data store.
554 555 556 557 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 554 def delete_datastore(params = {}, = {}) req = build_request(:delete_datastore, params) req.send_request() end |
#delete_image_set(params = {}) ⇒ Types::DeleteImageSetResponse
Delete an image set.
592 593 594 595 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 592 def delete_image_set(params = {}, = {}) req = build_request(:delete_image_set, params) req.send_request() end |
#get_datastore(params = {}) ⇒ Types::GetDatastoreResponse
Get data store properties.
677 678 679 680 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 677 def get_datastore(params = {}, = {}) req = build_request(:get_datastore, params) req.send_request() end |
#get_dicom_import_job(params = {}) ⇒ Types::GetDICOMImportJobResponse
Get the import job properties to learn more about the job or job progress.
jobStatus
refers to the execution of the import job. Therefore,
an import job can return a jobStatus
as COMPLETED
even if
validation issues are discovered during the import process. If a
jobStatus
returns as COMPLETED
, we still recommend you review the
output manifests written to S3, as they provide details on the success
or failure of individual P10 object imports.
643 644 645 646 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 643 def get_dicom_import_job(params = {}, = {}) req = build_request(:get_dicom_import_job, params) req.send_request() end |
#get_image_frame(params = {}) ⇒ Types::GetImageFrameResponse
Get an image frame (pixel data) for an image set.
717 718 719 720 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 717 def get_image_frame(params = {}, = {}, &block) req = build_request(:get_image_frame, params) req.send_request(, &block) end |
#get_image_set(params = {}) ⇒ Types::GetImageSetResponse
Get image set properties.
771 772 773 774 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 771 def get_image_set(params = {}, = {}) req = build_request(:get_image_set, params) req.send_request() end |
#get_image_set_metadata(params = {}) ⇒ Types::GetImageSetMetadataResponse
Get metadata attributes for an image set.
811 812 813 814 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 811 def (params = {}, = {}, &block) req = build_request(:get_image_set_metadata, params) req.send_request(, &block) end |
#list_datastores(params = {}) ⇒ Types::ListDatastoresResponse
List data stores.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
911 912 913 914 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 911 def list_datastores(params = {}, = {}) req = build_request(:list_datastores, params) req.send_request() end |
#list_dicom_import_jobs(params = {}) ⇒ Types::ListDICOMImportJobsResponse
List import jobs created for a specific data store.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
864 865 866 867 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 864 def list_dicom_import_jobs(params = {}, = {}) req = build_request(:list_dicom_import_jobs, params) req.send_request() end |
#list_image_set_versions(params = {}) ⇒ Types::ListImageSetVersionsResponse
List image set versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
964 965 966 967 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 964 def list_image_set_versions(params = {}, = {}) req = build_request(:list_image_set_versions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a medical imaging resource.
994 995 996 997 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 994 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#search_image_sets(params = {}) ⇒ Types::SearchImageSetsResponse
Search image sets based on defined input attributes.
SearchImageSets
accepts a single search query parameter and returns
a paginated response of all image sets that have the matching
criteria. All date range queries must be input as (lowerBound,
upperBound)
.
By default, SearchImageSets
uses the updatedAt
field for sorting
in descending order from newest to oldest.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1099 def search_image_sets(params = {}, = {}) req = build_request(:search_image_sets, params) req.send_request() end |
#start_dicom_import_job(params = {}) ⇒ Types::StartDICOMImportJobResponse
Start importing bulk data into an ACTIVE
data store. The import job
imports DICOM P10 files found in the S3 prefix specified by the
inputS3Uri
parameter. The import job stores processing results in
the file specified by the outputS3Uri
parameter.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1166 def start_dicom_import_job(params = {}, = {}) req = build_request(:start_dicom_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a user-specifed key and value tag to a medical imaging resource.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1196 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a medical imaging resource.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1223 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_image_set_metadata(params = {}) ⇒ Types::UpdateImageSetMetadataResponse
Update image set metadata attributes.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-medicalimaging/lib/aws-sdk-medicalimaging/client.rb', line 1282 def (params = {}, = {}) req = build_request(:update_image_set_metadata, params) req.send_request() end |