:doc:`ServiceCatalog <../../servicecatalog>` / Client / list_principals_for_portfolio

*****************************
list_principals_for_portfolio
*****************************



.. py:method:: ServiceCatalog.Client.list_principals_for_portfolio(**kwargs)

  

  Lists all ``PrincipalARN``s and corresponding ``PrincipalType``s associated with the specified portfolio.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ListPrincipalsForPortfolio>`_  


  **Request Syntax**
  ::

    response = client.list_principals_for_portfolio(
        AcceptLanguage='string',
        PortfolioId='string',
        PageSize=123,
        PageToken='string'
    )
    
  :type AcceptLanguage: string
  :param AcceptLanguage: 

    The language code.

     

    
    * ``jp`` - Japanese
     
    * ``zh`` - Chinese
    

    

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

    The portfolio identifier.

    

  
  :type PageSize: integer
  :param PageSize: 

    The maximum number of items to return with this call.

    

  
  :type PageToken: string
  :param PageToken: 

    The page token for the next set of results. To retrieve the first set of results, use null.

    

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

    
    ::

      {
          'Principals': [
              {
                  'PrincipalARN': 'string',
                  'PrincipalType': 'IAM'|'IAM_PATTERN'
              },
          ],
          'NextPageToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Principals** *(list) --* 

        The ``PrincipalARN``s and corresponding ``PrincipalType``s associated with the portfolio.

        
        

        - *(dict) --* 

          Information about a principal.

          
          

          - **PrincipalARN** *(string) --* 

            The ARN of the principal (user, role, or group). This field allows for an ARN with no ``accountID``, with or without wildcard characters if the ``PrincipalType`` is an ``IAM_PATTERN``.

             

            For more information, review `associate-principal-with-portfolio <https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options>`__ in the Amazon Web Services CLI Command Reference.

            
          

          - **PrincipalType** *(string) --* 

            The principal type. The supported value is ``IAM`` if you use a fully defined ARN, or ``IAM_PATTERN`` if you use an ARN with no ``accountID``, with or without wildcard characters.

            
      
    
      

      - **NextPageToken** *(string) --* 

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

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

  
  *   :py:class:`ServiceCatalog.Client.exceptions.InvalidParametersException`

  