ServiceCatalog / Paginator / ListPortfoliosForProduct

ListPortfoliosForProduct#

class ServiceCatalog.Paginator.ListPortfoliosForProduct#
paginator = client.get_paginator('list_portfolios_for_product')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceptLanguage='string',
    ProductId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProductId (string) –

    [REQUIRED]

    The product 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:

dict

Returns:

Response Syntax

{
    'PortfolioDetails': [
        {
            'Id': 'string',
            'ARN': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ProviderName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PortfolioDetails (list) –

      Information about the portfolios.

      • (dict) –

        Information about a portfolio.

        • Id (string) –

          The portfolio identifier.

        • ARN (string) –

          The ARN assigned to the portfolio.

        • DisplayName (string) –

          The name to use for display purposes.

        • Description (string) –

          The description of the portfolio.

        • CreatedTime (datetime) –

          The UTC time stamp of the creation time.

        • ProviderName (string) –

          The name of the portfolio provider.

    • NextToken (string) –

      A token to resume pagination.