We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.

Class: AWS.MedicalImaging

Inherits:
AWS.Service show all
Identifier:
medicalimaging
API Version:
2023-07-19
Defined in:
(unknown)

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();

Version:

  • 2023-07-19

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a MedicalImaging object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.MedicalImaging.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.MedicalImaging.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.MedicalImaging.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Copy an image set.

Service Reference:

Examples:

Calling the copyImageSet operation

var params = {
  copyImageSetInformation: { /* required */
    sourceImageSet: { /* required */
      latestVersionId: 'STRING_VALUE', /* required */
      DICOMCopies: {
        copiableAttributes: 'STRING_VALUE' /* required */
      }
    },
    destinationImageSet: {
      imageSetId: 'STRING_VALUE', /* required */
      latestVersionId: 'STRING_VALUE' /* required */
    }
  },
  datastoreId: 'STRING_VALUE', /* required */
  sourceImageSetId: 'STRING_VALUE', /* required */
  force: true || false
};
medicalimaging.copyImageSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • sourceImageSetId — (String)

      The source image set identifier.

    • copyImageSetInformation — (map)

      Copy image set information.

      • sourceImageSetrequired — (map)

        The source image set.

        • latestVersionIdrequired — (String)

          The latest version identifier for the source image set.

        • DICOMCopies — (map)

          Contains MetadataCopies structure and wraps information related to specific copy use cases. For example, when copying subsets.

          • copiableAttributesrequired — (String)

            The JSON string used to specify a subset of SOP Instances to copy from source to destination image set.

      • destinationImageSet — (map)

        The destination image set.

        • imageSetIdrequired — (String)

          The image set identifier for the destination image set.

        • latestVersionIdrequired — (String)

          The latest version identifier for the destination image set.

    • force — (Boolean)

      Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • sourceImageSetProperties — (map)

        The properties of the source image set.

        • imageSetIdrequired — (String)

          The image set identifier for the copied source image set.

        • latestVersionIdrequired — (String)

          The latest version identifier for the copied source image set.

        • imageSetState — (String)

          The image set state of the copied source image set.

          Possible values include:
          • "ACTIVE"
          • "LOCKED"
          • "DELETED"
        • imageSetWorkflowStatus — (String)

          The workflow status of the copied source image set.

          Possible values include:
          • "CREATED"
          • "COPIED"
          • "COPYING"
          • "COPYING_WITH_READ_ONLY_ACCESS"
          • "COPY_FAILED"
          • "UPDATING"
          • "UPDATED"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETED"
        • createdAt — (Date)

          The timestamp when the source image set properties were created.

        • updatedAt — (Date)

          The timestamp when the source image set properties were updated.

        • imageSetArn — (String)

          The Amazon Resource Name (ARN) assigned to the source image set.

      • destinationImageSetProperties — (map)

        The properties of the destination image set.

        • imageSetIdrequired — (String)

          The image set identifier of the copied image set properties.

        • latestVersionIdrequired — (String)

          The latest version identifier for the destination image set properties.

        • imageSetState — (String)

          The image set state of the destination image set properties.

          Possible values include:
          • "ACTIVE"
          • "LOCKED"
          • "DELETED"
        • imageSetWorkflowStatus — (String)

          The image set workflow status of the destination image set properties.

          Possible values include:
          • "CREATED"
          • "COPIED"
          • "COPYING"
          • "COPYING_WITH_READ_ONLY_ACCESS"
          • "COPY_FAILED"
          • "UPDATING"
          • "UPDATED"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETED"
        • createdAt — (Date)

          The timestamp when the destination image set properties were created.

        • updatedAt — (Date)

          The timestamp when the destination image set properties were last updated.

        • imageSetArn — (String)

          The Amazon Resource Name (ARN) assigned to the destination image set.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Create a data store.

Service Reference:

Examples:

Calling the createDatastore operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  datastoreName: 'STRING_VALUE',
  kmsKeyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
medicalimaging.createDatastore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreName — (String)

      The data store name.

    • clientToken — (String)

      A unique identifier for API idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • tags — (map<String>)

      The tags provided when creating a data store.

    • kmsKeyArn — (String)

      The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • datastoreStatus — (String)

        The data store status.

        Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the deleteDatastore operation

var params = {
  datastoreId: 'STRING_VALUE' /* required */
};
medicalimaging.deleteDatastore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • datastoreStatus — (String)

        The data store status.

        Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETING"
        • "DELETED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Delete an image set.

