Skip to content
AWS for Query.Farm

aws.servicecatalog.describe_provisioning_artifact

Example SQL Queries

SELECT * FROM
aws.servicecatalog.describe_provisioning_artifact;

Description

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Table Definition

Column NameColumn Data Type
accept_language Input Column

The language code.

  • jp - Japanese

  • zh - Chinese

VARCHAR
include_provisioning_artifact_parameters Input Column

Indicates if the API call response does or does not include additional details about the provisioning parameters. 

BOOLEAN
product_id Input Column

The product identifier.

VARCHAR
product_name Input Column

The product name.

VARCHAR
provisioning_artifact_id Input Column

The identifier of the provisioning artifact.

VARCHAR
provisioning_artifact_name Input Column

The provisioning artifact name.

VARCHAR
verbose Input Column

Indicates whether a verbose level of detail is enabled.

BOOLEAN
_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
info

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

MAP(VARCHAR, VARCHAR)
provisioning_artifact_detail

Information about the provisioning artifact.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "type" VARCHAR,
    "created_time" TIMESTAMP_S,
    "active" BOOLEAN,
    "guidance" VARCHAR,
    "source_revision" VARCHAR
)
Show child fields
provisioning_artifact_detail.active

Indicates whether the product version is active.

provisioning_artifact_detail.created_time

The UTC time stamp of the creation time.

provisioning_artifact_detail.description

The description of the provisioning artifact.

provisioning_artifact_detail.guidance

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

provisioning_artifact_detail.id

The identifier of the provisioning artifact.

provisioning_artifact_detail.name

The name of the provisioning artifact.

provisioning_artifact_detail.source_revision

Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

This field only exists for Repo-Synced products.

provisioning_artifact_detail.type

The type of provisioning artifact.

  • CLOUD_FORMATION_TEMPLATE - CloudFormation template

  • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

  • TERRAFORM_CLOUD - Terraform Cloud configuration file

  • EXTERNAL - External configuration file

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.

status

The status of the current request.

VARCHAR