AWS API Changes

2025/11/11 - AWS Health Imaging - 4 updated api methods

Changes Added new fields in existing APIs.

CreateDatastore (updated)

Link ¶
Changes (request)

{'losslessStorageFormat': 'HTJ2K | JPEG_2000_LOSSLESS'}

Create a data store.

See also: AWS API Documentation

Request Syntax

client.create_datastore(
    datastoreName='string',
    clientToken='string',
    tags={
        'string': 'string'
    },
    kmsKeyArn='string',
    lambdaAuthorizerArn='string',
    losslessStorageFormat='HTJ2K'|'JPEG_2000_LOSSLESS'
)

type datastoreName:

string

param datastoreName:

The data store name.

type clientToken:

string

param clientToken:

[REQUIRED]

A unique identifier for API idempotency.

This field is autopopulated if not provided.

type tags:

dict

param tags:

The tags provided when creating a data store.

(string) --
- (string) --

type kmsKeyArn:

string

param kmsKeyArn:

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

type lambdaAuthorizerArn:

string

param lambdaAuthorizerArn:

The ARN of the authorizer's Lambda function.

type losslessStorageFormat:

string

param losslessStorageFormat:

The lossless storage format for the datastore.

rtype:

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.

GetDatastore (updated)

Link ¶
Changes (response)

{'datastoreProperties': {'losslessStorageFormat': 'HTJ2K | JPEG_2000_LOSSLESS'}}

Get data store properties.

See also: AWS API Documentation

Request Syntax

client.get_datastore(
    datastoreId='string'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

rtype:

dict

returns:

Response Syntax

{
    'datastoreProperties': {
        'datastoreId': 'string',
        'datastoreName': 'string',
        'datastoreStatus': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED',
        'kmsKeyArn': 'string',
        'lambdaAuthorizerArn': 'string',
        'losslessStorageFormat': 'HTJ2K'|'JPEG_2000_LOSSLESS',
        '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.
  - lambdaAuthorizerArn (string) --
    
    The ARN of the authorizer's Lambda function.
  - losslessStorageFormat (string) --
    
    The datastore's lossless storage format.
  - 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.

GetImageSet (updated)

Link ¶
Changes (response)

{'lastAccessedAt': 'timestamp',
 'storageTier': 'FREQUENT_ACCESS | ARCHIVE_INSTANT_ACCESS'}

Get image set properties.

See also: AWS API Documentation

Request Syntax

client.get_image_set(
    datastoreId='string',
    imageSetId='string',
    versionId='string'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

The data store identifier.

type imageSetId:

string

param imageSetId:

[REQUIRED]

The image set identifier.

type versionId:

string

param versionId:

The image set version identifier.

rtype:

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'|'IMPORTING'|'IMPORTED'|'IMPORT_FAILED',
    '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,
    'lastAccessedAt': datetime(2015, 1, 1),
    'storageTier': 'FREQUENT_ACCESS'|'ARCHIVE_INSTANT_ACCESS'
}

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.
- lastAccessedAt (datetime) --
  
  When the image set was last accessed.
- storageTier (string) --
  
  The storage tier of the image set.

SearchImageSets (updated)

Link ¶
Changes (response)

{'imageSetsMetadataSummaries': {'lastAccessedAt': 'timestamp',
                                'storageTier': 'FREQUENT_ACCESS | '
                                               'ARCHIVE_INSTANT_ACCESS'}}

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',
                        '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'
)

type datastoreId:

string

param datastoreId:

[REQUIRED]

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

type searchCriteria:

dict

param searchCriteria:

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.

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'imageSetsMetadataSummaries': [
        {
            'imageSetId': 'string',
            'version': 123,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'lastAccessedAt': datetime(2015, 1, 1),
            'storageTier': 'FREQUENT_ACCESS'|'ARCHIVE_INSTANT_ACCESS',
            '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.
    - lastAccessedAt (datetime) --
      
      When the image set was last accessed.
    - storageTier (string) --
      
      The image set's storage tier.
    - 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.