Skip to content
AWS for Query.Farm

aws.qapps.get_library_item

Example SQL Queries

SELECT * FROM
aws.qapps.get_library_item
WHERE
"instance_id" = 'VALUE'
AND "library_item_id" = 'VALUE';

Description

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The unique identifier of the Amazon Q Business application environment instance.

VARCHAR
library_item_id Required Input Column

The unique identifier of the library item.

VARCHAR
app_id Input Column

The unique identifier of the Q App associated with the library item.

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.

app_version

The version of the Q App associated with the library item.

BIGINT
categories

The categories associated with the library item for discovery.

STRUCT(
    "id" VARCHAR,
    "title" VARCHAR
)[]
Show child fields
categories[]
Show child fields
categories[].id

The unique identifier of the category.

categories[].title

The title or name of the category.

created_at

The date and time the library item was created.

TIMESTAMP_S
created_by

The user who created the library item.

VARCHAR
is_rated_by_user

Whether the current user has rated the library item.

BOOLEAN
rating_count

The number of ratings the library item has received from users.

BIGINT
status

The status of the library item, such as "Published".

VARCHAR
updated_at

The date and time the library item was last updated.

TIMESTAMP_S
updated_by

The user who last updated the library item.

VARCHAR
user_count

The number of users who have associated the Q App with their account.

BIGINT