Skip to content
AWS for Query.Farm

aws.qbusiness.list_messages

Example SQL Queries

SELECT * FROM
aws.qbusiness.list_messages
WHERE
"conversation_id" = 'VALUE'
AND "application_id" = 'VALUE';

Description

Gets a list of messages associated with an Amazon Q Business web experience.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier for the Amazon Q Business application.

VARCHAR
conversation_id Required Input Column

The identifier of the Amazon Q Business web experience conversation.

VARCHAR
user_id Input Column

The identifier of the user involved in the Amazon Q Business web experience conversation.

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
action_execution

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

STRUCT(
    "plugin_id" VARCHAR,
    "payload" MAP(VARCHAR, STRUCT(
            "value" VARCHAR
        )),
    "payload_field_name_separator" VARCHAR
)
Show child fields
action_execution.payload

A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

action_execution.payload_field_name_separator

A string used to retain information about the hierarchical contexts within an action execution event payload.

action_execution.plugin_id

The identifier of the plugin the action is attached to.

action_review

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

STRUCT(
    "plugin_id" VARCHAR,
    "plugin_type" VARCHAR,
    "payload" MAP(VARCHAR, STRUCT(
            "display_name" VARCHAR,
            "display_order" BIGINT,
            "display_description" VARCHAR,
            "type" VARCHAR,
            "value" VARCHAR,
            "allowed_values" STRUCT(
                "value" VARCHAR,
                "display_value" VARCHAR
            )[],
            "allowed_format" VARCHAR,
            "required" BOOLEAN
        )),
    "payload_field_name_separator" VARCHAR
)
Show child fields
action_review.payload

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

action_review.payload_field_name_separator

A string used to retain information about the hierarchical contexts within an action review payload.

action_review.plugin_id

The identifier of the plugin associated with the action review.

action_review.plugin_type

The type of plugin.

attachments

A file directly uploaded into an Amazon Q Business web experience chat.

STRUCT(
    "name" VARCHAR,
    "status" VARCHAR,
    "error" STRUCT(
        "error_message" VARCHAR,
        "error_code" VARCHAR
    )
)[]
Show child fields
attachments[]
Show child fields
attachments[].error

An error associated with a file uploaded during chat.

Show child fields
attachments[].error.error_code

The code associated with the data source sync error.

attachments[].error.error_message

The message explaining the data source sync error.

attachments[].name

The name of a file uploaded during chat.

attachments[].status

The status of a file uploaded during chat.

body

The content of the Amazon Q Business web experience message.

VARCHAR
message_id

The identifier of the Amazon Q Business web experience message.

VARCHAR
source_attribution

The source documents used to generate Amazon Q Business web experience message.

STRUCT(
    "title" VARCHAR,
    "snippet" VARCHAR,
    "url" VARCHAR,
    "citation_number" BIGINT,
    "updated_at" TIMESTAMP_S,
    "text_message_segments" STRUCT(
        "begin_offset" BIGINT,
        "end_offset" BIGINT,
        "snippet_excerpt" STRUCT(
            "text" VARCHAR
        )
    )[]
)[]
Show child fields
source_attribution[]
Show child fields
source_attribution[].citation_number

The number attached to a citation in an Amazon Q Business generated response.

source_attribution[].snippet

The content extract from the document on which the generated response is based.

source_attribution[].text_message_segments[]
Show child fields
source_attribution[].text_message_segments[].begin_offset

The zero-based location in the response string where the source attribution starts.

source_attribution[].text_message_segments[].end_offset

The zero-based location in the response string where the source attribution ends.

source_attribution[].text_message_segments[].snippet_excerpt

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Show child fields
source_attribution[].text_message_segments[].snippet_excerpt.text

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.

source_attribution[].title

The title of the document which is the source for the Amazon Q Business generated response.

source_attribution[].updated_at

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

source_attribution[].url

The URL of the document which is the source for the Amazon Q Business generated response.

time

The timestamp of the first Amazon Q Business web experience message.

TIMESTAMP_S
type

The type of Amazon Q Business message, whether HUMAN or AI generated.

VARCHAR