Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

MetadataEvent - Amazon Q Business

MetadataEvent

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

Contents

conversationId

The identifier of the conversation with which the generated metadata is associated.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: No

finalTextMessage

The final text output message generated by the system.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

sourceAttributions

The source documents used to generate the conversation response.

Type: Array of SourceAttribution objects

Required: No

systemMessageId

The identifier of an Amazon Q Business AI generated message within the conversation.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: No

userMessageId

The identifier of an Amazon Q Business end user text input message within the conversation.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.