Skip to content

aws.servicecatalog.describe_provisioning_parameters

Example SQL Queries

SELECT * FROM
aws.servicecatalog.describe_provisioning_parameters;

Description

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Table Definition

Column NameColumn Data Type
accept_language Input Column

The language code.

  • jp - Japanese

  • zh - Chinese

VARCHAR
path_id Input Column

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

VARCHAR
path_name Input Column

The name of the path. You must provide the name or ID, but not both.

VARCHAR
product_id Input Column

The product identifier. You must provide the product name or ID, but not both.

VARCHAR
product_name Input Column

The name of the product. You must provide the name or ID, but not both.

VARCHAR
provisioning_artifact_id Input Column

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

VARCHAR
provisioning_artifact_name Input Column

The name of the provisioning artifact. You must provide the name or ID, but not both.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
constraint_summaries

Information about the constraints used to provision the product.

STRUCT(
"type" VARCHAR,
"description" VARCHAR
)[]
Show child fields
constraint_summaries[]
Show child fields
constraint_summaries[].description

The description of the constraint.

constraint_summaries[].type

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • STACKSET

  • TEMPLATE

provisioning_artifact_output_keys

A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

STRUCT(
"key" VARCHAR,
"description" VARCHAR
)[]
Show child fields
provisioning_artifact_output_keys[]
Show child fields
provisioning_artifact_output_keys[].description

Description of the provisioning artifact output key.

provisioning_artifact_output_keys[].key

The provisioning artifact output key.

provisioning_artifact_outputs

The output of the provisioning artifact.

STRUCT(
"key" VARCHAR,
"description" VARCHAR
)[]
Show child fields
provisioning_artifact_outputs[]
Show child fields
provisioning_artifact_outputs[].description

Description of the provisioning artifact output key.

provisioning_artifact_outputs[].key

The provisioning artifact output key.

provisioning_artifact_parameters

Information about the parameters used to provision the product.

STRUCT(
"parameter_key" VARCHAR,
"default_value" VARCHAR,
"parameter_type" VARCHAR,
"is_no_echo" BOOLEAN,
"description" VARCHAR,
"parameter_constraints" STRUCT(
"allowed_values" VARCHAR[],
"allowed_pattern" VARCHAR,
"constraint_description" VARCHAR,
"max_length" VARCHAR,
"min_length" VARCHAR,
"max_value" VARCHAR,
"min_value" VARCHAR
)
)[]
Show child fields
provisioning_artifact_parameters[]
Show child fields
provisioning_artifact_parameters[].default_value

The default value.

provisioning_artifact_parameters[].description

The description of the parameter.

provisioning_artifact_parameters[].is_no_echo

If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

provisioning_artifact_parameters[].parameter_constraints

Constraints that the administrator has put on a parameter.

Show child fields
provisioning_artifact_parameters[].parameter_constraints.allowed_pattern

A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

provisioning_artifact_parameters[].parameter_constraints.allowed_values[]
provisioning_artifact_parameters[].parameter_constraints.constraint_description

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

provisioning_artifact_parameters[].parameter_constraints.max_length

An integer value that determines the largest number of characters you want to allow for String types.

provisioning_artifact_parameters[].parameter_constraints.max_value

A numeric value that determines the largest numeric value you want to allow for Number types.

provisioning_artifact_parameters[].parameter_constraints.min_length

An integer value that determines the smallest number of characters you want to allow for String types.

provisioning_artifact_parameters[].parameter_constraints.min_value

A numeric value that determines the smallest numeric value you want to allow for Number types.

provisioning_artifact_parameters[].parameter_key

The parameter key.

provisioning_artifact_parameters[].parameter_type

The parameter type.

provisioning_artifact_preferences

An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.

STRUCT(
"stack_set_accounts" VARCHAR[],
"stack_set_regions" VARCHAR[]
)
Show child fields
provisioning_artifact_preferences.stack_set_accounts[]
provisioning_artifact_preferences.stack_set_regions[]
tag_options

Information about the TagOptions associated with the resource.

STRUCT(
"key" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
tag_options[]
Show child fields
tag_options[].key

The TagOption key.

tag_options[].values[]
usage_instructions

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

STRUCT(
"type" VARCHAR,
"value" VARCHAR
)[]
Show child fields
usage_instructions[]
Show child fields
usage_instructions[].type

The usage instruction type for the value.

usage_instructions[].value

The usage instruction value for this type.