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

*************
get_image_set
*************



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

  

  Get image set properties.

  

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


  **Request Syntax**
  ::

    response = client.get_image_set(
        datastoreId='string',
        imageSetId='string',
        versionId='string'
    )
    
  :type datastoreId: string
  :param datastoreId: **[REQUIRED]** 

    The data store identifier.

    

  
  :type imageSetId: string
  :param imageSetId: **[REQUIRED]** 

    The image set identifier.

    

  
  :type versionId: string
  :param versionId: 

    The image set version identifier.

    

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

          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.

        
      

      - **lastAccessedAt** *(datetime) --* 

        When the image set was last accessed.

        
      

      - **storageTier** *(string) --* 

        The storage tier of the image set.

        
  
  **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`

  