Skip to content
AWS for Query.Farm

aws.servicecatalog.describe_product_as_admin

Example SQL Queries

SELECT * FROM
aws.servicecatalog.describe_product_as_admin;

Description

Gets information about the specified product. This operation is run with administrator access.

Table Definition

Column NameColumn Data Type
accept_language Input Column

The language code.

  • jp - Japanese

  • zh - Chinese

VARCHAR
id Input Column

The product identifier.

VARCHAR
name Input Column

The product name.

VARCHAR
source_portfolio_id Input Column

The unique identifier of the shared portfolio that the specified product is associated with.

You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned. 

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
budgets

Information about the associated budgets.

STRUCT(
    "budget_name" VARCHAR
)[]
Show child fields
budgets[]
Show child fields
budgets[].budget_name

Name of the associated budget.

product_view_detail

Information about the product view.

STRUCT(
    "product_view_summary" STRUCT(
        "id" VARCHAR,
        "product_id" VARCHAR,
        "name" VARCHAR,
        "owner" VARCHAR,
        "short_description" VARCHAR,
        "type" VARCHAR,
        "distributor" VARCHAR,
        "has_default_path" BOOLEAN,
        "support_email" VARCHAR,
        "support_description" VARCHAR,
        "support_url" VARCHAR
    ),
    "status" VARCHAR,
    "product_arn" VARCHAR,
    "created_time" TIMESTAMP_S,
    "source_connection" STRUCT(
        "type" VARCHAR,
        "connection_parameters" STRUCT(
            "code_star" STRUCT(
                "connection_arn" VARCHAR,
                "repository" VARCHAR,
                "branch" VARCHAR,
                "artifact_path" VARCHAR
            )
        ),
        "last_sync" STRUCT(
            "last_sync_time" TIMESTAMP_S,
            "last_sync_status" VARCHAR,
            "last_sync_status_message" VARCHAR,
            "last_successful_sync_time" TIMESTAMP_S,
            "last_successful_sync_provisioning_artifact_id" VARCHAR
        )
    )
)
Show child fields
product_view_detail.created_time

The UTC time stamp of the creation time.

product_view_detail.product_arn

The ARN of the product.

product_view_detail.product_view_summary

Summary information about the product view.

Show child fields
product_view_detail.product_view_summary.distributor

The distributor of the product. Contact the product administrator for the significance of this value.

product_view_detail.product_view_summary.has_default_path

Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

product_view_detail.product_view_summary.id

The product view identifier.

product_view_detail.product_view_summary.name

The name of the product.

product_view_detail.product_view_summary.owner

The owner of the product. Contact the product administrator for the significance of this value.

product_view_detail.product_view_summary.product_id

The product identifier.

product_view_detail.product_view_summary.short_description

Short description of the product.

product_view_detail.product_view_summary.support_description

The description of the support for this Product.

product_view_detail.product_view_summary.support_email

The email contact information to obtain support for this Product.

product_view_detail.product_view_summary.support_url

The URL information to obtain support for this Product.

product_view_detail.product_view_summary.type

The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

product_view_detail.source_connection

A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

Show child fields
product_view_detail.source_connection.connection_parameters

The connection details based on the connection Type.

Show child fields
product_view_detail.source_connection.connection_parameters.code_star

Provides ConnectionType details.

Show child fields
product_view_detail.source_connection.connection_parameters.code_star.artifact_path

The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

product_view_detail.source_connection.connection_parameters.code_star.branch

The specific branch where the artifact resides.

product_view_detail.source_connection.connection_parameters.code_star.connection_arn

The CodeStar ARN, which is the connection between Service Catalog and the external repository.

product_view_detail.source_connection.connection_parameters.code_star.repository

The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

product_view_detail.source_connection.last_sync

Provides details about the product's connection sync and contains the following sub-fields.

  • LastSyncTime

  • LastSyncStatus

  • LastSyncStatusMessage

  • LastSuccessfulSyncTime

  • LastSuccessfulSyncProvisioningArtifactID

Show child fields
product_view_detail.source_connection.last_sync.last_successful_sync_provisioning_artifact_id

The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

product_view_detail.source_connection.last_sync.last_successful_sync_time

The time of the latest successful sync from the source repo artifact to the Service Catalog product.

product_view_detail.source_connection.last_sync.last_sync_status

The current status of the sync. Responses include SUCCEEDED or FAILED.

product_view_detail.source_connection.last_sync.last_sync_status_message

The sync's status message.

product_view_detail.source_connection.last_sync.last_sync_time

The time of the last attempted sync from the repository to the Service Catalog product.

product_view_detail.source_connection.type

The only supported SourceConnection type is Codestar.

product_view_detail.status

The status of the product.

  • AVAILABLE - The product is ready for use.

  • CREATING - Product creation has started; the product is not ready for use.

  • FAILED - An action failed.

provisioning_artifact_summaries

Information about the provisioning artifacts (also known as versions) for the specified product.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "created_time" TIMESTAMP_S,
    "provisioning_artifact_metadata" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
provisioning_artifact_summaries[]
Show child fields
provisioning_artifact_summaries[].created_time

The UTC time stamp of the creation time.

provisioning_artifact_summaries[].description

The description of the provisioning artifact.

provisioning_artifact_summaries[].id

The identifier of the provisioning artifact.

provisioning_artifact_summaries[].name

The name of the provisioning artifact.

provisioning_artifact_summaries[].provisioning_artifact_metadata

The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

tag_options

Information about the TagOptions associated with the product.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR,
    "active" BOOLEAN,
    "id" VARCHAR,
    "owner" VARCHAR
)[]
Show child fields
tag_options[]
Show child fields
tag_options[].active

The TagOption active state.

tag_options[].id

The TagOption identifier.

tag_options[].key

The TagOption key.

tag_options[].owner

The Amazon Web Services account Id of the owner account that created the TagOption.

tag_options[].value

The TagOption value.

tags

Information about the tags associated with the product.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The tag key.

tags[].value

The value for this key.