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
    }
}

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.

Exceptions