[ aws . servicecatalog ]

describe-constraint

Description

Gets information about the specified constraint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-constraint
[--accept-language <value>]
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--id (string)

The identifier of the constraint.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ConstraintDetail -> (structure)

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.