Service Reference:

Examples:

Calling the deleteImageSet operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageSetId: 'STRING_VALUE' /* required */
};
medicalimaging.deleteImageSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • imageSetId — (String)

        The image set identifier.

      • imageSetState — (String)

        The image set state.

        Possible values include:
        • "ACTIVE"
        • "LOCKED"
        • "DELETED"
      • imageSetWorkflowStatus — (String)

        The image set workflow status.

        Possible values include:
        • "CREATED"
        • "COPIED"
        • "COPYING"
        • "COPYING_WITH_READ_ONLY_ACCESS"
        • "COPY_FAILED"
        • "UPDATING"
        • "UPDATED"
        • "UPDATE_FAILED"
        • "DELETING"
        • "DELETED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get data store properties.

Service Reference:

Examples:

Calling the getDatastore operation

var params = {
  datastoreId: 'STRING_VALUE' /* required */
};
medicalimaging.getDatastore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreProperties — (map)

        The data store properties.

        • datastoreIdrequired — (String)

          The data store identifier.

        • datastoreNamerequired — (String)

          The data store name.

        • datastoreStatusrequired — (String)

          The data store status.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETING"
          • "DELETED"
        • kmsKeyArn — (String)

          The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data.

        • datastoreArn — (String)

          The Amazon Resource Name (ARN) for the data store.

        • createdAt — (Date)

          The timestamp when the data store was created.

        • updatedAt — (Date)

          The timestamp when the data store was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the getDICOMImportJob operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE' /* required */
};
medicalimaging.getDICOMImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • jobId — (String)

      The import job identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobProperties — (map)

        The properties of the import job.

        • jobIdrequired — (String)

          The import job identifier.

        • jobNamerequired — (String)

          The import job name.

        • jobStatusrequired — (String)

          The filters for listing import jobs based on status.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
        • datastoreIdrequired — (String)

          The data store identifier.

        • dataAccessRoleArnrequired — (String)

          The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

        • endedAt — (Date)

          The timestamp for when the import job was ended.

        • submittedAt — (Date)

          The timestamp for when the import job was submitted.

        • inputS3Urirequired — (String)

          The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.

        • outputS3Urirequired — (String)

          The output prefix of the S3 bucket to upload the results of the DICOM import job.

        • message — (String)

          The error message thrown if an import job fails.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the getImageFrame operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageFrameInformation: { /* required */
    imageFrameId: 'STRING_VALUE' /* required */
  },
  imageSetId: 'STRING_VALUE' /* required */
};
medicalimaging.getImageFrame(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

    • imageFrameInformation — (map)

      Information about the image frame (pixel data) identifier.

      • imageFrameIdrequired — (String)

        The image frame (pixel data) identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • imageFrameBlob — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        The blob containing the aggregated image frame information.

      • contentType — (String)

        The format in which the image frame information is returned to the customer. Default is application/octet-stream.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get image set properties.

Service Reference:

Examples:

Calling the getImageSet operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageSetId: 'STRING_VALUE', /* required */
  versionId: 'STRING_VALUE'
};
medicalimaging.getImageSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

    • versionId — (String)

      The image set version identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • imageSetId — (String)

        The image set identifier.

      • versionId — (String)

        The image set version identifier.

      • imageSetState — (String)

        The image set state.

        Possible values include:
        • "ACTIVE"
        • "LOCKED"
        • "DELETED"
      • imageSetWorkflowStatus — (String)

        The image set workflow status.

        Possible values include:
        • "CREATED"
        • "COPIED"
        • "COPYING"
        • "COPYING_WITH_READ_ONLY_ACCESS"
        • "COPY_FAILED"
        • "UPDATING"
        • "UPDATED"
        • "UPDATE_FAILED"
        • "DELETING"
        • "DELETED"
      • createdAt — (Date)

        The timestamp when image set properties were created.

      • updatedAt — (Date)

        The timestamp when image set properties were updated.

      • deletedAt — (Date)

        The timestamp when the image set properties were deleted.

      • message — (String)

        The error message thrown if an image set action fails.

      • imageSetArn — (String)

        The Amazon Resource Name (ARN) assigned to the image set.

      • overrides — (map)

        This object contains the details of any overrides used while creating a specific image set version. If an image set was copied or updated using the force flag, this object will contain the forced flag.

        • forced — (Boolean)

          Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Get metadata attributes for an image set.

