ServiceCatalog / Paginator / ListPrincipalsForPortfolio


class ServiceCatalog.Paginator.ListPrincipalsForPortfolio#
paginator = client.get_paginator('list_principals_for_portfolio')

Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_principals_for_portfolio().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId (string) –


    The portfolio identifier.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'Principals': [
            'PrincipalARN': 'string',
            'PrincipalType': 'IAM'|'IAM_PATTERN'
    'NextToken': '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 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.

    • NextToken (string) –

      A token to resume pagination.