ServiceCatalog / Client / describe_constraint

describe_constraint

ServiceCatalog.Client.describe_constraint(**kwargs)

Gets information about the specified constraint.

See also: AWS API Documentation

Request Syntax

response = client.describe_constraint(
    AcceptLanguage='string',
    Id='string'
)

Parameters:

• AcceptLanguage (string) –

  The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

• Id (string) –

  [REQUIRED]

  The identifier of the constraint.

Return type:

dict

Returns:

Response Syntax

{
    'ConstraintDetail': {
        'ConstraintId': 'string',
        'Type': 'string',
        'Description': 'string',
        'Owner': 'string',
        'ProductId': 'string',
        'PortfolioId': 'string'
    },
    'ConstraintParameters': 'string',
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

• (dict) –

  • ConstraintDetail (dict) –

    Information about the 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.

  • ConstraintParameters (string) –

    The constraint parameters.

  • Status (string) –

    The status of the current request.

Exceptions

• ServiceCatalog.Client.exceptions.ResourceNotFoundException