Skip to content
AWS for Query.Farm

aws.qapps.get_q_app

Example SQL Queries

SELECT * FROM
aws.qapps.get_q_app
WHERE
"instance_id" = 'VALUE'
AND "app_id" = 'VALUE';

Description

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The unique identifier of the Q App.

VARCHAR
instance_id Required Input Column

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

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_arn

The Amazon Resource Name (ARN) of the Q App.

VARCHAR
app_definition

The full definition of the Q App, specifying the cards and flow.

STRUCT(
    "app_definition_version" VARCHAR,
    "cards" STRUCT(
        "text_input" STRUCT(
            "id" VARCHAR,
            "title" VARCHAR,
            "dependencies" VARCHAR[],
            "type" VARCHAR,
            "placeholder" VARCHAR,
            "default_value" VARCHAR
        ),
        "q_query" STRUCT(
            "id" VARCHAR,
            "title" VARCHAR,
            "dependencies" VARCHAR[],
            "type" VARCHAR,
            "prompt" VARCHAR,
            "output_source" VARCHAR,
            "attribute_filter" STRUCT(
                "equals_to" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "contains_all" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "contains_any" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "greater_than" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "greater_than_or_equals" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "less_than" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                ),
                "less_than_or_equals" STRUCT(
                    "name" VARCHAR,
                    "value" STRUCT(
                        "string_value" VARCHAR,
                        "string_list_value" VARCHAR[],
                        "long_value" BIGINT,
                        "date_value" TIMESTAMP_S
                    )
                )
            )
        ),
        "q_plugin" STRUCT(
            "id" VARCHAR,
            "title" VARCHAR,
            "dependencies" VARCHAR[],
            "type" VARCHAR,
            "prompt" VARCHAR,
            "plugin_type" VARCHAR,
            "plugin_id" VARCHAR
        ),
        "file_upload" STRUCT(
            "id" VARCHAR,
            "title" VARCHAR,
            "dependencies" VARCHAR[],
            "type" VARCHAR,
            "filename" VARCHAR,
            "file_id" VARCHAR,
            "allow_override" BOOLEAN
        )
    )[],
    "can_edit" BOOLEAN
)
Show child fields
app_definition.app_definition_version

The version of the app definition schema or specification.

app_definition.can_edit

A flag indicating whether the Q App's definition can be edited by the user.

app_definition.cards[]
Show child fields
app_definition.cards[].file_upload

A container for the properties of the file upload card.

Show child fields
app_definition.cards[].file_upload.allow_override

A flag indicating if the user can override the default file for the upload card.

app_definition.cards[].file_upload.dependencies[]
app_definition.cards[].file_upload.file_id

The unique identifier of the file associated with the card.

app_definition.cards[].file_upload.filename

The name of the file being uploaded.

app_definition.cards[].file_upload.id

The unique identifier of the file upload card.

app_definition.cards[].file_upload.title

The title of the file upload card.

app_definition.cards[].file_upload.type

The type of the card.

app_definition.cards[].q_plugin

A container for the properties of the plugin card.

Show child fields
app_definition.cards[].q_plugin.dependencies[]
app_definition.cards[].q_plugin.id

The unique identifier of the plugin card.

app_definition.cards[].q_plugin.plugin_id

The unique identifier of the plugin used by the card.

app_definition.cards[].q_plugin.plugin_type

The type or category of the plugin used by the card.

app_definition.cards[].q_plugin.prompt

The prompt or instructions displayed for the plugin card.

app_definition.cards[].q_plugin.title

The title or label of the plugin card.

app_definition.cards[].q_plugin.type

The type of the card.

app_definition.cards[].q_query

A container for the properties of the query card.

Show child fields
app_definition.cards[].q_query.attribute_filter

The Amazon Q Business filters applied in this query card when resolving data sources

Show child fields
app_definition.cards[].q_query.attribute_filter.contains_all

Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.contains_all.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.contains_all.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.contains_all.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.contains_all.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.contains_all.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.contains_all.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.contains_any

Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.contains_any.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.contains_any.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.contains_any.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.contains_any.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.contains_any.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.contains_any.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.equals_to

Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.equals_to.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.equals_to.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.equals_to.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.equals_to.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.equals_to.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.equals_to.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.greater_than

Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.greater_than.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.greater_than.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.greater_than.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.greater_than.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.greater_than.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.greater_than.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.greater_than_or_equals

Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.greater_than_or_equals.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.less_than

Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.less_than.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.less_than.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.less_than.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.less_than.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.less_than.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.less_than.value.string_value

A string.

app_definition.cards[].q_query.attribute_filter.less_than_or_equals

Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.

Show child fields
app_definition.cards[].q_query.attribute_filter.less_than_or_equals.name

The identifier for the attribute.

app_definition.cards[].q_query.attribute_filter.less_than_or_equals.value

The value of the attribute.

Show child fields
app_definition.cards[].q_query.attribute_filter.less_than_or_equals.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

app_definition.cards[].q_query.attribute_filter.less_than_or_equals.value.long_value

A long integer value.

app_definition.cards[].q_query.attribute_filter.less_than_or_equals.value.string_list_value[]
app_definition.cards[].q_query.attribute_filter.less_than_or_equals.value.string_value

A string.

app_definition.cards[].q_query.dependencies[]
app_definition.cards[].q_query.id

The unique identifier of the query card.

app_definition.cards[].q_query.output_source

The source or type of output generated by the query card.

app_definition.cards[].q_query.prompt

The prompt or instructions displayed for the query card.

app_definition.cards[].q_query.title

The title or label of the query card.

app_definition.cards[].q_query.type

The type of the card.

app_definition.cards[].text_input

A container for the properties of the text input card.

Show child fields
app_definition.cards[].text_input.default_value

The default value to pre-populate in the text input field.

app_definition.cards[].text_input.dependencies[]
app_definition.cards[].text_input.id

The unique identifier of the text input card.

app_definition.cards[].text_input.placeholder

The placeholder text to display in the text input field.

app_definition.cards[].text_input.title

The title or label of the text input card.

app_definition.cards[].text_input.type

The type of the card.

app_version

The version of the Q App.

BIGINT
created_at

The date and time the Q App was created.

TIMESTAMP_S
created_by

The user who created the Q App.

VARCHAR
description

The description of the Q App.

VARCHAR
initial_prompt

The initial prompt displayed when the Q App is started.

VARCHAR
required_capabilities

The capabilities required to run the Q App, such as file upload or third-party integrations.

VARCHAR[]
Show child fields
required_capabilities[]
status

The status of the Q App.

VARCHAR
title

The title of the Q App.

VARCHAR
updated_at

The date and time the Q App was last updated.

TIMESTAMP_S
updated_by

The user who last updated the Q App.

VARCHAR