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