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

**********************
list_share_invitations
**********************



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

  

  List the share invitations.

   

  ``WorkloadNamePrefix``, ``LensNamePrefix``, ``ProfileNamePrefix``, and ``TemplateNamePrefix`` are mutually exclusive. Use the parameter that matches your ``ShareResourceType``.

  

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


  **Request Syntax**
  ::

    response = client.list_share_invitations(
        WorkloadNamePrefix='string',
        LensNamePrefix='string',
        ShareResourceType='WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
        NextToken='string',
        MaxResults=123,
        ProfileNamePrefix='string',
        TemplateNamePrefix='string'
    )
    
  :type WorkloadNamePrefix: string
  :param WorkloadNamePrefix: 

    An optional string added to the beginning of each workload name returned in the results.

    

  
  :type LensNamePrefix: string
  :param LensNamePrefix: 

    An optional string added to the beginning of each lens name returned in the results.

    

  
  :type ShareResourceType: string
  :param ShareResourceType: 

    The type of share invitations to be returned.

    

  
  :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 ProfileNamePrefix: string
  :param ProfileNamePrefix: 

    An optional string added to the beginning of each profile name returned in the results.

    

  
  :type TemplateNamePrefix: string
  :param TemplateNamePrefix: 

    An optional string added to the beginning of each review template name returned in the results.

    

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

    
    ::

      {
          'ShareInvitationSummaries': [
              {
                  'ShareInvitationId': 'string',
                  'SharedBy': 'string',
                  'SharedWith': 'string',
                  'PermissionType': 'READONLY'|'CONTRIBUTOR',
                  'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
                  'WorkloadName': 'string',
                  'WorkloadId': 'string',
                  'LensName': 'string',
                  'LensArn': 'string',
                  'ProfileName': 'string',
                  'ProfileArn': 'string',
                  'TemplateName': 'string',
                  'TemplateArn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Input for List Share Invitations

      
      

      - **ShareInvitationSummaries** *(list) --* 

        List of share invitation summaries in a workload.

        
        

        - *(dict) --* 

          A share invitation summary return object.

          
          

          - **ShareInvitationId** *(string) --* 

            The ID assigned to the share invitation.

            
          

          - **SharedBy** *(string) --* 

            An Amazon Web Services account ID.

            
          

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

            
          

          - **ShareResourceType** *(string) --* 

            The resource type of the share invitation.

            
          

          - **WorkloadName** *(string) --* 

            The name of the workload.

             

            The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

            
          

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

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

            
          

          - **LensName** *(string) --* 

            The full name of the lens.

            
          

          - **LensArn** *(string) --* 

            The ARN for the lens.

            
          

          - **ProfileName** *(string) --* 

            The profile name.

            
          

          - **ProfileArn** *(string) --* 

            The profile ARN.

            
          

          - **TemplateName** *(string) --* 

            The name of the review template.

            
          

          - **TemplateArn** *(string) --* 

            The review template ARN.

            
      
    
      

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

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

  