list_principals_for_portfolio

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

Request Syntax

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

Parameters

• AcceptLanguage (string) --

  The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese
• PortfolioId (string) --

  [REQUIRED]

  The portfolio identifier.

• PageSize (integer) -- The maximum number of items to return with this call.
• PageToken (string) -- The page token for the next set of results. To retrieve the first set of results, use null.

Return type

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 (IAM user, role, or group). This field allows for an ARN with no accountID if the PrincipalType is an IAM_PATTERN .

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

  • 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

• ServiceCatalog.Client.exceptions.ResourceNotFoundException
• ServiceCatalog.Client.exceptions.InvalidParametersException