:doc:`WorkSpaces <../../workspaces>` / Client / describe_workspace_image_permissions

************************************
describe_workspace_image_permissions
************************************



.. py:method:: WorkSpaces.Client.describe_workspace_image_permissions(**kwargs)

  

  Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions>`_  


  **Request Syntax**
  ::

    response = client.describe_workspace_image_permissions(
        ImageId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type ImageId: string
  :param ImageId: **[REQUIRED]** 

    The identifier of the image.

    

  
  :type NextToken: string
  :param NextToken: 

    If you received a ``NextToken`` from a previous call that was paginated, provide this token to receive the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of items to return.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ImageId': 'string',
          'ImagePermissions': [
              {
                  'SharedAccountId': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ImageId** *(string) --* 

        The identifier of the image.

        
      

      - **ImagePermissions** *(list) --* 

        The identifiers of the Amazon Web Services accounts that the image has been shared with.

        
        

        - *(dict) --* 

          Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see `Share or Unshare a Custom WorkSpaces Image <https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html>`__.

          
          

          - **SharedAccountId** *(string) --* 

            The identifier of the Amazon Web Services account that an image has been shared with.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.ResourceNotFoundException`

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

  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

  