| Column Name | Column Data Type |
|---|
application_id Required Input Column
The identifier of the application for which the chat controls are configured. | 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 |
blocked_phrases
The phrases blocked from chat by your chat control configuration. | STRUCT(
"blocked_phrases" VARCHAR[],
"system_message_override" VARCHAR
) |
Show child fields- blocked_phrases.blocked_phrases[]
- blocked_phrases.system_message_override
The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
|
creator_mode_configuration
The configuration details for CREATOR_MODE. | STRUCT(
"creator_mode_control" VARCHAR
) |
Show child fields- creator_mode_configuration.creator_mode_control
Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
|
response_scope
The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat. | VARCHAR |
topic_configurations
The topic specific controls configured for a Amazon Q Business application. | STRUCT(
"name" VARCHAR,
"description" VARCHAR,
"example_chat_messages" VARCHAR[],
"rules" STRUCT(
"included_users_and_groups" STRUCT(
"user_ids" VARCHAR[],
"user_groups" VARCHAR[]
),
"excluded_users_and_groups" STRUCT(
"user_ids" VARCHAR[],
"user_groups" VARCHAR[]
),
"rule_type" VARCHAR,
"rule_configuration" STRUCT(
"content_blocker_rule" STRUCT(
"system_message_override" VARCHAR
),
"content_retrieval_rule" STRUCT(
"eligible_data_sources" STRUCT(
"index_id" VARCHAR,
"data_source_id" VARCHAR
)[]
)
)
)[]
)[] |
Show child fields- topic_configurations[]
Show child fields- topic_configurations[].description
A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration. - topic_configurations[].example_chat_messages[]
- topic_configurations[].name
A name for your topic control configuration. - topic_configurations[].rules[]
Show child fields- topic_configurations[].rules[].excluded_users_and_groups
Users and groups to be excluded from a rule. Show child fields- topic_configurations[].rules[].excluded_users_and_groups.user_groups[]
- topic_configurations[].rules[].excluded_users_and_groups.user_ids[]
- topic_configurations[].rules[].included_users_and_groups
Users and groups to be included in a rule. Show child fields- topic_configurations[].rules[].included_users_and_groups.user_groups[]
- topic_configurations[].rules[].included_users_and_groups.user_ids[]
- topic_configurations[].rules[].rule_configuration
The configuration information for a rule. Show child fields- topic_configurations[].rules[].rule_configuration.content_blocker_rule
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. Show child fields- topic_configurations[].rules[].rule_configuration.content_blocker_rule.system_message_override
The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
- topic_configurations[].rules[].rule_configuration.content_retrieval_rule
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. Show child fields- topic_configurations[].rules[].rule_configuration.content_retrieval_rule.eligible_data_sources[]
Show child fields- topic_configurations[].rules[].rule_configuration.content_retrieval_rule.eligible_data_sources[].data_source_id
The identifier of the data source. - topic_configurations[].rules[].rule_configuration.content_retrieval_rule.eligible_data_sources[].index_id
The identifier of the index the data source is attached to.
- topic_configurations[].rules[].rule_type
The type of rule.
|