Class: AWS.MedicalImaging

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.

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.

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.

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.

      • datastoreId — required — (String)

        The data store identifier.

      • datastoreName — required — (String)

        The data store name.

      • datastoreStatus — required — (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.

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.

      • jobId — required — (String)

        The import job identifier.

      • jobName — required — (String)

        The import job name.

      • jobStatus — required — (String)

        The filters for listing import jobs based on status.

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

        The data store identifier.

      • dataAccessRoleArn — required — (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.

      • inputS3Uri — required — (String)

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

      • outputS3Uri — required — (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.

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.

    • imageFrameId — required — (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.

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.

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.

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.

      • datastoreId — required — (String)

        The data store identifier.

      • datastoreName — required — (String)

        The data store name.

      • datastoreStatus — required — (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.

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.

      • jobId — required — (String)

        The import job identifier.

      • jobName — required — (String)

        The import job name.

      • jobStatus — required — (String)

        The filters for listing import jobs based on status.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "FAILED"
      • datastoreId — required — (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.

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.

      • imageSetId — required — (String)

        The image set identifier.

      • versionId — required — (String)

        The image set version identifier.

      • imageSetState — required — (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.

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.

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.

      • values — required — (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.

          • DICOMStudyDate — required — (String)

            The DICOM study date provided in yyMMdd format.

          • DICOMStudyTime — (String)

            The DICOM study time provided in HHmmss.FFFFFF format.

      • operator — required — (String)

        The search filter operator for imageSetDateTime.

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

      The sort input for search criteria.

      • sortOrder — required — (String)

        The sort order for search criteria.

        Possible values include:
        • "ASC"
        • "DESC"
      • sortField — required — (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.

      • imageSetId — required — (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.

      • sortOrder — required — (String)

        The sort order for search criteria.

        Possible values include:
        • "ASC"
        • "DESC"
      • sortField — required — (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.

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.

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.

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.

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.

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.