Service Reference:

Examples:

Calling the getImageSetMetadata operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageSetId: 'STRING_VALUE', /* required */
  versionId: 'STRING_VALUE'
};
medicalimaging.getImageSetMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

    • versionId — (String)

      The image set version identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • imageSetMetadataBlob — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        The blob containing the aggregated metadata information for the image set.

      • contentType — (String)

        The format in which the study metadata is returned to the customer. Default is text/plain.

      • contentEncoding — (String)

        The compression format in which image set metadata attributes are returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List data stores.

Service Reference:

Examples:

Calling the listDatastores operation

var params = {
  datastoreStatus: CREATING | CREATE_FAILED | ACTIVE | DELETING | DELETED,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
medicalimaging.listDatastores(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreStatus — (String)

      The data store status.

      Possible values include:
      • "CREATING"
      • "CREATE_FAILED"
      • "ACTIVE"
      • "DELETING"
      • "DELETED"
    • nextToken — (String)

      The pagination token used to request the list of data stores on the next page.

    • maxResults — (Integer)

      Valid Range: Minimum value of 1. Maximum value of 50.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreSummaries — (Array<map>)

        The list of summaries of data stores.

        • datastoreIdrequired — (String)

          The data store identifier.

        • datastoreNamerequired — (String)

          The data store name.

        • datastoreStatusrequired — (String)

          The data store status.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETING"
          • "DELETED"
        • datastoreArn — (String)

          The Amazon Resource Name (ARN) for the data store.

        • createdAt — (Date)

          The timestamp when the data store was created.

        • updatedAt — (Date)

          The timestamp when the data store was last updated.

      • nextToken — (String)

        The pagination token used to retrieve the list of data stores on the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List import jobs created for a specific data store.

Service Reference:

Examples:

Calling the listDICOMImportJobs operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  jobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
medicalimaging.listDICOMImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • jobStatus — (String)

      The filters for listing import jobs based on status.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "FAILED"
    • nextToken — (String)

      The pagination token used to request the list of import jobs on the next page.

    • maxResults — (Integer)

      The max results count. The upper bound is determined by load testing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobSummaries — (Array<map>)

        A list of job summaries.

        • jobIdrequired — (String)

          The import job identifier.

        • jobNamerequired — (String)

          The import job name.

        • jobStatusrequired — (String)

          The filters for listing import jobs based on status.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
        • datastoreIdrequired — (String)

          The data store identifier.

        • dataAccessRoleArn — (String)

          The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.

        • endedAt — (Date)

          The timestamp when an import job ended.

        • submittedAt — (Date)

          The timestamp when an import job was submitted.

        • message — (String)

          The error message thrown if an import job fails.

      • nextToken — (String)

        The pagination token used to retrieve the list of import jobs on the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List image set versions.

Service Reference:

Examples:

Calling the listImageSetVersions operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageSetId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
medicalimaging.listImageSetVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

    • nextToken — (String)

      The pagination token used to request the list of image set versions on the next page.

    • maxResults — (Integer)

      The max results count.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • imageSetPropertiesList — (Array<map>)

        Lists all properties associated with an image set.

        • imageSetIdrequired — (String)

          The image set identifier.

        • versionIdrequired — (String)

          The image set version identifier.

        • imageSetStaterequired — (String)

          The image set state.

          Possible values include:
          • "ACTIVE"
          • "LOCKED"
          • "DELETED"
        • ImageSetWorkflowStatus — (String)

          The image set workflow status.

          Possible values include:
          • "CREATED"
          • "COPIED"
          • "COPYING"
          • "COPYING_WITH_READ_ONLY_ACCESS"
          • "COPY_FAILED"
          • "UPDATING"
          • "UPDATED"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETED"
        • createdAt — (Date)

          The timestamp when the image set properties were created.

        • updatedAt — (Date)

          The timestamp when the image set properties were updated.

        • deletedAt — (Date)

          The timestamp when the image set properties were deleted.

        • message — (String)

          The error message thrown if an image set action fails.

        • overrides — (map)

          Contains details on overrides used when creating the returned version of an image set. For example, if forced exists, the forced flag was used when creating the image set.

          • forced — (Boolean)

            Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.

      • nextToken — (String)

        The pagination token used to retrieve the list of image set versions on the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists all tags associated with a medical imaging resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
medicalimaging.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        A list of all tags associated with a medical imaging resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the searchImageSets operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  searchCriteria: {
    filters: [
      {
        operator: EQUAL | BETWEEN, /* required */
        values: [ /* required */
          {
            DICOMAccessionNumber: 'STRING_VALUE',
            DICOMPatientId: 'STRING_VALUE',
            DICOMSeriesInstanceUID: 'STRING_VALUE',
            DICOMStudyDateAndTime: {
              DICOMStudyDate: 'STRING_VALUE', /* required */
              DICOMStudyTime: 'STRING_VALUE'
            },
            DICOMStudyId: 'STRING_VALUE',
            DICOMStudyInstanceUID: 'STRING_VALUE',
            createdAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
            updatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    sort: {
      sortField: updatedAt | createdAt | DICOMStudyDateAndTime, /* required */
      sortOrder: ASC | DESC /* required */
    }
  }
};
medicalimaging.searchImageSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The identifier of the data store where the image sets reside.

    • searchCriteria — (map)

      The search criteria that filters by applying a maximum of 1 item to SearchByAttribute.

      • filters — (Array<map>)

        The filters for the search criteria.

        • valuesrequired — (Array<map>)

          The search filter values.

          • DICOMPatientId — (String)

            The patient ID input for search.

          • DICOMAccessionNumber — (String)

            The DICOM accession number for search.

          • DICOMStudyId — (String)

            The DICOM study ID for search.

          • DICOMStudyInstanceUID — (String)

            The DICOM study instance UID for search.

          • DICOMSeriesInstanceUID — (String)

            The Series Instance UID input for search.

          • createdAt — (Date)

            The created at time of the image set provided for search.

          • updatedAt — (Date)

            The timestamp input for search.

          • DICOMStudyDateAndTime — (map)

            The aggregated structure containing DICOM study date and study time for search.

            • DICOMStudyDaterequired — (String)

              The DICOM study date provided in yyMMdd format.

            • DICOMStudyTime — (String)

              The DICOM study time provided in HHmmss.FFFFFF format.

        • operatorrequired — (String)

          The search filter operator for imageSetDateTime.

          Possible values include:
          • "EQUAL"
          • "BETWEEN"
      • sort — (map)

        The sort input for search criteria.

        • sortOrderrequired — (String)

          The sort order for search criteria.

          Possible values include:
          • "ASC"
          • "DESC"
        • sortFieldrequired — (String)

          The sort field for search criteria.

          Possible values include:
          • "updatedAt"
          • "createdAt"
          • "DICOMStudyDateAndTime"
    • maxResults — (Integer)

      The maximum number of results that can be returned in a search.

    • nextToken — (String)

      The token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • imageSetsMetadataSummaries — (Array<map>)

        The model containing the image set results.

        • imageSetIdrequired — (String)

          The image set identifier.

        • version — (Integer)

          The image set version.

        • createdAt — (Date)

          The time an image set is created. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.

        • updatedAt — (Date)

          The time an image set was last updated.

        • DICOMTags — (map)

          The DICOM tags associated with the image set.

          • DICOMPatientId — (String)

            The unique identifier for a patient in a DICOM Study.

          • DICOMPatientName — (String)

            The patient name.

          • DICOMPatientBirthDate — (String)

            The patient birth date.

          • DICOMPatientSex — (String)

            The patient sex.

          • DICOMStudyInstanceUID — (String)

            The DICOM provided identifier for the Study Instance UID.

          • DICOMStudyId — (String)

            The DICOM provided identifier for the Study ID.

          • DICOMStudyDescription — (String)

            The DICOM provided Study Description.

          • DICOMNumberOfStudyRelatedSeries — (Integer)

            The total number of series in the DICOM study.

          • DICOMNumberOfStudyRelatedInstances — (Integer)

            The total number of instances in the DICOM study.

          • DICOMAccessionNumber — (String)

            The accession number for the DICOM study.

          • DICOMSeriesInstanceUID — (String)

            The DICOM provided identifier for the Series Instance UID.

          • DICOMSeriesModality — (String)

            The DICOM provided identifier for the series Modality.

          • DICOMSeriesBodyPart — (String)

            The DICOM provided identifier for the series Body Part Examined.

          • DICOMSeriesNumber — (Integer)

            The DICOM provided identifier for the Series Number.

          • DICOMStudyDate — (String)

            The study date.

          • DICOMStudyTime — (String)

            The study time.

      • sort — (map)

        The sort order for image set search results.

        • sortOrderrequired — (String)

          The sort order for search criteria.

          Possible values include:
          • "ASC"
          • "DESC"
        • sortFieldrequired — (String)

          The sort field for search criteria.

          Possible values include:
          • "updatedAt"
          • "createdAt"
          • "DICOMStudyDateAndTime"
      • nextToken — (String)

        The token for pagination results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the startDICOMImportJob operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  dataAccessRoleArn: 'STRING_VALUE', /* required */
  datastoreId: 'STRING_VALUE', /* required */
  inputS3Uri: 'STRING_VALUE', /* required */
  outputS3Uri: 'STRING_VALUE', /* required */
  inputOwnerAccountId: 'STRING_VALUE',
  jobName: 'STRING_VALUE'
};
medicalimaging.startDICOMImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobName — (String)

      The import job name.

    • dataAccessRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.

    • clientToken — (String)

      A unique identifier for API idempotency.

      If a token is not provided, the SDK will use a version 4 UUID.
    • datastoreId — (String)

      The data store identifier.

    • inputS3Uri — (String)

      The input prefix path for the S3 bucket that contains the DICOM files to be imported.

    • outputS3Uri — (String)

      The output prefix of the S3 bucket to upload the results of the DICOM import job.

    • inputOwnerAccountId — (String)

      The account ID of the source S3 bucket owner.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • jobId — (String)

        The import job identifier.

      • jobStatus — (String)

        The import job status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
      • submittedAt — (Date)

        The timestamp when the import job was submitted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
medicalimaging.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.

    • tags — (map<String>)

      The user-specified key and value tag pairs added to a medical imaging resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from a medical imaging resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
medicalimaging.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.

    • tagKeys — (Array<String>)

      The keys for the tags to be removed from the medical imaging resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Update image set metadata attributes.

Service Reference:

Examples:

Calling the updateImageSetMetadata operation

var params = {
  datastoreId: 'STRING_VALUE', /* required */
  imageSetId: 'STRING_VALUE', /* required */
  latestVersionId: 'STRING_VALUE', /* required */
  updateImageSetMetadataUpdates: { /* required */
    DICOMUpdates: {
      removableAttributes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
      updatableAttributes: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
    },
    revertToVersionId: 'STRING_VALUE'
  },
  force: true || false
};
medicalimaging.updateImageSetMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • datastoreId — (String)

      The data store identifier.

    • imageSetId — (String)

      The image set identifier.

    • latestVersionId — (String)

      The latest image set version identifier.

    • force — (Boolean)

      Setting this flag will force the UpdateImageSetMetadata operation for the following attributes:

      • Tag.StudyInstanceUID, Tag.SeriesInstanceUID, Tag.SOPInstanceUID, and Tag.StudyID

      • Adding, removing, or updating private tags for an individual SOP Instance

    • updateImageSetMetadataUpdates — (map)

      Update image set metadata updates.

      • DICOMUpdates — (map)

        The object containing removableAttributes and updatableAttributes.

        • removableAttributes — (Buffer, Typed Array, Blob, String)

          The DICOM tags to be removed from ImageSetMetadata.

        • updatableAttributes — (Buffer, Typed Array, Blob, String)

          The DICOM tags that need to be updated in ImageSetMetadata.

      • revertToVersionId — (String)

        Specifies the previous image set version ID to revert the current image set back to.

        Note: You must provide either revertToVersionId or DICOMUpdates in your request. A ValidationException error is thrown if both parameters are provided at the same time.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • datastoreId — (String)

        The data store identifier.

      • imageSetId — (String)

        The image set identifier.

      • latestVersionId — (String)

        The latest image set version identifier.

      • imageSetState — (String)

        The image set state.

        Possible values include:
        • "ACTIVE"
        • "LOCKED"
        • "DELETED"
      • imageSetWorkflowStatus — (String)

        The image set workflow status.

        Possible values include:
        • "CREATED"
        • "COPIED"
        • "COPYING"
        • "COPYING_WITH_READ_ONLY_ACCESS"
        • "COPY_FAILED"
        • "UPDATING"
        • "UPDATED"
        • "UPDATE_FAILED"
        • "DELETING"
        • "DELETED"
      • createdAt — (Date)

        The timestamp when image set metadata was created.

      • updatedAt — (Date)

        The timestamp when image set metadata was updated.

      • message — (String)

        The error message thrown if an update image set metadata action fails.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.