:doc:`HealthImaging <../../medical-imaging>` / Client / list_image_set_versions

***********************
list_image_set_versions
***********************



.. py:method:: HealthImaging.Client.list_image_set_versions(**kwargs)

  

  List image set versions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/medical-imaging-2023-07-19/ListImageSetVersions>`_  


  **Request Syntax**
  ::

    response = 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'|'IMPORTING'|'IMPORTED'|'IMPORT_FAILED',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1),
                  'deletedAt': datetime(2015, 1, 1),
                  'message': 'string',
                  'overrides': {
                      'forced': True|False
                  },
                  'isPrimary': 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) --* 

              Providing this parameter will force completion of the ``CopyImageSet`` and ``UpdateImageSetMetadata`` actions, even if metadata is inconsistent at the Patient, Study, and/or Series levels.

              
        
          

          - **isPrimary** *(boolean) --* 

            The flag to determine whether the image set is primary or not.

            
      
    
      

      - **nextToken** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`HealthImaging.Client.exceptions.ThrottlingException`

  
  *   :py:class:`HealthImaging.Client.exceptions.ConflictException`

  
  *   :py:class:`HealthImaging.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`HealthImaging.Client.exceptions.ValidationException`

  
  *   :py:class:`HealthImaging.Client.exceptions.InternalServerException`

  
  *   :py:class:`HealthImaging.Client.exceptions.ResourceNotFoundException`

  