2023/07/19 - AWS Health Imaging - 18 new api methods
Changes General Availability (GA) release of AWS Health Imaging, enabling customers to store, transform, and analyze medical imaging data at petabyte-scale.
Create a data store.
See also: AWS API Documentation
Request Syntax
client.create_datastore(
datastoreName='string',
clientToken='string',
tags={
'string': 'string'
},
kmsKeyArn='string'
)
string
The data store name.
string
[REQUIRED]
A unique identifier for API idempotency.
This field is autopopulated if not provided.
dict
The tags provided when creating a data store.
(string) --
(string) --
string
The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.
dict
Response Syntax
{
'datastoreId': 'string',
'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'
}
Response Structure
(dict) --
datastoreId (string) --
The data store identifier.
datastoreStatus (string) --
The data store status.
Adds a user-specifed key and value tag to a medical imaging resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to.
dict
[REQUIRED]
The user-specified key and value tag pairs added to a medical imaging resource.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Update image set metadata attributes.
See also: AWS API Documentation
Request Syntax
client.update_image_set_metadata(
datastoreId='string',
imageSetId='string',
latestVersionId='string',
updateImageSetMetadataUpdates={
'DICOMUpdates': {
'removableAttributes': b'bytes',
'updatableAttributes': b'bytes'
}
}
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
string
[REQUIRED]
The latest image set version identifier.
dict
[REQUIRED]
Update image set metadata updates.
DICOMUpdates (dict) --
The object containing removableAttributes and updatableAttributes .
removableAttributes (bytes) --
The DICOM tags to be removed from ImageSetMetadata .
updatableAttributes (bytes) --
The DICOM tags that need to be updated in ImageSetMetadata .
dict
Response Syntax
{
'datastoreId': 'string',
'imageSetId': 'string',
'latestVersionId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'message': 'string'
}
Response Structure
(dict) --
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.
imageSetWorkflowStatus (string) --
The image set workflow status.
createdAt (datetime) --
The timestamp when image set metadata was created.
updatedAt (datetime) --
The timestamp when image set metadata was updated.
message (string) --
The error message thrown if an update image set metadata action fails.
Lists all tags associated with a medical imaging resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the medical imaging resource to list tags for.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
A list of all tags associated with a medical imaging resource.
(string) --
(string) --
Removes tags from a medical imaging resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from.
list
[REQUIRED]
The keys for the tags to be removed from the medical imaging resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Delete a data store.
Note
Before a data store can be deleted, you must first delete all image sets within it.
See also: AWS API Documentation
Request Syntax
client.delete_datastore(
datastoreId='string'
)
string
[REQUIRED]
The data store identifier.
dict
Response Syntax
{
'datastoreId': 'string',
'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'
}
Response Structure
(dict) --
datastoreId (string) --
The data store identifier.
datastoreStatus (string) --
The data store status.
Copy an image set.
See also: AWS API Documentation
Request Syntax
client.copy_image_set(
datastoreId='string',
sourceImageSetId='string',
copyImageSetInformation={
'sourceImageSet': {
'latestVersionId': 'string'
},
'destinationImageSet': {
'imageSetId': 'string',
'latestVersionId': 'string'
}
}
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The source image set identifier.
dict
[REQUIRED]
Copy image set information.
sourceImageSet (dict) -- [REQUIRED]
The source image set.
latestVersionId (string) -- [REQUIRED]
The latest version identifier for the source image set.
destinationImageSet (dict) --
The destination image set.
imageSetId (string) -- [REQUIRED]
The image set identifier for the destination image set.
latestVersionId (string) -- [REQUIRED]
The latest version identifier for the destination image set.
dict
Response Syntax
{
'datastoreId': 'string',
'sourceImageSetProperties': {
'imageSetId': 'string',
'latestVersionId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'imageSetArn': 'string'
},
'destinationImageSetProperties': {
'imageSetId': 'string',
'latestVersionId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'imageSetArn': 'string'
}
}
Response Structure
(dict) --
datastoreId (string) --
The data store identifier.
sourceImageSetProperties (dict) --
The properties of the source image set.
imageSetId (string) --
The image set identifier for the copied source image set.
latestVersionId (string) --
The latest version identifier for the copied source image set.
imageSetState (string) --
The image set state of the copied source image set.
imageSetWorkflowStatus (string) --
The workflow status of the copied source image set.
createdAt (datetime) --
The timestamp when the source image set properties were created.
updatedAt (datetime) --
The timestamp when the source image set properties were updated.
imageSetArn (string) --
The Amazon Resource Name (ARN) assigned to the source image set.
destinationImageSetProperties (dict) --
The properties of the destination image set.
imageSetId (string) --
The image set identifier of the copied image set properties.
latestVersionId (string) --
The latest version identifier for the destination image set properties.
imageSetState (string) --
The image set state of the destination image set properties.
imageSetWorkflowStatus (string) --
The image set workflow status of the destination image set properties.
createdAt (datetime) --
The timestamp when the destination image set properties were created.
updatedAt (datetime) --
The timestamp when the destination image set properties were last updated.
imageSetArn (string) --
The Amazon Resource Name (ARN) assigned to the destination image set.
List image set versions.
See also: AWS API Documentation
Request Syntax
client.list_image_set_versions(
datastoreId='string',
imageSetId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
string
The pagination token used to request the list of image set versions on the next page.
integer
The max results count.
dict
Response Syntax
{
'imageSetPropertiesList': [
{
'imageSetId': 'string',
'versionId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'ImageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'deletedAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
imageSetPropertiesList (list) --
Lists all properties associated with an image set.
(dict) --
The image set properties.
imageSetId (string) --
The image set identifier.
versionId (string) --
The image set version identifier.
imageSetState (string) --
The image set state.
ImageSetWorkflowStatus (string) --
The image set workflow status.
createdAt (datetime) --
The timestamp when the image set properties were created.
updatedAt (datetime) --
The timestamp when the image set properties were updated.
deletedAt (datetime) --
The timestamp when the image set properties were deleted.
message (string) --
The error message thrown if an image set action fails.
nextToken (string) --
The pagination token used to retrieve the list of image set versions on the next page.
List import jobs created by this AWS account for a specific data store.
See also: AWS API Documentation
Request Syntax
client.list_dicom_import_jobs(
datastoreId='string',
jobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The data store identifier.
string
The filters for listing import jobs based on status.
string
The pagination token used to request the list of import jobs on the next page.
integer
The max results count. The upper bound is determined by load testing.
dict
Response Syntax
{
'jobSummaries': [
{
'jobId': 'string',
'jobName': 'string',
'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'datastoreId': 'string',
'dataAccessRoleArn': 'string',
'endedAt': datetime(2015, 1, 1),
'submittedAt': datetime(2015, 1, 1),
'message': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobSummaries (list) --
A list of job summaries.
(dict) --
Summary of import job.
jobId (string) --
The import job identifier.
jobName (string) --
The import job name.
jobStatus (string) --
The filters for listing import jobs based on status.
datastoreId (string) --
The data store identifier.
dataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
endedAt (datetime) --
The timestamp when an import job ended.
submittedAt (datetime) --
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.
Get image set properties.
See also: AWS API Documentation
Request Syntax
client.get_image_set(
datastoreId='string',
imageSetId='string',
versionId='string'
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
string
The image set version identifier.
dict
Response Syntax
{
'datastoreId': 'string',
'imageSetId': 'string',
'versionId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'deletedAt': datetime(2015, 1, 1),
'message': 'string',
'imageSetArn': 'string'
}
Response Structure
(dict) --
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.
imageSetWorkflowStatus (string) --
The image set workflow status.
createdAt (datetime) --
The timestamp when image set properties were created.
updatedAt (datetime) --
The timestamp when image set properties were updated.
deletedAt (datetime) --
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.
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.
See also: AWS API Documentation
Request Syntax
client.start_dicom_import_job(
jobName='string',
dataAccessRoleArn='string',
clientToken='string',
datastoreId='string',
inputS3Uri='string',
outputS3Uri='string'
)
string
The import job name.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources.
string
[REQUIRED]
A unique identifier for API idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The input prefix path for the S3 bucket that contains the DICOM files to be imported.
string
[REQUIRED]
The output prefix of the S3 bucket to upload the results of the DICOM import job.
dict
Response Syntax
{
'datastoreId': 'string',
'jobId': 'string',
'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'submittedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
datastoreId (string) --
The data store identifier.
jobId (string) --
The import job identifier.
jobStatus (string) --
The import job status.
submittedAt (datetime) --
The timestamp when the import job was submitted.
Get metadata attributes for an image set.
See also: AWS API Documentation
Request Syntax
client.get_image_set_metadata(
datastoreId='string',
imageSetId='string',
versionId='string'
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
string
The image set version identifier.
dict
Response Syntax
{
'imageSetMetadataBlob': StreamingBody(),
'contentType': 'string',
'contentEncoding': 'string'
}
Response Structure
(dict) --
imageSetMetadataBlob (:class:`.StreamingBody`) --
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.
Get data store properties.
See also: AWS API Documentation
Request Syntax
client.get_datastore(
datastoreId='string'
)
string
[REQUIRED]
The data store identifier.
dict
Response Syntax
{
'datastoreProperties': {
'datastoreId': 'string',
'datastoreName': 'string',
'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
'kmsKeyArn': 'string',
'datastoreArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
datastoreProperties (dict) --
The data store properties.
datastoreId (string) --
The data store identifier.
datastoreName (string) --
The data store name.
datastoreStatus (string) --
The data store status.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) assigned to the AWS Key Management Service (AWS KMS) key for accessing encrypted data.
datastoreArn (string) --
The Amazon Resource Name (ARN) for the data store.
createdAt (datetime) --
The timestamp when the data store was created.
updatedAt (datetime) --
The timestamp when the data store was last updated.
Get the import job properties to learn more about the job or job progress.
See also: AWS API Documentation
Request Syntax
client.get_dicom_import_job(
datastoreId='string',
jobId='string'
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The import job identifier.
dict
Response Syntax
{
'jobProperties': {
'jobId': 'string',
'jobName': 'string',
'jobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'datastoreId': 'string',
'dataAccessRoleArn': 'string',
'endedAt': datetime(2015, 1, 1),
'submittedAt': datetime(2015, 1, 1),
'inputS3Uri': 'string',
'outputS3Uri': 'string',
'message': 'string'
}
}
Response Structure
(dict) --
jobProperties (dict) --
The properties of the import job.
jobId (string) --
The import job identifier.
jobName (string) --
The import job name.
jobStatus (string) --
The filters for listing import jobs based on status.
datastoreId (string) --
The data store identifier.
dataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that grants permissions to access medical imaging resources.
endedAt (datetime) --
The timestamp for when the import job was ended.
submittedAt (datetime) --
The timestamp for when the import job was submitted.
inputS3Uri (string) --
The input prefix path for the S3 bucket that contains the DICOM P10 files to be imported.
outputS3Uri (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.
Get an image frame (pixel data) for an image set.
See also: AWS API Documentation
Request Syntax
client.get_image_frame(
datastoreId='string',
imageSetId='string',
imageFrameInformation={
'imageFrameId': 'string'
}
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
dict
[REQUIRED]
Information about the image frame (pixel data) identifier.
imageFrameId (string) -- [REQUIRED]
The image frame (pixel data) identifier.
dict
Response Syntax
{
'imageFrameBlob': StreamingBody(),
'contentType': 'string'
}
Response Structure
(dict) --
imageFrameBlob (:class:`.StreamingBody`) --
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 .
Search image sets based on defined input attributes.
See also: AWS API Documentation
Request Syntax
client.search_image_sets(
datastoreId='string',
searchCriteria={
'filters': [
{
'values': [
{
'DICOMPatientId': 'string',
'DICOMAccessionNumber': 'string',
'DICOMStudyId': 'string',
'DICOMStudyInstanceUID': 'string',
'createdAt': datetime(2015, 1, 1),
'DICOMStudyDateAndTime': {
'DICOMStudyDate': 'string',
'DICOMStudyTime': 'string'
}
},
],
'operator': 'EQUAL'|'BETWEEN'
},
]
},
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the data store where the image sets reside.
dict
The search criteria that filters by applying a maximum of 1 item to SearchByAttribute .
filters (list) --
The filters for the search criteria.
(dict) --
The search filter.
values (list) -- [REQUIRED]
The search filter values.
(dict) --
The search input attribute value.
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.
createdAt (datetime) --
The created at time of the image set provided for search.
DICOMStudyDateAndTime (dict) --
The aggregated structure containing DICOM study date and study time for search.
DICOMStudyDate (string) -- [REQUIRED]
The DICOM study date provided in yyMMdd format.
DICOMStudyTime (string) --
The DICOM study time provided in HHmmss.FFFFFF format.
operator (string) -- [REQUIRED]
The search filter operator for imageSetDateTime .
integer
The maximum number of results that can be returned in a search.
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.
dict
Response Syntax
{
'imageSetsMetadataSummaries': [
{
'imageSetId': 'string',
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'DICOMTags': {
'DICOMPatientId': 'string',
'DICOMPatientName': 'string',
'DICOMPatientBirthDate': 'string',
'DICOMPatientSex': 'string',
'DICOMStudyInstanceUID': 'string',
'DICOMStudyId': 'string',
'DICOMStudyDescription': 'string',
'DICOMNumberOfStudyRelatedSeries': 123,
'DICOMNumberOfStudyRelatedInstances': 123,
'DICOMAccessionNumber': 'string',
'DICOMStudyDate': 'string',
'DICOMStudyTime': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
imageSetsMetadataSummaries (list) --
The model containing the image set results.
(dict) --
Summary of the image set metadata.
imageSetId (string) --
The image set identifier.
version (integer) --
The image set version.
createdAt (datetime) --
The time an image set is created in AWS HealthImaging. Sample creation date is provided in 1985-04-12T23:20:50.52Z format.
updatedAt (datetime) --
The time when an image was last updated in AWS HealthImaging.
DICOMTags (dict) --
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 studyInstanceUid.>
DICOMStudyId (string) --
The DICOM provided studyId.
DICOMStudyDescription (string) --
The description of the study.
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.
DICOMStudyDate (string) --
The study date.
DICOMStudyTime (string) --
The study time.
nextToken (string) --
The token for pagination results.
List data stores created by this AWS account.
See also: AWS API Documentation
Request Syntax
client.list_datastores(
datastoreStatus='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
nextToken='string',
maxResults=123
)
string
The data store status.
string
The pagination token used to request the list of data stores on the next page.
integer
Valid Range: Minimum value of 1. Maximum value of 50.
dict
Response Syntax
{
'datastoreSummaries': [
{
'datastoreId': 'string',
'datastoreName': 'string',
'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
'datastoreArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datastoreSummaries (list) --
The list of summaries of data stores.
(dict) --
List of summaries of data stores.
datastoreId (string) --
The data store identifier.
datastoreName (string) --
The data store name.
datastoreStatus (string) --
The data store status.
datastoreArn (string) --
The Amazon Resource Name (ARN) for the data store.
createdAt (datetime) --
The timestamp when the data store was created.
updatedAt (datetime) --
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.
Delete an image set.
See also: AWS API Documentation
Request Syntax
client.delete_image_set(
datastoreId='string',
imageSetId='string'
)
string
[REQUIRED]
The data store identifier.
string
[REQUIRED]
The image set identifier.
dict
Response Syntax
{
'datastoreId': 'string',
'imageSetId': 'string',
'imageSetState': 'ACTIVE'|'LOCKED'|'DELETED',
'imageSetWorkflowStatus': 'CREATED'|'COPIED'|'COPYING'|'COPYING_WITH_READ_ONLY_ACCESS'|'COPY_FAILED'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED'
}
Response Structure
(dict) --
datastoreId (string) --
The data store identifier.
imageSetId (string) --
The image set identifier.
imageSetState (string) --
The image set state.
imageSetWorkflowStatus (string) --
The image set workflow status.