AWS API Changes

2024/07/24 - AWS Health Imaging - 4 updated api methods

Changes CopyImageSet API adds copying selected instances between image sets, and overriding inconsistent metadata with a force parameter. UpdateImageSetMetadata API enables reverting to prior versions; updates to Study, Series, and SOP Instance UIDs; and updates to private elements, with a force parameter.

CopyImageSet (updated)

Link ¶
Changes (request)

{'copyImageSetInformation': {'sourceImageSet': {'DICOMCopies': {'copiableAttributes': 'string'}}},
 'force': 'boolean'}

Copy an image set.

See also: AWS API Documentation

Request Syntax

client.copy_image_set(
    datastoreId='string',
    sourceImageSetId='string',
    copyImageSetInformation={
        'sourceImageSet': {
            'latestVersionId': 'string',
            'DICOMCopies': {
                'copiableAttributes': 'string'
            }
        },
        'destinationImageSet': {
            'imageSetId': 'string',
            'latestVersionId': 'string'
        }
    },
    force=True|False
)

type datastoreId

string

param datastoreId

[REQUIRED]

The data store identifier.

type sourceImageSetId

string

param sourceImageSetId

[REQUIRED]

The source image set identifier.

type copyImageSetInformation

dict

param copyImageSetInformation

[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.

type force

boolean

param force

Setting this flag will force the CopyImageSet operation, even if Patient, Study, or Series level metadata are mismatched across the sourceImageSet and destinationImageSet .

rtype

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.

GetImageSet (updated)

Link ¶
Changes (response)

{'overrides': {'forced': 'boolean'}}

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',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'deletedAt': datetime(2015, 1, 1),
    'message': 'string',
    'imageSetArn': 'string',
    'overrides': {
        'forced': 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) --
    
    Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.

ListImageSetVersions (updated)

Link ¶
Changes (response)

{'imageSetPropertiesList': {'overrides': {'forced': 'boolean'}}}

List image set versions.

See also: AWS API Documentation

Request Syntax

client.list_image_set_versions(
    datastoreId='string',
    imageSetId='string',
    nextToken='string',
    maxResults=123
)

type datastoreId

string

param datastoreId

[REQUIRED]

The data store identifier.

type imageSetId

string

param imageSetId

[REQUIRED]

The image set identifier.

type nextToken

string

param nextToken

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

type maxResults

integer

param maxResults

The max results count.

rtype

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
            }
        },
    ],
    '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) --
        
        Setting this flag will force the CopyImageSet and UpdateImageSetMetadata operations, even if Patient, Study, or Series level metadata are mismatched.
- nextToken (string) --
  
  The pagination token used to retrieve the list of image set versions on the next page.

UpdateImageSetMetadata (updated)

Link ¶
Changes (request)

{'force': 'boolean',
 'updateImageSetMetadataUpdates': {'revertToVersionId': 'string'}}

Update image set metadata attributes.

See also: AWS API Documentation

Request Syntax

client.update_image_set_metadata(
    datastoreId='string',
    imageSetId='string',
    latestVersionId='string',
    force=True|False,
    updateImageSetMetadataUpdates={
        'DICOMUpdates': {
            'removableAttributes': b'bytes',
            'updatableAttributes': b'bytes'
        },
        'revertToVersionId': 'string'
    }
)

type datastoreId

string

param datastoreId

[REQUIRED]

The data store identifier.

type imageSetId

string

param imageSetId

[REQUIRED]

The image set identifier.

type latestVersionId

string

param latestVersionId

[REQUIRED]

The latest image set version identifier.

type force

boolean

param force

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

type updateImageSetMetadataUpdates

dict

param updateImageSetMetadataUpdates

[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.

rtype

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.