:doc:`WellArchitected <../../wellarchitected>` / Client / list_workload_shares

********************
list_workload_shares
********************



.. py:method:: WellArchitected.Client.list_workload_shares(**kwargs)

  

  List the workload shares associated with the workload.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadShares>`_  


  **Request Syntax**
  ::

    response = client.list_workload_shares(
        WorkloadId='string',
        SharedWithPrefix='string',
        NextToken='string',
        MaxResults=123,
        Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
    )
    
  :type WorkloadId: string
  :param WorkloadId: **[REQUIRED]** 

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    

  
  :type SharedWithPrefix: string
  :param SharedWithPrefix: 

    The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for this request.

    

  
  :type Status: string
  :param Status: 

    The status of the share request.

    

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

    
    ::

      {
          'WorkloadId': 'string',
          'WorkloadShareSummaries': [
              {
                  'ShareId': 'string',
                  'SharedWith': 'string',
                  'PermissionType': 'READONLY'|'CONTRIBUTOR',
                  'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
                  'StatusMessage': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Input for List Workload Share

      
      

      - **WorkloadId** *(string) --* 

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        
      

      - **WorkloadShareSummaries** *(list) --* 

        A list of workload share summaries.

        
        

        - *(dict) --* 

          A workload share summary return object.

          
          

          - **ShareId** *(string) --* 

            The ID associated with the share.

            
          

          - **SharedWith** *(string) --* 

            The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

            
          

          - **PermissionType** *(string) --* 

            Permission granted on a share request.

            
          

          - **Status** *(string) --* 

            The status of the share request.

            
          

          - **StatusMessage** *(string) --* 

            Optional message to compliment the Status field.

            
      
    
      

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

        The token to use to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`WellArchitected.Client.exceptions.ValidationException`

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

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

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

  
  *   :py:class:`WellArchitected.Client.exceptions.ThrottlingException`

  