Skip to content
AWS for Query.Farm

aws.servicecatalog.describe_record

Example SQL Queries

SELECT * FROM
aws.servicecatalog.describe_record
WHERE
"id" = 'VALUE';

Description

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Table Definition

Column NameColumn Data Type
id Required Input Column

The record identifier of the provisioned product. This identifier is returned by the request operation.

VARCHAR
accept_language Input Column

The language code.

  • jp - Japanese

  • zh - Chinese

VARCHAR
page_size Input Column

The maximum number of items to return with this call.

BIGINT
page_token Input Column

The page token for the next set of results. To retrieve the first set of results, use null.

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
next_page_token

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

VARCHAR
record_detail

Information about the product.

STRUCT(
    "record_id" VARCHAR,
    "provisioned_product_name" VARCHAR,
    "status" VARCHAR,
    "created_time" TIMESTAMP_S,
    "updated_time" TIMESTAMP_S,
    "provisioned_product_type" VARCHAR,
    "record_type" VARCHAR,
    "provisioned_product_id" VARCHAR,
    "product_id" VARCHAR,
    "provisioning_artifact_id" VARCHAR,
    "path_id" VARCHAR,
    "record_errors" STRUCT(
        "code" VARCHAR,
        "description" VARCHAR
    )[],
    "record_tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "launch_role_arn" VARCHAR
)
Show child fields
record_detail.created_time

The UTC time stamp of the creation time.

record_detail.launch_role_arn

The ARN of the launch role associated with the provisioned product.

record_detail.path_id

The path identifier.

record_detail.product_id

The product identifier.

record_detail.provisioned_product_id

The identifier of the provisioned product.

record_detail.provisioned_product_name

The user-friendly name of the provisioned product.

record_detail.provisioned_product_type

The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

record_detail.provisioning_artifact_id

The identifier of the provisioning artifact.

record_detail.record_errors[]
Show child fields
record_detail.record_errors[].code

The numeric value of the error.

record_detail.record_errors[].description

The description of the error.

record_detail.record_id

The identifier of the record.

record_detail.record_tags[]
Show child fields
record_detail.record_tags[].key

The key for this tag.

record_detail.record_tags[].value

The value for this tag.

record_detail.record_type

The record type.

  • PROVISION_PRODUCT

  • UPDATE_PROVISIONED_PRODUCT

  • TERMINATE_PROVISIONED_PRODUCT

record_detail.status

The status of the provisioned product.

  • CREATED - The request was created but the operation has not started.

  • IN_PROGRESS - The requested operation is in progress.

  • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

  • SUCCEEDED - The requested operation has successfully completed.

  • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

record_detail.updated_time

The time when the record was last updated.

record_outputs

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

STRUCT(
    "output_key" VARCHAR,
    "output_value" VARCHAR,
    "description" VARCHAR
)[]
Show child fields
record_outputs[]
Show child fields
record_outputs[].description

The description of the output.

record_outputs[].output_key

The output key.

record_outputs[].output_value

The output value.