Skip to content

aws.qbusiness.get_application

Example SQL Queries

SELECT * FROM
aws.qbusiness.get_application
WHERE
"application_id" = 'VALUE';

Description

Gets information about an existing Amazon Q Business application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the Amazon Q Business application.

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
application_arn

The Amazon Resource Name (ARN) of the Amazon Q Business application.

VARCHAR
attachments_configuration

Settings for whether end users can upload files directly during chat.

STRUCT(
"attachments_control_mode" VARCHAR
)
Show child fields
attachments_configuration.attachments_control_mode

Information about whether file upload during chat functionality is activated for your application.

auto_subscription_configuration

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

STRUCT(
"auto_subscribe" VARCHAR,
"default_subscription_type" VARCHAR
)
Show child fields
auto_subscription_configuration.auto_subscribe

Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

auto_subscription_configuration.default_subscription_type

Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.

client_ids_for_oidc

The OIDC client ID for a Amazon Q Business application.

VARCHAR[]
Show child fields
client_ids_for_oidc[]
created_at

The Unix timestamp when the Amazon Q Business application was last updated.

TIMESTAMP_S
description

A description for the Amazon Q Business application.

VARCHAR
display_name

The name of the Amazon Q Business application.

VARCHAR
encryption_configuration

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

STRUCT(
"kms_key_id" VARCHAR
)
Show child fields
encryption_configuration.kms_key_id

The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

error

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

STRUCT(
"error_message" VARCHAR,
"error_code" VARCHAR
)
Show child fields
error.error_code

The code associated with the data source sync error.

error.error_message

The message explaining the data source sync error.

iam_identity_provider_arn

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

VARCHAR
identity_center_application_arn

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

VARCHAR
identity_type

The authentication type being used by a Amazon Q Business application.

VARCHAR
personalization_configuration

Configuration information about chat response personalization. For more information, see Personalizing chat responses.

STRUCT(
"personalization_control_mode" VARCHAR
)
Show child fields
personalization_configuration.personalization_control_mode

An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

q_apps_configuration

Settings for whether end users can create and use Amazon Q Apps in the web experience.

STRUCT(
"q_apps_control_mode" VARCHAR
)
Show child fields
q_apps_configuration.q_apps_control_mode

Status information about whether end users can create and use Amazon Q Apps in the web experience.

role_arn

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

VARCHAR
status

The status of the Amazon Q Business application.

VARCHAR
updated_at

The Unix timestamp when the Amazon Q Business application was last updated.

TIMESTAMP_S