ServiceCatalog / Paginator / ListConstraintsForPortfolio

ListConstraintsForPortfolio#

class ServiceCatalog.Paginator.ListConstraintsForPortfolio#
paginator = client.get_paginator('list_constraints_for_portfolio')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId (string) –

    [REQUIRED]

    The portfolio identifier.

  • ProductId (string) – 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

{
    'ConstraintDetails': [
        {
            'ConstraintId': 'string',
            'Type': 'string',
            'Description': 'string',
            'Owner': 'string',
            'ProductId': 'string',
            'PortfolioId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConstraintDetails (list) –

      Information about the constraints.

      • (dict) –

        Information about a constraint.

        • ConstraintId (string) –

          The identifier of the constraint.

        • Type (string) –

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description (string) –

          The description of the constraint.

        • Owner (string) –

          The owner of the constraint.

        • ProductId (string) –

          The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

        • PortfolioId (string) –

          The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

    • NextToken (string) –

      A token to resume pagination.