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'|'IMPORTING'|'IMPORTED'|'IMPORT_FAILED',
        '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'|'IMPORTING'|'IMPORTED'|'IMPORT_FAILED',
        '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