AWS.MedicalImaging — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA eligible service that empowers healthcare providers, life science organizations, and their software partners to store, analyze, and share medical images in the cloud at petabyte scale. For an introduction to the service, see the AWS HealthImaging Developer Guide .

Note: We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.

The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide where you can view tested code examples.

Data store actions

Import job actions

Image set access actions

Image set modification actions

Tagging actions

Sending a Request Using MedicalImaging

var medicalimaging = new AWS.MedicalImaging();
medicalimaging.copyImageSet(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MedicalImaging object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var medicalimaging = new AWS.MedicalImaging({apiVersion: '2023-07-19'});

You can also set the API version globally in AWS.config.apiVersions using the medicalimaging service identifier:

AWS.config.apiVersions = {
  medicalimaging: '2023-07-19',
  // other service API versions
};

var medicalimaging = new AWS.MedicalImaging();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.MedicalImaging(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createDatastore(params = {}, callback) ⇒ AWS.Request

deleteDatastore(params = {}, callback) ⇒ AWS.Request

Delete a data store.

Note: Before a data store can be deleted, you must first delete all image sets within it.

deleteImageSet(params = {}, callback) ⇒ AWS.Request

getDatastore(params = {}, callback) ⇒ AWS.Request

Get data store properties.

getDICOMImportJob(params = {}, callback) ⇒ AWS.Request

Get the import job properties to learn more about the job or job progress.

Note: The 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.

getImageFrame(params = {}, callback) ⇒ AWS.Request

Get an image frame (pixel data) for an image set.

getImageSet(params = {}, callback) ⇒ AWS.Request

Get image set properties.

getImageSetMetadata(params = {}, callback) ⇒ AWS.Request

Get metadata attributes for an image set.

listDatastores(params = {}, callback) ⇒ AWS.Request

listDICOMImportJobs(params = {}, callback) ⇒ AWS.Request

List import jobs created for a specific data store.

listImageSetVersions(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags associated with a medical imaging resource.

searchImageSets(params = {}, callback) ⇒ AWS.Request

Search image sets based on defined input attributes.

Note: 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.

startDICOMImportJob(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds a user-specifed key and value tag to a medical imaging resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a medical imaging resource.

updateImageSetMetadata(params = {}, callback) ⇒ AWS.Request

Update image set metadata attributes.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given MedicalImaging resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.