list_constraints_for_portfolio

ServiceCatalog.Client.list_constraints_for_portfolio(**kwargs)

Lists the constraints for the specified portfolio and product.

See also: AWS API Documentation

Request Syntax

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

Parameters

• AcceptLanguage (string) --

  The language code.

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

  [REQUIRED]

  The portfolio identifier.

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

{
    'ConstraintDetails': [
        {
            'ConstraintId': 'string',
            'Type': 'string',
            'Description': 'string',
            'Owner': 'string',
            'ProductId': 'string',
            'PortfolioId': 'string'
        },
    ],
    'NextPageToken': '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.

  • 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