HealthImaging ************* Client ====== class HealthImaging.Client A low-level client representing AWS Health Imaging This is the *AWS HealthImaging API Reference*. For an introduction to the service, see What is AWS HealthImaging? in the *AWS HealthImaging Developer Guide*. import boto3 client = boto3.client('medical-imaging') These are the available methods: * can_paginate * close * copy_image_set * create_datastore * delete_datastore * delete_image_set * get_datastore * get_dicom_import_job * get_image_frame * get_image_set * get_image_set_metadata * get_paginator * get_waiter * list_datastores * list_dicom_import_jobs * list_image_set_versions * list_tags_for_resource * search_image_sets * start_dicom_import_job * tag_resource * untag_resource * update_image_set_metadata Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListDICOMImportJobs * ListDatastores * ListImageSetVersions * SearchImageSets HealthImaging / Paginator / ListDatastores ListDatastores ************** class HealthImaging.Paginator.ListDatastores paginator = client.get_paginator('list_datastores') paginate(**kwargs) Creates an iterator that will paginate through responses from "HealthImaging.Client.list_datastores()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( datastoreStatus='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **datastoreStatus** (*string*) -- The data store status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. HealthImaging / Paginator / SearchImageSets SearchImageSets *************** class HealthImaging.Paginator.SearchImageSets paginator = client.get_paginator('search_image_sets') paginate(**kwargs) Creates an iterator that will paginate through responses from "HealthImaging.Client.search_image_sets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( datastoreId='string', searchCriteria={ 'filters': [ { 'values': [ { 'DICOMPatientId': 'string', 'DICOMAccessionNumber': 'string', 'DICOMStudyId': 'string', 'DICOMStudyInstanceUID': 'string', 'DICOMSeriesInstanceUID': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'DICOMStudyDateAndTime': { 'DICOMStudyDate': 'string', 'DICOMStudyTime': 'string' }, 'isPrimary': True|False }, ], 'operator': 'EQUAL'|'BETWEEN' }, ], 'sort': { 'sortOrder': 'ASC'|'DESC', 'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime' } }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The identifier of the data store where the image sets reside. * **searchCriteria** (*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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "DICOMPatientId", "DICOMAccessionNumber", "DICOMStudyId", "DICOMStudyInstanceUID", "DICOMSeriesInstanceUID", "createdAt", "updatedAt", "DICOMStudyDateAndTime", "isPrimary". * **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** *(datetime) --* The created at time of the image set provided for search. * **updatedAt** *(datetime) --* The timestamp input 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. * **isPrimary** *(boolean) --* The primary image set flag provided for search. * **operator** *(string) --* **[REQUIRED]** The search filter operator for "imageSetDateTime". * **sort** *(dict) --* The sort input for search criteria. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for search criteria. * **sortField** *(string) --* **[REQUIRED]** The sort field for search criteria. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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', 'DICOMSeriesInstanceUID': 'string', 'DICOMSeriesModality': 'string', 'DICOMSeriesBodyPart': 'string', 'DICOMSeriesNumber': 123, 'DICOMStudyDate': 'string', 'DICOMStudyTime': 'string' }, 'isPrimary': True|False }, ], 'sort': { 'sortOrder': 'ASC'|'DESC', 'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime' }, '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. Sample creation date is provided in "1985-04-12T23:20:50.52Z" format. * **updatedAt** *(datetime) --* The time an image set was last updated. * **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 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. * **isPrimary** *(boolean) --* The flag to determine whether the image set is primary or not. * **sort** *(dict) --* The sort order for image set search results. * **sortOrder** *(string) --* The sort order for search criteria. * **sortField** *(string) --* The sort field for search criteria. * **NextToken** *(string) --* A token to resume pagination. HealthImaging / Paginator / ListDICOMImportJobs ListDICOMImportJobs ******************* class HealthImaging.Paginator.ListDICOMImportJobs paginator = client.get_paginator('list_dicom_import_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "HealthImaging.Client.list_dicom_import_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( datastoreId='string', jobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **jobStatus** (*string*) -- The filters for listing import jobs based on status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. HealthImaging / Paginator / ListImageSetVersions ListImageSetVersions ******************** class HealthImaging.Paginator.ListImageSetVersions paginator = client.get_paginator('list_image_set_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "HealthImaging.Client.list_image_set_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( datastoreId='string', imageSetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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', 'overrides': { 'forced': True|False }, 'isPrimary': True|False }, ], '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. * **overrides** *(dict) --* 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) --* Providing this parameter will force completion of the "CopyImageSet" and "UpdateImageSetMetadata" actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels. * **isPrimary** *(boolean) --* The flag to determine whether the image set is primary or not. * **NextToken** *(string) --* A token to resume pagination. HealthImaging / Client / get_paginator get_paginator ************* HealthImaging.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. HealthImaging / Client / get_image_frame get_image_frame *************** HealthImaging.Client.get_image_frame(**kwargs) Get an image frame (pixel data) for an image set. See also: AWS API Documentation **Request Syntax** response = client.get_image_frame( datastoreId='string', imageSetId='string', imageFrameInformation={ 'imageFrameId': 'string' } ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. * **imageFrameInformation** (*dict*) -- **[REQUIRED]** Information about the image frame (pixel data) identifier. * **imageFrameId** *(string) --* **[REQUIRED]** The image frame (pixel data) identifier. Return type: dict Returns: **Response Syntax** { 'imageFrameBlob': StreamingBody(), 'contentType': 'string' } **Response Structure** * *(dict) --* * **imageFrameBlob** ("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". Note: * If the stored transfer syntax is "1.2.840.10008.1.2.1", the returned "contentType" is "application/octet- stream". * If the stored transfer syntax is "1.2.840.10008.1.2.4.50", the returned "contentType" is "image/jpeg". * If the stored transfer syntax is "1.2.840.10008.1.2.4.91", the returned "contentType" is "image/j2c". * If the stored transfer syntax is MPEG2, "1.2.840.10008.1.2.4.100", "1.2.840.10008.1.2.4.100.1", "1.2.840.10008.1.2.4.101", or "1.2.840.10008.1.2.4.101.1", the returned "contentType" is "video/mpeg". * If the stored transfer syntax is MPEG-4 AVC/H.264, UID "1.2.840.10008.1.2.4.102", "1.2.840.10008.1.2.4.102.1", "1.2.840.10008.1.2.4.103", "1.2.840.10008.1.2.4.103.1", "1.2.840.10008.1.2.4.104", "1.2.840.10008.1.2.4.104.1", "1.2.840.10008.1.2.4.105", "1.2.840.10008.1.2.4.105.1", "1.2.840.10008.1.2.4.106", or "1.2.840.10008.1.2.4.106.1", the returned "contentType" is "video/mp4". * If the stored transfer syntax is HEVC/H.265, UID "1.2.840.10008.1.2.4.107" or "1.2.840.10008.1.2.4.108", the returned "contentType" is "video/H256". * If the stored transfer syntax is "1.2.840.10008.1.2.4.202" or if the stored transfer syntax is *missing*, the returned "contentType" is "image/jph". * If the stored transfer syntax is "1.2.840.10008.1.2.4.203", the returned contentType is "image/jphc". **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / update_image_set_metadata update_image_set_metadata ************************* HealthImaging.Client.update_image_set_metadata(**kwargs) Update image set metadata attributes. See also: AWS API Documentation **Request Syntax** response = client.update_image_set_metadata( datastoreId='string', imageSetId='string', latestVersionId='string', force=True|False, updateImageSetMetadataUpdates={ 'DICOMUpdates': { 'removableAttributes': b'bytes', 'updatableAttributes': b'bytes' }, 'revertToVersionId': 'string' } ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. * **latestVersionId** (*string*) -- **[REQUIRED]** 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** (*dict*) -- **[REQUIRED]** Update image set metadata updates. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "DICOMUpdates", "revertToVersionId". * **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". * **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. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" * "HealthImaging.Client.exceptions.ServiceQuotaExceededException" HealthImaging / Client / list_image_set_versions list_image_set_versions *********************** HealthImaging.Client.list_image_set_versions(**kwargs) List image set versions. See also: AWS API Documentation **Request Syntax** response = client.list_image_set_versions( datastoreId='string', imageSetId='string', nextToken='string', maxResults=123 ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **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', 'overrides': { 'forced': True|False }, 'isPrimary': True|False }, ], '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. * **overrides** *(dict) --* 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) --* Providing this parameter will force completion of the "CopyImageSet" and "UpdateImageSetMetadata" actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels. * **isPrimary** *(boolean) --* The flag to determine whether the image set is primary or not. * **nextToken** *(string) --* The pagination token used to retrieve the list of image set versions on the next page. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / can_paginate can_paginate ************ HealthImaging.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. HealthImaging / Client / get_dicom_import_job get_dicom_import_job ******************** HealthImaging.Client.get_dicom_import_job(**kwargs) Get the import job properties to learn more about the job or job progress. Note: The "jobStatus" refers to the execution of the import job. Therefore, an import job can return a "jobStatus" as "COMPLETED" even if validation issues are discovered during the import process. If a "jobStatus" returns as "COMPLETED", we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports. See also: AWS API Documentation **Request Syntax** response = client.get_dicom_import_job( datastoreId='string', jobId='string' ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **jobId** (*string*) -- **[REQUIRED]** The import job identifier. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / list_tags_for_resource list_tags_for_resource ********************** HealthImaging.Client.list_tags_for_resource(**kwargs) Lists all tags associated with a medical imaging resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the medical imaging resource to list tags for. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* A list of all tags associated with a medical imaging resource. * *(string) --* * *(string) --* **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / untag_resource untag_resource ************** HealthImaging.Client.untag_resource(**kwargs) Removes tags from a medical imaging resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the medical imaging resource that tags are being removed from. * **tagKeys** (*list*) -- **[REQUIRED]** The keys for the tags to be removed from the medical imaging resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / get_image_set get_image_set ************* HealthImaging.Client.get_image_set(**kwargs) Get image set properties. See also: AWS API Documentation **Request Syntax** response = client.get_image_set( datastoreId='string', imageSetId='string', versionId='string' ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. * **versionId** (*string*) -- The image set version identifier. Return type: dict Returns: **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', 'overrides': { 'forced': True|False }, 'isPrimary': True|False } **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. * **overrides** *(dict) --* 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) --* Providing this parameter will force completion of the "CopyImageSet" and "UpdateImageSetMetadata" actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels. * **isPrimary** *(boolean) --* The flag to determine whether the image set is primary or not. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / get_datastore get_datastore ************* HealthImaging.Client.get_datastore(**kwargs) Get data store properties. See also: AWS API Documentation **Request Syntax** response = client.get_datastore( datastoreId='string' ) Parameters: **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. Return type: dict Returns: **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 Key Management Service (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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / start_dicom_import_job start_dicom_import_job ********************** HealthImaging.Client.start_dicom_import_job(**kwargs) 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** response = client.start_dicom_import_job( jobName='string', dataAccessRoleArn='string', clientToken='string', datastoreId='string', inputS3Uri='string', outputS3Uri='string', inputOwnerAccountId='string' ) Parameters: * **jobName** (*string*) -- The import job name. * **dataAccessRoleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role that grants permission to access medical imaging resources. * **clientToken** (*string*) -- **[REQUIRED]** A unique identifier for API idempotency. This field is autopopulated if not provided. * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **inputS3Uri** (*string*) -- **[REQUIRED]** The input prefix path for the S3 bucket that contains the DICOM files to be imported. * **outputS3Uri** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" * "HealthImaging.Client.exceptions.ServiceQuotaExceededException" HealthImaging / Client / get_waiter get_waiter ********** HealthImaging.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" HealthImaging / Client / list_datastores list_datastores *************** HealthImaging.Client.list_datastores(**kwargs) List data stores. See also: AWS API Documentation **Request Syntax** response = client.list_datastores( datastoreStatus='CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED', nextToken='string', maxResults=123 ) Parameters: * **datastoreStatus** (*string*) -- The data store status. * **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. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" HealthImaging / Client / close close ***** HealthImaging.Client.close() Closes underlying endpoint connections. HealthImaging / Client / get_image_set_metadata get_image_set_metadata ********************** HealthImaging.Client.get_image_set_metadata(**kwargs) Get metadata attributes for an image set. See also: AWS API Documentation **Request Syntax** response = client.get_image_set_metadata( datastoreId='string', imageSetId='string', versionId='string' ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. * **versionId** (*string*) -- The image set version identifier. Return type: dict Returns: **Response Syntax** { 'imageSetMetadataBlob': StreamingBody(), 'contentType': 'string', 'contentEncoding': 'string' } **Response Structure** * *(dict) --* * **imageSetMetadataBlob** ("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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / list_dicom_import_jobs list_dicom_import_jobs ********************** HealthImaging.Client.list_dicom_import_jobs(**kwargs) List import jobs created for a specific data store. See also: AWS API Documentation **Request Syntax** response = client.list_dicom_import_jobs( datastoreId='string', jobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED', nextToken='string', maxResults=123 ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **jobStatus** (*string*) -- The filters for listing import jobs based on status. * **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. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / create_datastore create_datastore **************** HealthImaging.Client.create_datastore(**kwargs) Create a data store. See also: AWS API Documentation **Request Syntax** response = client.create_datastore( datastoreName='string', clientToken='string', tags={ 'string': 'string' }, kmsKeyArn='string' ) Parameters: * **datastoreName** (*string*) -- The data store name. * **clientToken** (*string*) -- **[REQUIRED]** A unique identifier for API idempotency. This field is autopopulated if not provided. * **tags** (*dict*) -- The tags provided when creating a data store. * *(string) --* * *(string) --* * **kmsKeyArn** (*string*) -- The Amazon Resource Name (ARN) assigned to the Key Management Service (KMS) key for accessing encrypted data. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ServiceQuotaExceededException" HealthImaging / Client / delete_datastore delete_datastore **************** HealthImaging.Client.delete_datastore(**kwargs) 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** response = client.delete_datastore( datastoreId='string' ) Parameters: **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / copy_image_set copy_image_set ************** HealthImaging.Client.copy_image_set(**kwargs) Copy an image set. See also: AWS API Documentation **Request Syntax** response = client.copy_image_set( datastoreId='string', sourceImageSetId='string', copyImageSetInformation={ 'sourceImageSet': { 'latestVersionId': 'string', 'DICOMCopies': { 'copiableAttributes': 'string' } }, 'destinationImageSet': { 'imageSetId': 'string', 'latestVersionId': 'string' } }, force=True|False, promoteToPrimary=True|False ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **sourceImageSetId** (*string*) -- **[REQUIRED]** The source image set identifier. * **copyImageSetInformation** (*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. * **DICOMCopies** *(dict) --* Contains "MetadataCopies" structure and wraps information related to specific copy use cases. For example, when copying subsets. * **copiableAttributes** *(string) --* **[REQUIRED]** The JSON string used to specify a subset of SOP Instances to copy from source to destination 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. * **force** (*boolean*) -- Providing this parameter will force completion of the "CopyImageSet" operation, even if there are inconsistent Patient, Study, and/or Series level metadata elements between the "sourceImageSet" and "destinationImageSet". * **promoteToPrimary** (*boolean*) -- Providing this parameter will configure the "CopyImageSet" operation to promote the given image set to the primary DICOM hierarchy. If successful, a new primary image set ID will be returned as the destination image set. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" * "HealthImaging.Client.exceptions.ServiceQuotaExceededException" HealthImaging / Client / search_image_sets search_image_sets ***************** HealthImaging.Client.search_image_sets(**kwargs) Search image sets based on defined input attributes. Note: "SearchImageSets" accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as "(lowerBound, upperBound)".By default, "SearchImageSets" uses the "updatedAt" field for sorting in descending order from newest to oldest. See also: AWS API Documentation **Request Syntax** response = client.search_image_sets( datastoreId='string', searchCriteria={ 'filters': [ { 'values': [ { 'DICOMPatientId': 'string', 'DICOMAccessionNumber': 'string', 'DICOMStudyId': 'string', 'DICOMStudyInstanceUID': 'string', 'DICOMSeriesInstanceUID': 'string', 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1), 'DICOMStudyDateAndTime': { 'DICOMStudyDate': 'string', 'DICOMStudyTime': 'string' }, 'isPrimary': True|False }, ], 'operator': 'EQUAL'|'BETWEEN' }, ], 'sort': { 'sortOrder': 'ASC'|'DESC', 'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime' } }, maxResults=123, nextToken='string' ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The identifier of the data store where the image sets reside. * **searchCriteria** (*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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "DICOMPatientId", "DICOMAccessionNumber", "DICOMStudyId", "DICOMStudyInstanceUID", "DICOMSeriesInstanceUID", "createdAt", "updatedAt", "DICOMStudyDateAndTime", "isPrimary". * **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** *(datetime) --* The created at time of the image set provided for search. * **updatedAt** *(datetime) --* The timestamp input 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. * **isPrimary** *(boolean) --* The primary image set flag provided for search. * **operator** *(string) --* **[REQUIRED]** The search filter operator for "imageSetDateTime". * **sort** *(dict) --* The sort input for search criteria. * **sortOrder** *(string) --* **[REQUIRED]** The sort order for search criteria. * **sortField** *(string) --* **[REQUIRED]** The sort field for search criteria. * **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. Return type: dict Returns: **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', 'DICOMSeriesInstanceUID': 'string', 'DICOMSeriesModality': 'string', 'DICOMSeriesBodyPart': 'string', 'DICOMSeriesNumber': 123, 'DICOMStudyDate': 'string', 'DICOMStudyTime': 'string' }, 'isPrimary': True|False }, ], 'sort': { 'sortOrder': 'ASC'|'DESC', 'sortField': 'updatedAt'|'createdAt'|'DICOMStudyDateAndTime' }, '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. Sample creation date is provided in "1985-04-12T23:20:50.52Z" format. * **updatedAt** *(datetime) --* The time an image set was last updated. * **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 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. * **isPrimary** *(boolean) --* The flag to determine whether the image set is primary or not. * **sort** *(dict) --* The sort order for image set search results. * **sortOrder** *(string) --* The sort order for search criteria. * **sortField** *(string) --* The sort field for search criteria. * **nextToken** *(string) --* The token for pagination results. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / tag_resource tag_resource ************ HealthImaging.Client.tag_resource(**kwargs) Adds a user-specifed key and value tag to a medical imaging resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the medical imaging resource that tags are being added to. * **tags** (*dict*) -- **[REQUIRED]** The user-specified key and value tag pairs added to a medical imaging resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException" HealthImaging / Client / delete_image_set delete_image_set **************** HealthImaging.Client.delete_image_set(**kwargs) Delete an image set. See also: AWS API Documentation **Request Syntax** response = client.delete_image_set( datastoreId='string', imageSetId='string' ) Parameters: * **datastoreId** (*string*) -- **[REQUIRED]** The data store identifier. * **imageSetId** (*string*) -- **[REQUIRED]** The image set identifier. Return type: dict Returns: **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. **Exceptions** * "HealthImaging.Client.exceptions.ThrottlingException" * "HealthImaging.Client.exceptions.ConflictException" * "HealthImaging.Client.exceptions.AccessDeniedException" * "HealthImaging.Client.exceptions.ValidationException" * "HealthImaging.Client.exceptions.InternalServerException" * "HealthImaging.Client.exceptions.ResourceNotFoundException"