HealthImaging / Paginator / ListImageSetVersions

ListImageSetVersions

class HealthImaging.Paginator.ListImageSetVersions

paginator = client.get_paginator('list_image_set_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from HealthImaging.Client.list_image_set_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datastoreId='string',
    imageSetId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• datastoreId (string) –

  [REQUIRED]

  The data store identifier.

• imageSetId (string) –

  [REQUIRED]

  The image set identifier.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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) –

    A token to resume pagination.