{ "version":"2.0", "metadata":{ "apiVersion":"2023-07-19", "endpointPrefix":"medical-imaging", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS Health Imaging", "serviceId":"Medical Imaging", "signatureVersion":"v4", "signingName":"medical-imaging", "uid":"medical-imaging-2023-07-19" }, "operations":{ "CopyImageSet":{ "name":"CopyImageSet", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{sourceImageSetId}/copyImageSet", "responseCode":200 }, "input":{"shape":"CopyImageSetRequest"}, "output":{"shape":"CopyImageSetResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Copy an image set.

", "endpoint":{"hostPrefix":"runtime-"} }, "CreateDatastore":{ "name":"CreateDatastore", "http":{ "method":"POST", "requestUri":"/datastore", "responseCode":200 }, "input":{"shape":"CreateDatastoreRequest"}, "output":{"shape":"CreateDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Create a data store.

", "idempotent":true }, "DeleteDatastore":{ "name":"DeleteDatastore", "http":{ "method":"DELETE", "requestUri":"/datastore/{datastoreId}", "responseCode":200 }, "input":{"shape":"DeleteDatastoreRequest"}, "output":{"shape":"DeleteDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Delete a data store.

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

", "idempotent":true }, "DeleteImageSet":{ "name":"DeleteImageSet", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/deleteImageSet", "responseCode":200 }, "input":{"shape":"DeleteImageSetRequest"}, "output":{"shape":"DeleteImageSetResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Delete an image set.

", "endpoint":{"hostPrefix":"runtime-"}, "idempotent":true }, "GetDICOMImportJob":{ "name":"GetDICOMImportJob", "http":{ "method":"GET", "requestUri":"/getDICOMImportJob/datastore/{datastoreId}/job/{jobId}", "responseCode":200 }, "input":{"shape":"GetDICOMImportJobRequest"}, "output":{"shape":"GetDICOMImportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "GetDatastore":{ "name":"GetDatastore", "http":{ "method":"GET", "requestUri":"/datastore/{datastoreId}", "responseCode":200 }, "input":{"shape":"GetDatastoreRequest"}, "output":{"shape":"GetDatastoreResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get data store properties.

" }, "GetImageFrame":{ "name":"GetImageFrame", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageFrame", "responseCode":200 }, "input":{"shape":"GetImageFrameRequest"}, "output":{"shape":"GetImageFrameResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

", "endpoint":{"hostPrefix":"runtime-"} }, "GetImageSet":{ "name":"GetImageSet", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSet", "responseCode":200 }, "input":{"shape":"GetImageSetRequest"}, "output":{"shape":"GetImageSetResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get image set properties.

", "endpoint":{"hostPrefix":"runtime-"} }, "GetImageSetMetadata":{ "name":"GetImageSetMetadata", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/getImageSetMetadata", "responseCode":200 }, "input":{"shape":"GetImageSetMetadataRequest"}, "output":{"shape":"GetImageSetMetadataResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get metadata attributes for an image set.

", "endpoint":{"hostPrefix":"runtime-"} }, "ListDICOMImportJobs":{ "name":"ListDICOMImportJobs", "http":{ "method":"GET", "requestUri":"/listDICOMImportJobs/datastore/{datastoreId}", "responseCode":200 }, "input":{"shape":"ListDICOMImportJobsRequest"}, "output":{"shape":"ListDICOMImportJobsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List import jobs created for a specific data store.

" }, "ListDatastores":{ "name":"ListDatastores", "http":{ "method":"GET", "requestUri":"/datastore", "responseCode":200 }, "input":{"shape":"ListDatastoresRequest"}, "output":{"shape":"ListDatastoresResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"

List data stores.

" }, "ListImageSetVersions":{ "name":"ListImageSetVersions", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/listImageSetVersions", "responseCode":200 }, "input":{"shape":"ListImageSetVersionsRequest"}, "output":{"shape":"ListImageSetVersionsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List image set versions.

", "endpoint":{"hostPrefix":"runtime-"} }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all tags associated with a medical imaging resource.

" }, "SearchImageSets":{ "name":"SearchImageSets", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/searchImageSets", "responseCode":200 }, "input":{"shape":"SearchImageSetsRequest"}, "output":{"shape":"SearchImageSetsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Search image sets based on defined input attributes.

`SearchImageSets` accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All range queries must be input as `(lowerBound, upperBound)`.

`SearchImageSets` uses the `updatedAt` field for sorting in decreasing order from latest to oldest.

", "endpoint":{"hostPrefix":"runtime-"} }, "StartDICOMImportJob":{ "name":"StartDICOMImportJob", "http":{ "method":"POST", "requestUri":"/startDICOMImportJob/datastore/{datastoreId}", "responseCode":200 }, "input":{"shape":"StartDICOMImportJobRequest"}, "output":{"shape":"StartDICOMImportJobResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes tags from a medical imaging resource.

", "idempotent":true }, "UpdateImageSetMetadata":{ "name":"UpdateImageSetMetadata", "http":{ "method":"POST", "requestUri":"/datastore/{datastoreId}/imageSet/{imageSetId}/updateImageSetMetadata", "responseCode":200 }, "input":{"shape":"UpdateImageSetMetadataRequest"}, "output":{"shape":"UpdateImageSetMetadataResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Update image set metadata attributes.

", "endpoint":{"hostPrefix":"runtime-"} } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The user does not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Arn":{ "type":"string", "pattern":"arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:medical-imaging:[a-z0-9-]+:[0-9]{12}:datastore/[0-9a-z]{32}(/imageset/[0-9a-z]{32})?" }, "ClientToken":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9._-]+" }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

Updating or deleting a resource can cause an inconsistent state.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CopyDestinationImageSet":{ "type":"structure", "required":[ "imageSetId", "latestVersionId" ], "members":{ "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier for the destination image set.

" }, "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest version identifier for the destination image set.

" } }, "documentation":"

Copy the destination image set.

" }, "CopyDestinationImageSetProperties":{ "type":"structure", "required":[ "imageSetId", "latestVersionId" ], "members":{ "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier of the copied image set properties.

" }, "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest version identifier for the destination image set properties.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state of the destination image set properties.

" }, "imageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

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

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when the destination image set properties were created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

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

" }, "imageSetArn":{ "shape":"Arn", "documentation":"

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

" } }, "documentation":"

Copy the image set properties of the destination image set.

" }, "CopyImageSetInformation":{ "type":"structure", "required":["sourceImageSet"], "members":{ "sourceImageSet":{ "shape":"CopySourceImageSetInformation", "documentation":"

The source image set.

" }, "destinationImageSet":{ "shape":"CopyDestinationImageSet", "documentation":"

The destination image set.

" } }, "documentation":"

Copy image set information.

" }, "CopyImageSetRequest":{ "type":"structure", "required":[ "datastoreId", "sourceImageSetId", "copyImageSetInformation" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "sourceImageSetId":{ "shape":"ImageSetId", "documentation":"

The source image set identifier.

", "location":"uri", "locationName":"sourceImageSetId" }, "copyImageSetInformation":{ "shape":"CopyImageSetInformation", "documentation":"

Copy image set information.

" } }, "payload":"copyImageSetInformation" }, "CopyImageSetResponse":{ "type":"structure", "required":[ "datastoreId", "sourceImageSetProperties", "destinationImageSetProperties" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "sourceImageSetProperties":{ "shape":"CopySourceImageSetProperties", "documentation":"

The properties of the source image set.

" }, "destinationImageSetProperties":{ "shape":"CopyDestinationImageSetProperties", "documentation":"

The properties of the destination image set.

" } } }, "CopySourceImageSetInformation":{ "type":"structure", "required":["latestVersionId"], "members":{ "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest version identifier for the source image set.

" } }, "documentation":"

Copy source image set information.

" }, "CopySourceImageSetProperties":{ "type":"structure", "required":[ "imageSetId", "latestVersionId" ], "members":{ "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier for the copied source image set.

" }, "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest version identifier for the copied source image set.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state of the copied source image set.

" }, "imageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

The workflow status of the copied source image set.

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when the source image set properties were created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when the source image set properties were updated.

" }, "imageSetArn":{ "shape":"Arn", "documentation":"

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

" } }, "documentation":"

Copy source image set properties.

" }, "CreateDatastoreRequest":{ "type":"structure", "required":["clientToken"], "members":{ "datastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A unique identifier for API idempotency.

", "idempotencyToken":true }, "tags":{ "shape":"TagMap", "documentation":"

The tags provided when creating a data store.

" }, "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"

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

" } } }, "CreateDatastoreResponse":{ "type":"structure", "required":[ "datastoreId", "datastoreStatus" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "datastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" } } }, "DICOMAccessionNumber":{ "type":"string", "max":16, "min":0, "sensitive":true }, "DICOMAttribute":{ "type":"blob", "max":10000, "min":1, "sensitive":true }, "DICOMImportJobProperties":{ "type":"structure", "required":[ "jobId", "jobName", "jobStatus", "datastoreId", "dataAccessRoleArn", "inputS3Uri", "outputS3Uri" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" }, "jobName":{ "shape":"JobName", "documentation":"

The import job name.

" }, "jobStatus":{ "shape":"JobStatus", "documentation":"

The filters for listing import jobs based on status.

" }, "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "dataAccessRoleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "endedAt":{ "shape":"Date", "documentation":"

The timestamp for when the import job was ended.

" }, "submittedAt":{ "shape":"Date", "documentation":"

The timestamp for when the import job was submitted.

" }, "inputS3Uri":{ "shape":"S3Uri", "documentation":"

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

" }, "outputS3Uri":{ "shape":"S3Uri", "documentation":"

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

" }, "message":{ "shape":"Message", "documentation":"

The error message thrown if an import job fails.

" } }, "documentation":"

Properties of the import job.

" }, "DICOMImportJobSummaries":{ "type":"list", "member":{"shape":"DICOMImportJobSummary"} }, "DICOMImportJobSummary":{ "type":"structure", "required":[ "jobId", "jobName", "jobStatus", "datastoreId" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" }, "jobName":{ "shape":"JobName", "documentation":"

The import job name.

" }, "jobStatus":{ "shape":"JobStatus", "documentation":"

The filters for listing import jobs based on status.

" }, "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "dataAccessRoleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "endedAt":{ "shape":"Date", "documentation":"

The timestamp when an import job ended.

" }, "submittedAt":{ "shape":"Date", "documentation":"

The timestamp when an import job was submitted.

" }, "message":{ "shape":"Message", "documentation":"

The error message thrown if an import job fails.

" } }, "documentation":"

Summary of import job.

" }, "DICOMNumberOfStudyRelatedInstances":{ "type":"integer", "max":10000, "min":0 }, "DICOMNumberOfStudyRelatedSeries":{ "type":"integer", "max":10000, "min":0 }, "DICOMPatientBirthDate":{ "type":"string", "max":18, "min":0, "sensitive":true }, "DICOMPatientId":{ "type":"string", "max":64, "min":0, "sensitive":true }, "DICOMPatientName":{ "type":"string", "max":256, "min":0, "sensitive":true }, "DICOMPatientSex":{ "type":"string", "max":16, "min":0, "sensitive":true }, "DICOMStudyDate":{ "type":"string", "max":18, "min":0, "sensitive":true }, "DICOMStudyDateAndTime":{ "type":"structure", "required":["DICOMStudyDate"], "members":{ "DICOMStudyDate":{ "shape":"DICOMStudyDate", "documentation":"

The DICOM study date provided in `yyMMdd` format.

" }, "DICOMStudyTime":{ "shape":"DICOMStudyTime", "documentation":"

The DICOM study time provided in `HHmmss.FFFFFF` format.

" } }, "documentation":"

The aggregated structure to store DICOM study date and study time for search capabilities.

" }, "DICOMStudyDescription":{ "type":"string", "max":64, "min":0, "sensitive":true }, "DICOMStudyId":{ "type":"string", "max":16, "min":0, "sensitive":true }, "DICOMStudyInstanceUID":{ "type":"string", "max":64, "min":0, "pattern":"(?:[1-9][0-9]*|0)(\\.(?:[1-9][0-9]*|0))*", "sensitive":true }, "DICOMStudyTime":{ "type":"string", "max":28, "min":0, "sensitive":true }, "DICOMTags":{ "type":"structure", "members":{ "DICOMPatientId":{ "shape":"DICOMPatientId", "documentation":"

The unique identifier for a patient in a DICOM Study.

" }, "DICOMPatientName":{ "shape":"DICOMPatientName", "documentation":"

The patient name.

" }, "DICOMPatientBirthDate":{ "shape":"DICOMPatientBirthDate", "documentation":"

The patient birth date.

" }, "DICOMPatientSex":{ "shape":"DICOMPatientSex", "documentation":"

The patient sex.

" }, "DICOMStudyInstanceUID":{ "shape":"DICOMStudyInstanceUID", "documentation":"

The DICOM provided identifier for studyInstanceUid.>

" }, "DICOMStudyId":{ "shape":"DICOMStudyId", "documentation":"

The DICOM provided studyId.

" }, "DICOMStudyDescription":{ "shape":"DICOMStudyDescription", "documentation":"

The description of the study.

" }, "DICOMNumberOfStudyRelatedSeries":{ "shape":"DICOMNumberOfStudyRelatedSeries", "documentation":"

The total number of series in the DICOM study.

" }, "DICOMNumberOfStudyRelatedInstances":{ "shape":"DICOMNumberOfStudyRelatedInstances", "documentation":"

The total number of instances in the DICOM study.

" }, "DICOMAccessionNumber":{ "shape":"DICOMAccessionNumber", "documentation":"

The accession number for the DICOM study.

" }, "DICOMStudyDate":{ "shape":"DICOMStudyDate", "documentation":"

The study date.

" }, "DICOMStudyTime":{ "shape":"DICOMStudyTime", "documentation":"

The study time.

" } }, "documentation":"

The DICOM attributes returned as a part of a response. Each image set has these properties as part of a search result.

" }, "DICOMUpdates":{ "type":"structure", "members":{ "removableAttributes":{ "shape":"DICOMAttribute", "documentation":"

The DICOM tags to be removed from `ImageSetMetadata`.

" }, "updatableAttributes":{ "shape":"DICOMAttribute", "documentation":"

The DICOM tags that need to be updated in `ImageSetMetadata`.

" } }, "documentation":"

The object containing `removableAttributes` and `updatableAttributes`.

" }, "DatastoreId":{ "type":"string", "pattern":"[0-9a-z]{32}" }, "DatastoreName":{ "type":"string", "max":256, "min":1, "pattern":"[A-Za-z0-9._/#-]+" }, "DatastoreProperties":{ "type":"structure", "required":[ "datastoreId", "datastoreName", "datastoreStatus" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "datastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name.

" }, "datastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" }, "kmsKeyArn":{ "shape":"KmsKeyArn", "documentation":"

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

" }, "datastoreArn":{ "shape":"Arn", "documentation":"

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

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when the data store was created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when the data store was last updated.

" } }, "documentation":"

The properties associated with the data store.

" }, "DatastoreStatus":{ "type":"string", "enum":[ "CREATING", "CREATE_FAILED", "ACTIVE", "DELETING", "DELETED" ] }, "DatastoreSummaries":{ "type":"list", "member":{"shape":"DatastoreSummary"} }, "DatastoreSummary":{ "type":"structure", "required":[ "datastoreId", "datastoreName", "datastoreStatus" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "datastoreName":{ "shape":"DatastoreName", "documentation":"

The data store name.

" }, "datastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" }, "datastoreArn":{ "shape":"Arn", "documentation":"

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

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when the data store was created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when the data store was last updated.

" } }, "documentation":"

List of summaries of data stores.

" }, "Date":{"type":"timestamp"}, "DeleteDatastoreRequest":{ "type":"structure", "required":["datastoreId"], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" } } }, "DeleteDatastoreResponse":{ "type":"structure", "required":[ "datastoreId", "datastoreStatus" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "datastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

" } } }, "DeleteImageSetRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" } } }, "DeleteImageSetResponse":{ "type":"structure", "required":[ "datastoreId", "imageSetId", "imageSetState", "imageSetWorkflowStatus" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state.

" }, "imageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

The image set workflow status.

" } } }, "GetDICOMImportJobRequest":{ "type":"structure", "required":[ "datastoreId", "jobId" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "jobId":{ "shape":"JobId", "documentation":"

The import job identifier.

", "location":"uri", "locationName":"jobId" } } }, "GetDICOMImportJobResponse":{ "type":"structure", "required":["jobProperties"], "members":{ "jobProperties":{ "shape":"DICOMImportJobProperties", "documentation":"

The properties of the import job.

" } } }, "GetDatastoreRequest":{ "type":"structure", "required":["datastoreId"], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" } } }, "GetDatastoreResponse":{ "type":"structure", "required":["datastoreProperties"], "members":{ "datastoreProperties":{ "shape":"DatastoreProperties", "documentation":"

The data store properties.

" } } }, "GetImageFrameRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId", "imageFrameInformation" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" }, "imageFrameInformation":{ "shape":"ImageFrameInformation", "documentation":"

Information about the image frame (pixel data) identifier.

" } }, "payload":"imageFrameInformation" }, "GetImageFrameResponse":{ "type":"structure", "required":["imageFrameBlob"], "members":{ "imageFrameBlob":{ "shape":"PayloadBlob", "documentation":"

The blob containing the aggregated image frame information.

" }, "contentType":{ "shape":"String", "documentation":"

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

", "location":"header", "locationName":"Content-Type" } }, "payload":"imageFrameBlob" }, "GetImageSetMetadataRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" }, "versionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The image set version identifier.

", "location":"querystring", "locationName":"version" } } }, "GetImageSetMetadataResponse":{ "type":"structure", "required":["imageSetMetadataBlob"], "members":{ "imageSetMetadataBlob":{ "shape":"ImageSetMetadataBlob", "documentation":"

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

" }, "contentType":{ "shape":"String", "documentation":"

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

", "location":"header", "locationName":"Content-Type" }, "contentEncoding":{ "shape":"String", "documentation":"

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

", "location":"header", "locationName":"Content-Encoding" } }, "payload":"imageSetMetadataBlob" }, "GetImageSetRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" }, "versionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The image set version identifier.

", "location":"querystring", "locationName":"version" } } }, "GetImageSetResponse":{ "type":"structure", "required":[ "datastoreId", "imageSetId", "versionId", "imageSetState" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

" }, "versionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The image set version identifier.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state.

" }, "imageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

The image set workflow status.

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when image set properties were created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when image set properties were updated.

" }, "deletedAt":{ "shape":"Date", "documentation":"

The timestamp when the image set properties were deleted.

" }, "message":{ "shape":"Message", "documentation":"

The error message thrown if an image set action fails.

" }, "imageSetArn":{ "shape":"Arn", "documentation":"

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

" } } }, "ImageFrameId":{ "type":"string", "pattern":"[0-9a-z]{32}" }, "ImageFrameInformation":{ "type":"structure", "required":["imageFrameId"], "members":{ "imageFrameId":{ "shape":"ImageFrameId", "documentation":"

The image frame (pixel data) identifier.

" } }, "documentation":"

Information about the image frame (pixel data) identifier.

" }, "ImageSetExternalVersionId":{ "type":"string", "pattern":"\\d+" }, "ImageSetId":{ "type":"string", "pattern":"[0-9a-z]{32}" }, "ImageSetMetadataBlob":{ "type":"blob", "streaming":true }, "ImageSetProperties":{ "type":"structure", "required":[ "imageSetId", "versionId", "imageSetState" ], "members":{ "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

" }, "versionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The image set version identifier.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state.

" }, "ImageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

The image set workflow status.

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when the image set properties were created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when the image set properties were updated.

" }, "deletedAt":{ "shape":"Date", "documentation":"

The timestamp when the image set properties were deleted.

" }, "message":{ "shape":"Message", "documentation":"

The error message thrown if an image set action fails.

" } }, "documentation":"

The image set properties.

" }, "ImageSetPropertiesList":{ "type":"list", "member":{"shape":"ImageSetProperties"} }, "ImageSetState":{ "type":"string", "enum":[ "ACTIVE", "LOCKED", "DELETED" ] }, "ImageSetWorkflowStatus":{ "type":"string", "enum":[ "CREATED", "COPIED", "COPYING", "COPYING_WITH_READ_ONLY_ACCESS", "COPY_FAILED", "UPDATING", "UPDATED", "UPDATE_FAILED", "DELETING", "DELETED" ] }, "ImageSetsMetadataSummaries":{ "type":"list", "member":{"shape":"ImageSetsMetadataSummary"} }, "ImageSetsMetadataSummary":{ "type":"structure", "required":["imageSetId"], "members":{ "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

" }, "version":{ "shape":"Integer", "documentation":"

The image set version.

" }, "createdAt":{ "shape":"Date", "documentation":"

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

" }, "updatedAt":{ "shape":"Date", "documentation":"

The time an image set was last updated.

" }, "DICOMTags":{ "shape":"DICOMTags", "documentation":"

The DICOM tags associated with the image set.

" } }, "documentation":"

Summary of the image set metadata.

" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

An unexpected error occurred during processing of the request.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "JobId":{ "type":"string", "max":32, "min":1, "pattern":"[0-9a-z]+" }, "JobName":{ "type":"string", "max":64, "min":1, "pattern":"[A-Za-z0-9._/#-]+" }, "JobStatus":{ "type":"string", "enum":[ "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "KmsKeyArn":{ "type":"string", "documentation":"

ARN referencing a KMS key or KMS key alias.

", "max":512, "min":1, "pattern":"arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\\d{1}:\\d{12}:((key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})|(alias/[a-zA-Z0-9:/_-]{1,256}))" }, "ListDICOMImportJobsRequest":{ "type":"structure", "required":["datastoreId"], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "jobStatus":{ "shape":"JobStatus", "documentation":"

The filters for listing import jobs based on status.

", "location":"querystring", "locationName":"jobStatus" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListDICOMImportJobsRequestMaxResultsInteger", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } } }, "ListDICOMImportJobsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListDICOMImportJobsResponse":{ "type":"structure", "required":["jobSummaries"], "members":{ "jobSummaries":{ "shape":"DICOMImportJobSummaries", "documentation":"

A list of job summaries.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListDatastoresRequest":{ "type":"structure", "members":{ "datastoreStatus":{ "shape":"DatastoreStatus", "documentation":"

The data store status.

", "location":"querystring", "locationName":"datastoreStatus" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListDatastoresRequestMaxResultsInteger", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } } }, "ListDatastoresRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListDatastoresResponse":{ "type":"structure", "members":{ "datastoreSummaries":{ "shape":"DatastoreSummaries", "documentation":"

The list of summaries of data stores.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListImageSetVersionsRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ListImageSetVersionsRequestMaxResultsInteger", "documentation":"

The max results count.

", "location":"querystring", "locationName":"maxResults" } } }, "ListImageSetVersionsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "ListImageSetVersionsResponse":{ "type":"structure", "required":["imageSetPropertiesList"], "members":{ "imageSetPropertiesList":{ "shape":"ImageSetPropertiesList", "documentation":"

Lists all properties associated with an image set.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "required":["tags"], "members":{ "tags":{ "shape":"TagMap", "documentation":"

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

" } } }, "Message":{ "type":"string", "max":2048, "min":1, "pattern":"[\\w -:]+" }, "MetadataUpdates":{ "type":"structure", "members":{ "DICOMUpdates":{ "shape":"DICOMUpdates", "documentation":"

The object containing `removableAttributes` and `updatableAttributes`.

" } }, "documentation":"

Contains DICOMUpdates.

", "union":true }, "NextToken":{ "type":"string", "max":8192, "min":1, "pattern":"\\p{ASCII}{0,8192}" }, "Operator":{ "type":"string", "enum":[ "EQUAL", "BETWEEN" ] }, "PayloadBlob":{ "type":"blob", "streaming":true }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request references a resource which does not exist.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" }, "S3Uri":{ "type":"string", "max":1024, "min":1, "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" }, "SearchByAttributeValue":{ "type":"structure", "members":{ "DICOMPatientId":{ "shape":"DICOMPatientId", "documentation":"

The patient ID input for search.

" }, "DICOMAccessionNumber":{ "shape":"DICOMAccessionNumber", "documentation":"

The DICOM accession number for search.

" }, "DICOMStudyId":{ "shape":"DICOMStudyId", "documentation":"

The DICOM study ID for search.

" }, "DICOMStudyInstanceUID":{ "shape":"DICOMStudyInstanceUID", "documentation":"

The DICOM study instance UID for search.

" }, "createdAt":{ "shape":"Date", "documentation":"

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

" }, "DICOMStudyDateAndTime":{ "shape":"DICOMStudyDateAndTime", "documentation":"

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

" } }, "documentation":"

The search input attribute value.

", "union":true }, "SearchCriteria":{ "type":"structure", "members":{ "filters":{ "shape":"SearchCriteriaFiltersList", "documentation":"

The filters for the search criteria.

" } }, "documentation":"

The search criteria.

", "sensitive":true }, "SearchCriteriaFiltersList":{ "type":"list", "member":{"shape":"SearchFilter"}, "max":2, "min":1 }, "SearchFilter":{ "type":"structure", "required":[ "values", "operator" ], "members":{ "values":{ "shape":"SearchFilterValuesList", "documentation":"

The search filter values.

" }, "operator":{ "shape":"Operator", "documentation":"

The search filter operator for `imageSetDateTime`.

" } }, "documentation":"

The search filter.

" }, "SearchFilterValuesList":{ "type":"list", "member":{"shape":"SearchByAttributeValue"}, "max":2, "min":1 }, "SearchImageSetsRequest":{ "type":"structure", "required":["datastoreId"], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

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

", "location":"uri", "locationName":"datastoreId" }, "searchCriteria":{ "shape":"SearchCriteria", "documentation":"

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

" }, "maxResults":{ "shape":"SearchImageSetsRequestMaxResultsInteger", "documentation":"

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

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } }, "payload":"searchCriteria" }, "SearchImageSetsRequestMaxResultsInteger":{ "type":"integer", "box":true, "max":50, "min":1 }, "SearchImageSetsResponse":{ "type":"structure", "required":["imageSetsMetadataSummaries"], "members":{ "imageSetsMetadataSummaries":{ "shape":"ImageSetsMetadataSummaries", "documentation":"

The model containing the image set results.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for pagination results.

" } } }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request caused a service quota to be exceeded.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "StartDICOMImportJobRequest":{ "type":"structure", "required":[ "dataAccessRoleArn", "clientToken", "datastoreId", "inputS3Uri", "outputS3Uri" ], "members":{ "jobName":{ "shape":"JobName", "documentation":"

The import job name.

" }, "dataAccessRoleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A unique identifier for API idempotency.

", "idempotencyToken":true }, "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "inputS3Uri":{ "shape":"S3Uri", "documentation":"

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

" }, "outputS3Uri":{ "shape":"S3Uri", "documentation":"

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

" } } }, "StartDICOMImportJobResponse":{ "type":"structure", "required":[ "datastoreId", "jobId", "jobStatus", "submittedAt" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "jobId":{ "shape":"JobId", "documentation":"

The import job identifier.

" }, "jobStatus":{ "shape":"JobStatus", "documentation":"

The import job status.

" }, "submittedAt":{ "shape":"Date", "documentation":"

The timestamp when the import job was submitted.

" } } }, "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"(?!aws:)[a-zA-Z+-=._:/]+" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

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

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The request was denied due to throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

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

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateImageSetMetadataRequest":{ "type":"structure", "required":[ "datastoreId", "imageSetId", "latestVersionId", "updateImageSetMetadataUpdates" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

", "location":"uri", "locationName":"datastoreId" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

", "location":"uri", "locationName":"imageSetId" }, "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest image set version identifier.

", "location":"querystring", "locationName":"latestVersion" }, "updateImageSetMetadataUpdates":{ "shape":"MetadataUpdates", "documentation":"

Update image set metadata updates.

" } }, "payload":"updateImageSetMetadataUpdates" }, "UpdateImageSetMetadataResponse":{ "type":"structure", "required":[ "datastoreId", "imageSetId", "latestVersionId", "imageSetState" ], "members":{ "datastoreId":{ "shape":"DatastoreId", "documentation":"

The data store identifier.

" }, "imageSetId":{ "shape":"ImageSetId", "documentation":"

The image set identifier.

" }, "latestVersionId":{ "shape":"ImageSetExternalVersionId", "documentation":"

The latest image set version identifier.

" }, "imageSetState":{ "shape":"ImageSetState", "documentation":"

The image set state.

" }, "imageSetWorkflowStatus":{ "shape":"ImageSetWorkflowStatus", "documentation":"

The image set workflow status.

" }, "createdAt":{ "shape":"Date", "documentation":"

The timestamp when image set metadata was created.

" }, "updatedAt":{ "shape":"Date", "documentation":"

The timestamp when image set metadata was updated.

" }, "message":{ "shape":"Message", "documentation":"

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

" } } }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"

The input fails to satisfy the constraints set by the service.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"

This is the AWS HealthImaging API Reference. AWS HealthImaging is a HIPAA-eligible service that helps health care providers and their medical imaging ISV partners store, transform, and apply machine learning to medical images. For an introduction to the service, see the AWS HealthImaging Developer Guide .

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.

For information about using HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.

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 console procedures and CLI/SDK code examples.

Data store actions

- CreateDatastore – See Creating a data store.

- GetDatastore – See Getting data store properties.

- ListDatastores – See Listing data stores.

- DeleteDatastore – See Deleting a data store.

Import job actions

- StartDICOMImportJob – See Starting an import job.

- GetDICOMImportJob – See Getting import job properties.

- ListDICOMImportJobs – See Listing import jobs.

Image set access actions

- SearchImageSets – See Searching image sets.

- GetImageSet – See Getting image set properties.

- GetImageSetMetadata – See Getting image set metadata.

- GetImageFrame – See Getting image set pixel data.

Image set modification actions

- ListImageSetVersions – See Listing image set versions.

- UpdateImageSetMetadata – See Updating image set metadata.

- CopyImageSet – See Copying an image set.

- DeleteImageSet – See Deleting an image set.

Tagging actions

- TagResource – See Tagging a data store and Tagging an image set.

- ListTagsForResource – See Tagging a data store and Tagging an image set.

- UntagResource – See Tagging a data store and Tagging an image set.

" }