@aws-sdk/client-qbusiness 3.564.0 → 3.566.0

package/dist-types/models/models_0.d.ts

@@ -206,6 +206,30 @@ export interface ActionExecution {
      */
     payloadFieldNameSeparator: string | undefined;
 }
+/**
+ * <p>A request from an end user signalling an intent to perform an Amazon Q Business plugin
+ *             action during a streaming chat.</p>
+ * @public
+ */
+export interface ActionExecutionEvent {
+    /**
+     * <p>The identifier of the plugin for which the action is being requested.</p>
+     * @public
+     */
+    pluginId: string | undefined;
+    /**
+     * <p>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. </p>
+     * @public
+     */
+    payload: Record<string, ActionExecutionPayloadField> | undefined;
+    /**
+     * <p>A string used to retain information about the hierarchical contexts within a action
+     *             execution event payload.</p>
+     * @public
+     */
+    payloadFieldNameSeparator: string | undefined;
+}
 /**
  * @public
  * @enum
@@ -252,6 +276,13 @@ export interface ActionReviewPayloadField {
      * @public
      */
     displayOrder?: number;
+    /**
+     * <p>The field level description of each action review input field. This could be an
+     *             explanation of the field. In the Amazon Q Business web experience, these descriptions could
+     *             be used to display as tool tips to help users understand the field. </p>
+     * @public
+     */
+    displayDescription?: string;
     /**
      * <p>The type of field. </p>
      * @public
@@ -268,6 +299,13 @@ export interface ActionReviewPayloadField {
      * @public
      */
     allowedValues?: ActionReviewPayloadFieldAllowedValue[];
+    /**
+     * <p>The expected data format for the action review input field value. For example, in PTO
+     *             request, <code>from</code> and <code>to</code> would be of <code>datetime</code> allowed
+     *             format. </p>
+     * @public
+     */
+    allowedFormat?: string;
     /**
      * <p>Information about whether the field is required.</p>
      * @public
@@ -279,6 +317,7 @@ export interface ActionReviewPayloadField {
  * @enum
  */
 export declare const PluginType: {
+    readonly CUSTOM: "CUSTOM";
     readonly JIRA: "JIRA";
     readonly SALESFORCE: "SALESFORCE";
     readonly SERVICE_NOW: "SERVICE_NOW";
@@ -319,6 +358,129 @@ export interface ActionReview {
      */
     payloadFieldNameSeparator?: string;
 }
+/**
+ * <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
+ *             action during a 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.
+ *         </p>
+ * @public
+ */
+export interface ActionReviewEvent {
+    /**
+     * <p>The identifier of the conversation with which the action review event is
+     *             associated.</p>
+     * @public
+     */
+    conversationId?: string;
+    /**
+     * <p>The identifier of the conversation with which the plugin action is associated.</p>
+     * @public
+     */
+    userMessageId?: string;
+    /**
+     * <p>The identifier of an Amazon Q Business AI generated associated with the action review
+     *             event.</p>
+     * @public
+     */
+    systemMessageId?: string;
+    /**
+     * <p>The identifier of the plugin associated with the action review event.</p>
+     * @public
+     */
+    pluginId?: string;
+    /**
+     * <p>The type of plugin.</p>
+     * @public
+     */
+    pluginType?: PluginType;
+    /**
+     * <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
+     *             perform the requested plugin action.</p>
+     * @public
+     */
+    payload?: Record<string, ActionReviewPayloadField>;
+    /**
+     * <p>A string used to retain information about the hierarchical contexts within an action
+     *             review event payload.</p>
+     * @public
+     */
+    payloadFieldNameSeparator?: string;
+}
+/**
+ * <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
+ *             bucket.</p>
+ * @public
+ */
+export interface S3 {
+    /**
+     * <p>The name of the S3 bucket that contains the file.</p>
+     * @public
+     */
+    bucket: string | undefined;
+    /**
+     * <p>The name of the file.</p>
+     * @public
+     */
+    key: string | undefined;
+}
+/**
+ * <p>Contains details about the OpenAPI schema for a custom plugin. For more information,
+ *             see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema">custom plugin OpenAPI schemas</a>. You can either include
+ *             the schema directly in the payload field or you can upload it to an S3 bucket and
+ *             specify the S3 bucket location in the <code>s3</code> field. </p>
+ * @public
+ */
+export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace APISchema {
+    /**
+     * <p>The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
+     *         </p>
+     * @public
+     */
+    interface PayloadMember {
+        payload: string;
+        s3?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Contains details about the S3 object containing the OpenAPI schema for a custom
+     *             plugin. The schema could be in either JSON or YAML format.</p>
+     * @public
+     */
+    interface S3Member {
+        payload?: never;
+        s3: S3;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        payload?: never;
+        s3?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        payload: (value: string) => T;
+        s3: (value: S3) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: APISchema, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const APISchemaType: {
+    readonly OPEN_API_V3: "OPEN_API_V3";
+};
+/**
+ * @public
+ */
+export type APISchemaType = (typeof APISchemaType)[keyof typeof APISchemaType];
 /**
  * @public
  * @enum
@@ -460,7 +622,7 @@ export interface CreateApplicationRequest {
      *                 CloudWatch logs and metrics.</p>
      * @public
      */
-    roleArn: string | undefined;
+    roleArn?: string;
     /**
      * <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
      *             creating for—or connecting to—your Amazon Q Business application.</p>
@@ -787,6 +949,18 @@ export interface IndexCapacityConfiguration {
      */
     units?: number;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const IndexType: {
+    readonly ENTERPRISE: "ENTERPRISE";
+    readonly STARTER: "STARTER";
+};
+/**
+ * @public
+ */
+export type IndexType = (typeof IndexType)[keyof typeof IndexType];
 /**
  * @public
  */
@@ -801,6 +975,13 @@ export interface CreateIndexRequest {
      * @public
      */
     displayName: string | undefined;
+    /**
+     * <p>The index type that's suitable for your needs. For more information on what's included
+     *             in each type of index or index tier, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers">Amazon Q Business
+     *             tiers</a>.</p>
+     * @public
+     */
+    type?: IndexType;
     /**
      * <p>A description for the Amazon Q Business index.</p>
      * @public
@@ -969,8 +1150,8 @@ export interface DocumentAttributeCondition {
      * <p>The identifier of the document attribute used for the condition.</p>
      *          <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field
      *             that contains source URIs associated with the documents.</p>
-     *          <p>Amazon Kendra currently does not support <code>_document_body</code> as an
-     *             attribute key used for the condition.</p>
+     *          <p>Amazon Q Business currently does not support <code>_document_body</code> as an attribute
+     *             key used for the condition.</p>
      * @public
      */
     operator: DocumentEnrichmentConditionOperator | undefined;
@@ -1104,10 +1285,12 @@ export interface InlineDocumentEnrichmentConfiguration {
  * <p>Provides the configuration information for invoking a Lambda function in
  *                 Lambda to alter document metadata and content when ingesting
  *             documents into Amazon Q Business.</p>
- *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
- *             the original or raw documents.</p>
+ *          <p>You can configure your Lambda function using the
+ *                 <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
+ *             alterations on the original or raw documents.</p>
  *          <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
- *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+ *             you must configure your Lambda function using
+ *                 <code>PostExtractionHookConfiguration</code>.</p>
  *          <p>You can only invoke one Lambda function. However, this function can invoke
  *             other functions it requires.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
@@ -1161,10 +1344,12 @@ export interface DocumentEnrichmentConfiguration {
      * <p>Provides the configuration information for invoking a Lambda function in
      *                 Lambda to alter document metadata and content when ingesting
      *             documents into Amazon Q Business.</p>
-     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
-     *             the original or raw documents.</p>
+     *          <p>You can configure your Lambda function using the
+     *                 <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
+     *             alterations on the original or raw documents.</p>
      *          <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
-     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+     *             you must configure your Lambda function using
+     *                 <code>PostExtractionHookConfiguration</code>.</p>
      *          <p>You can only invoke one Lambda function. However, this function can invoke
      *             other functions it requires.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
@@ -1175,10 +1360,12 @@ export interface DocumentEnrichmentConfiguration {
      * <p>Provides the configuration information for invoking a Lambda function in
      *                 Lambda to alter document metadata and content when ingesting
      *             documents into Amazon Q Business.</p>
-     *          <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
-     *             the original or raw documents.</p>
+     *          <p>You can configure your Lambda function using the
+     *                 <code>PreExtractionHookConfiguration</code> parameter if you want to apply advanced
+     *             alterations on the original or raw documents.</p>
      *          <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
-     *             you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
+     *             you must configure your Lambda function using
+     *                 <code>PostExtractionHookConfiguration</code>.</p>
      *          <p>You can only invoke one Lambda function. However, this function can invoke
      *             other functions it requires.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html">Custom document enrichment</a>. </p>
@@ -1754,6 +1941,11 @@ export interface GetIndexResponse {
      * @public
      */
     displayName?: string;
+    /**
+     * <p>The type of index attached to your Amazon Q Business application.</p>
+     * @public
+     */
+    type?: IndexType;
     /**
      * <p> The Amazon Resource Name (ARN) of the Amazon Q Business index. </p>
      * @public
@@ -1971,6 +2163,13 @@ export interface BasicAuthConfiguration {
      */
     roleArn: string | undefined;
 }
+/**
+ * <p>Information about invoking a custom plugin without any authentication or authorization
+ *             requirement.</p>
+ * @public
+ */
+export interface NoAuthConfiguration {
+}
 /**
  * <p>Information about the OAuth 2.0 authentication credential/token used to configure a
  *             plugin.</p>
@@ -1994,7 +2193,7 @@ export interface OAuth2ClientCredentialConfiguration {
  * <p>Authentication configuration information for an Amazon Q Business plugin.</p>
  * @public
  */
-export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigurationMember | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember | PluginAuthConfiguration.$UnknownMember;
+export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigurationMember | PluginAuthConfiguration.NoAuthConfigurationMember | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember | PluginAuthConfiguration.$UnknownMember;
 /**
  * @public
  */
@@ -2007,6 +2206,7 @@ export declare namespace PluginAuthConfiguration {
     interface BasicAuthConfigurationMember {
         basicAuthConfiguration: BasicAuthConfiguration;
         oAuth2ClientCredentialConfiguration?: never;
+        noAuthConfiguration?: never;
         $unknown?: never;
     }
     /**
@@ -2017,6 +2217,17 @@ export declare namespace PluginAuthConfiguration {
     interface OAuth2ClientCredentialConfigurationMember {
         basicAuthConfiguration?: never;
         oAuth2ClientCredentialConfiguration: OAuth2ClientCredentialConfiguration;
+        noAuthConfiguration?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about invoking a custom plugin without any authentication.</p>
+     * @public
+     */
+    interface NoAuthConfigurationMember {
+        basicAuthConfiguration?: never;
+        oAuth2ClientCredentialConfiguration?: never;
+        noAuthConfiguration: NoAuthConfiguration;
         $unknown?: never;
     }
     /**
@@ -2025,15 +2236,39 @@ export declare namespace PluginAuthConfiguration {
     interface $UnknownMember {
         basicAuthConfiguration?: never;
         oAuth2ClientCredentialConfiguration?: never;
+        noAuthConfiguration?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
         basicAuthConfiguration: (value: BasicAuthConfiguration) => T;
         oAuth2ClientCredentialConfiguration: (value: OAuth2ClientCredentialConfiguration) => T;
+        noAuthConfiguration: (value: NoAuthConfiguration) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: PluginAuthConfiguration, visitor: Visitor<T>) => T;
 }
+/**
+ * <p> Configuration information required to create a custom plugin.</p>
+ * @public
+ */
+export interface CustomPluginConfiguration {
+    /**
+     * <p>A description for your custom plugin configuration.</p>
+     * @public
+     */
+    description: string | undefined;
+    /**
+     * <p>The type of OpenAPI schema to use.</p>
+     * @public
+     */
+    apiSchemaType: APISchemaType | undefined;
+    /**
+     * <p>Contains either details about the S3 object containing the OpenAPI schema for the
+     *             action group or the JSON or YAML-formatted payload defining the schema.</p>
+     * @public
+     */
+    apiSchema: APISchema | undefined;
+}
 /**
  * @public
  */
@@ -2053,16 +2288,21 @@ export interface CreatePluginRequest {
      * @public
      */
     type: PluginType | undefined;
+    /**
+     * <p>Authentication configuration information for an Amazon Q Business plugin.</p>
+     * @public
+     */
+    authConfiguration: PluginAuthConfiguration | undefined;
     /**
      * <p>The source URL used for plugin configuration.</p>
      * @public
      */
-    serverUrl: string | undefined;
+    serverUrl?: string;
     /**
-     * <p>Authentication configuration information for an Amazon Q Business plugin.</p>
+     * <p>Contains configuration for a custom plugin.</p>
      * @public
      */
-    authConfiguration: PluginAuthConfiguration | undefined;
+    customPluginConfiguration?: CustomPluginConfiguration;
     /**
      * <p>A list of key-value pairs that identify or categorize the data source connector. You
      *             can also use tags to help control access to the data source connector. Tag keys and
@@ -2078,6 +2318,23 @@ export interface CreatePluginRequest {
      */
     clientToken?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const PluginBuildStatus: {
+    readonly CREATE_FAILED: "CREATE_FAILED";
+    readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
+    readonly DELETE_FAILED: "DELETE_FAILED";
+    readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
+    readonly READY: "READY";
+    readonly UPDATE_FAILED: "UPDATE_FAILED";
+    readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
+};
+/**
+ * @public
+ */
+export type PluginBuildStatus = (typeof PluginBuildStatus)[keyof typeof PluginBuildStatus];
 /**
  * @public
  */
@@ -2092,6 +2349,11 @@ export interface CreatePluginResponse {
      * @public
      */
     pluginArn?: string;
+    /**
+     * <p>The current status of a plugin. A plugin is modified asynchronously.</p>
+     * @public
+     */
+    buildStatus?: PluginBuildStatus;
 }
 /**
  * @public
@@ -2174,6 +2436,16 @@ export interface GetPluginResponse {
      * @public
      */
     authConfiguration?: PluginAuthConfiguration;
+    /**
+     * <p>Configuration information required to create a custom plugin.</p>
+     * @public
+     */
+    customPluginConfiguration?: CustomPluginConfiguration;
+    /**
+     * <p>The current status of a plugin. A plugin is modified asynchronously.</p>
+     * @public
+     */
+    buildStatus?: PluginBuildStatus;
     /**
      * <p>The Amazon Resource Name (ARN) of the role with permission to access resources needed
      *             to create the plugin.</p>
@@ -2248,6 +2520,11 @@ export interface Plugin {
      * @public
      */
     state?: PluginState;
+    /**
+     * <p>The status of the plugin.</p>
+     * @public
+     */
+    buildStatus?: PluginBuildStatus;
     /**
      * <p>The timestamp for when the plugin was created.</p>
      * @public
@@ -2305,6 +2582,11 @@ export interface UpdatePluginRequest {
      * @public
      */
     serverUrl?: string;
+    /**
+     * <p>The configuration for a custom plugin.</p>
+     * @public
+     */
+    customPluginConfiguration?: CustomPluginConfiguration;
     /**
      * <p>The authentication configuration the plugin is using.</p>
      * @public
@@ -2892,6 +3174,12 @@ export interface UpdateApplicationRequest {
      * @public
      */
     applicationId: string | undefined;
+    /**
+     * <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
+     *             creating for—or connecting to—your Amazon Q Business application.</p>
+     * @public
+     */
+    identityCenterInstanceArn?: string;
     /**
      * <p>A name for the Amazon Q Business application.</p>
      * @public
@@ -3144,12 +3432,12 @@ export interface GetWebExperienceResponse {
      */
     status?: WebExperienceStatus;
     /**
-     * <p>The Unix timestamp when the retriever was created.</p>
+     * <p>The Unix timestamp when the Amazon Q Business web experience was last created.</p>
      * @public
      */
     createdAt?: Date;
     /**
-     * <p>The Unix timestamp when the data source connector was last updated.</p>
+     * <p>The Unix timestamp when the Amazon Q Business web experience was last updated.</p>
      * @public
      */
     updatedAt?: Date;
@@ -3182,6 +3470,8 @@ export interface GetWebExperienceResponse {
      */
     roleArn?: string;
     /**
+     * @deprecated
+     *
      * <p>The authentication configuration information for your Amazon Q Business web
      *             experience.</p>
      * @public
@@ -3281,6 +3571,14 @@ export interface UpdateWebExperienceRequest {
      */
     webExperienceId: string | undefined;
     /**
+     * <p>The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business
+     *             web experience and required resources.</p>
+     * @public
+     */
+    roleArn?: string;
+    /**
+     * @deprecated
+     *
      * <p>The authentication configuration of the Amazon Q Business web experience.</p>
      * @public
      */
@@ -3356,6 +3654,18 @@ export interface AttachmentInput {
      */
     data: Uint8Array | undefined;
 }
+/**
+ * <p>A file input event activated by a end user request to upload files into their web
+ *             experience chat.</p>
+ * @public
+ */
+export interface AttachmentInputEvent {
+    /**
+     * <p>A file directly uploaded into a web experience chat.</p>
+     * @public
+     */
+    attachment?: AttachmentInput;
+}
 /**
  * @public
  * @enum
@@ -3405,6 +3715,57 @@ export interface DocumentAttribute {
      */
     value: DocumentAttributeValue | undefined;
 }
+/**
+ * <p>A request made by Amazon Q Business to a third paty authentication server to authenticate
+ *             a custom plugin user.</p>
+ * @public
+ */
+export interface AuthChallengeRequest {
+    /**
+     * <p>The URL sent by Amazon Q Business to the third party authentication server to authenticate
+     *             a custom plugin user through an OAuth protocol.</p>
+     * @public
+     */
+    authorizationUrl: string | undefined;
+}
+/**
+ * <p>An authentication verification event activated by an end user request to use a custom
+ *             plugin.</p>
+ * @public
+ */
+export interface AuthChallengeRequestEvent {
+    /**
+     * <p>The URL sent by Amazon Q Business to a third party authentication server in response to an
+     *             authentication verification event activated by an end user request to use a custom
+     *             plugin. </p>
+     * @public
+     */
+    authorizationUrl: string | undefined;
+}
+/**
+ * <p>Contains details of the authentication information received from a third party
+ *             authentication server in response to an authentication challenge.</p>
+ * @public
+ */
+export interface AuthChallengeResponse {
+    /**
+     * <p>The mapping of key-value pairs in an authentication challenge response.</p>
+     * @public
+     */
+    responseMap: Record<string, string> | undefined;
+}
+/**
+ * <p>An authentication verification event response by a third party authentication server
+ *             to Amazon Q Business.</p>
+ * @public
+ */
+export interface AuthChallengeResponseEvent {
+    /**
+     * <p>The mapping of key-value pairs in an authentication challenge response.</p>
+     * @public
+     */
+    responseMap: Record<string, string> | undefined;
+}
 /**
  * <p>A document deleted from an Amazon Q Business data source connector.</p>
  * @public
@@ -3479,23 +3840,6 @@ export interface BatchDeleteDocumentResponse {
      */
     failedDocuments?: FailedDocument[];
 }
-/**
- * <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
- *             bucket.</p>
- * @public
- */
-export interface S3 {
-    /**
-     * <p>The name of the S3 bucket that contains the file.</p>
-     * @public
-     */
-    bucket: string | undefined;
-    /**
-     * <p>The name of the file.</p>
-     * @public
-     */
-    key: string | undefined;
-}
 /**
  * <p>The contents of a document.</p>
  * @public
@@ -3751,6 +4095,62 @@ export declare namespace ChatModeConfiguration {
     }
     const visit: <T>(value: ChatModeConfiguration, visitor: Visitor<T>) => T;
 }
+/**
+ * <p>The end of the streaming input for the <code>Chat</code> API.</p>
+ * @public
+ */
+export interface EndOfInputEvent {
+}
+/**
+ * <p>An input event for a end user message in an Amazon Q Business web experience. </p>
+ * @public
+ */
+export interface TextInputEvent {
+    /**
+     * <p>A user message in a text message input event.</p>
+     * @public
+     */
+    userMessage: string | undefined;
+}
+/**
+ * <p>A failed file upload during web experience chat.</p>
+ * @public
+ */
+export interface FailedAttachmentEvent {
+    /**
+     * <p> The identifier of the conversation associated with the failed file upload.</p>
+     * @public
+     */
+    conversationId?: string;
+    /**
+     * <p>The identifier of the end user chat message associated with the file upload.</p>
+     * @public
+     */
+    userMessageId?: string;
+    /**
+     * <p>The identifier of the AI-generated message associated with the file upload.</p>
+     * @public
+     */
+    systemMessageId?: string;
+    /**
+     * <p>The details of a file uploaded during chat.</p>
+     * @public
+     */
+    attachment?: AttachmentOutput;
+}
+/**
+ * <p>Contains the relevant text excerpt from a source that was used to generate a citation
+ *             text segment in an Amazon Q Business chat response.</p>
+ * @public
+ */
+export interface SnippetExcerpt {
+    /**
+     * <p>The relevant text excerpt from a source that was used to generate a citation text
+     *             segment in an Amazon Q chat response.</p>
+     * @public
+     */
+    text?: string;
+}
 /**
  * <p>Provides information about a text extract in a chat response that can be attributed to
  *             a source document.</p>
@@ -3769,6 +4169,12 @@ export interface TextSegment {
      * @public
      */
     endOffset?: number;
+    /**
+     * <p>The relevant text excerpt from a source that was used to generate a citation text
+     *             segment in an Amazon Q Business chat response.</p>
+     * @public
+     */
+    snippetExcerpt?: SnippetExcerpt;
 }
 /**
  * <p>The documents used to generate an Amazon Q Business web experience response.</p>
@@ -3810,19 +4216,23 @@ export interface SourceAttribution {
     textMessageSegments?: TextSegment[];
 }
 /**
+ * <p>A metadata event for a AI-generated text output message in a Amazon Q Business
+ *             conversation, containing associated metadata generated.</p>
  * @public
  */
-export interface ChatSyncOutput {
+export interface MetadataEvent {
     /**
-     * <p>The identifier of the Amazon Q Business conversation.</p>
+     * <p>The identifier of the conversation with which the generated metadata is
+     *             associated.</p>
      * @public
      */
     conversationId?: string;
     /**
-     * <p>An AI-generated message in a conversation.</p>
+     * <p>The identifier of an Amazon Q Business end user text input message within the
+     *             conversation.</p>
      * @public
      */
-    systemMessage?: string;
+    userMessageId?: string;
     /**
      * <p>The identifier of an Amazon Q Business AI generated message within the
      *             conversation.</p>
@@ -3830,27 +4240,147 @@ export interface ChatSyncOutput {
      */
     systemMessageId?: string;
     /**
-     * <p>The identifier of an Amazon Q Business end user text input message within the
-     *             conversation.</p>
+     * <p>The source documents used to generate the conversation response.</p>
+     * @public
+     */
+    sourceAttributions?: SourceAttribution[];
+    /**
+     * <p>The final text output message generated by the system.</p>
+     * @public
+     */
+    finalTextMessage?: string;
+}
+/**
+ * <p>An output event for an AI-generated response in an Amazon Q Business web
+ *             experience.</p>
+ * @public
+ */
+export interface TextOutputEvent {
+    /**
+     * <p>The identifier of the conversation with which the text output event is
+     *             associated.</p>
+     * @public
+     */
+    conversationId?: string;
+    /**
+     * <p>The identifier of an end user message in a <code>TextOutputEvent</code>.</p>
      * @public
      */
     userMessageId?: string;
+    /**
+     * <p>The identifier of an AI-generated message in a <code>TextOutputEvent</code>.</p>
+     * @public
+     */
+    systemMessageId?: string;
+    /**
+     * <p>An AI-generated message in a <code>TextOutputEvent</code>.</p>
+     * @public
+     */
+    systemMessage?: string;
+}
+/**
+ * <p>The streaming output for the <code>Chat</code> API.</p>
+ * @public
+ */
+export type ChatOutputStream = ChatOutputStream.ActionReviewEventMember | ChatOutputStream.AuthChallengeRequestEventMember | ChatOutputStream.FailedAttachmentEventMember | ChatOutputStream.MetadataEventMember | ChatOutputStream.TextEventMember | ChatOutputStream.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ChatOutputStream {
+    /**
+     * <p>Information about the payload of the <code>ChatOutputStream</code> event containing
+     *             the AI-generated message output.</p>
+     * @public
+     */
+    interface TextEventMember {
+        textEvent: TextOutputEvent;
+        metadataEvent?: never;
+        actionReviewEvent?: never;
+        failedAttachmentEvent?: never;
+        authChallengeRequestEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A metadata event for a AI-generated text output message in a Amazon Q Business
+     *             conversation. </p>
+     * @public
+     */
+    interface MetadataEventMember {
+        textEvent?: never;
+        metadataEvent: MetadataEvent;
+        actionReviewEvent?: never;
+        failedAttachmentEvent?: never;
+        authChallengeRequestEvent?: never;
+        $unknown?: never;
+    }
     /**
      * <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
      *             successfully complete a requested plugin action.</p>
      * @public
      */
-    actionReview?: ActionReview;
+    interface ActionReviewEventMember {
+        textEvent?: never;
+        metadataEvent?: never;
+        actionReviewEvent: ActionReviewEvent;
+        failedAttachmentEvent?: never;
+        authChallengeRequestEvent?: never;
+        $unknown?: never;
+    }
     /**
-     * <p>The source documents used to generate the conversation response.</p>
+     * <p>A failed file upload event during a web experience chat.</p>
      * @public
      */
-    sourceAttributions?: SourceAttribution[];
+    interface FailedAttachmentEventMember {
+        textEvent?: never;
+        metadataEvent?: never;
+        actionReviewEvent?: never;
+        failedAttachmentEvent: FailedAttachmentEvent;
+        authChallengeRequestEvent?: never;
+        $unknown?: never;
+    }
     /**
-     * <p>A list of files which failed to upload during chat.</p>
+     * <p>An authentication verification event activated by an end user request to use a custom
+     *             plugin.</p>
      * @public
      */
-    failedAttachments?: AttachmentOutput[];
+    interface AuthChallengeRequestEventMember {
+        textEvent?: never;
+        metadataEvent?: never;
+        actionReviewEvent?: never;
+        failedAttachmentEvent?: never;
+        authChallengeRequestEvent: AuthChallengeRequestEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        textEvent?: never;
+        metadataEvent?: never;
+        actionReviewEvent?: never;
+        failedAttachmentEvent?: never;
+        authChallengeRequestEvent?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        textEvent: (value: TextOutputEvent) => T;
+        metadataEvent: (value: MetadataEvent) => T;
+        actionReviewEvent: (value: ActionReviewEvent) => T;
+        failedAttachmentEvent: (value: FailedAttachmentEvent) => T;
+        authChallengeRequestEvent: (value: AuthChallengeRequestEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ChatOutputStream, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ChatOutput {
+    /**
+     * <p>The streaming output for the <code>Chat</code> API.</p>
+     * @public
+     */
+    outputStream?: AsyncIterable<ChatOutputStream>;
 }
 /**
  * <p>You don't have permissions to perform the action because your license is inactive. Ask
@@ -3865,6 +4395,55 @@ export declare class LicenseNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<LicenseNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
+export interface ChatSyncOutput {
+    /**
+     * <p>The identifier of the Amazon Q Business conversation.</p>
+     * @public
+     */
+    conversationId?: string;
+    /**
+     * <p>An AI-generated message in a conversation.</p>
+     * @public
+     */
+    systemMessage?: string;
+    /**
+     * <p>The identifier of an Amazon Q Business AI generated message within the
+     *             conversation.</p>
+     * @public
+     */
+    systemMessageId?: string;
+    /**
+     * <p>The identifier of an Amazon Q Business end user text input message within the
+     *             conversation.</p>
+     * @public
+     */
+    userMessageId?: string;
+    /**
+     * <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
+     *             successfully complete a requested plugin action.</p>
+     * @public
+     */
+    actionReview?: ActionReview;
+    /**
+     * <p>An authentication verification event activated by an end user request to use a custom
+     *             plugin.</p>
+     * @public
+     */
+    authChallengeRequest?: AuthChallengeRequest;
+    /**
+     * <p>The source documents used to generate the conversation response.</p>
+     * @public
+     */
+    sourceAttributions?: SourceAttribution[];
+    /**
+     * <p>A list of files which failed to upload during chat.</p>
+     * @public
+     */
+    failedAttachments?: AttachmentOutput[];
+}
 /**
  * <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked
  *             topic. You can configure a custom message to inform your end users that they have asked
@@ -5400,6 +5979,12 @@ export interface ChatSyncInput {
      * @public
      */
     actionExecution?: ActionExecution;
+    /**
+     * <p>An authentication verification event response by a third party authentication server
+     *             to Amazon Q Business.</p>
+     * @public
+     */
+    authChallengeResponse?: AuthChallengeResponse;
     /**
      * <p>The identifier of the Amazon Q Business conversation.</p>
      * @public
@@ -5417,7 +6002,7 @@ export interface ChatSyncInput {
      */
     attributeFilter?: AttributeFilter;
     /**
-     * <p>The chat modes available in an Amazon Q Business web experience.</p>
+     * <p>The chat modes available to an Amazon Q Business end user.</p>
      *          <ul>
      *             <li>
      *                <p>
@@ -5454,6 +6039,209 @@ export interface ChatSyncInput {
      */
     clientToken?: string;
 }
+/**
+ * <p>A configuration event activated by an end user request to select a specific chat
+ *             mode.</p>
+ * @public
+ */
+export interface ConfigurationEvent {
+    /**
+     * <p>The chat modes available to an Amazon Q Business end user.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>RETRIEVAL_MODE</code> - The default chat mode for an
+     *                     Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
+     *                     responses only from data sources connected to an Amazon Q Business
+     *                     application.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CREATOR_MODE</code> - By selecting this mode, users can choose to
+     *                     generate responses only from the LLM knowledge, without consulting connected
+     *                     data sources, for a chat request.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
+     *                     use plugins in chat.</p>
+     *             </li>
+     *          </ul>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
+     *             and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
+     * @public
+     */
+    chatMode?: ChatMode;
+    /**
+     * <p>Configuration information for Amazon Q Business conversation modes.</p>
+     *          <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
+     * @public
+     */
+    chatModeConfiguration?: ChatModeConfiguration;
+    /**
+     * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
+     * @public
+     */
+    attributeFilter?: AttributeFilter;
+}
+/**
+ * <p>The streaming input for the <code>Chat</code> API.</p>
+ * @public
+ */
+export type ChatInputStream = ChatInputStream.ActionExecutionEventMember | ChatInputStream.AttachmentEventMember | ChatInputStream.AuthChallengeResponseEventMember | ChatInputStream.ConfigurationEventMember | ChatInputStream.EndOfInputEventMember | ChatInputStream.TextEventMember | ChatInputStream.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ChatInputStream {
+    /**
+     * <p>A configuration event activated by an end user request to select a specific chat
+     *             mode.</p>
+     * @public
+     */
+    interface ConfigurationEventMember {
+        configurationEvent: ConfigurationEvent;
+        textEvent?: never;
+        attachmentEvent?: never;
+        actionExecutionEvent?: never;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about the payload of the <code>ChatInputStream</code> event containing the
+     *             end user message input.</p>
+     * @public
+     */
+    interface TextEventMember {
+        configurationEvent?: never;
+        textEvent: TextInputEvent;
+        attachmentEvent?: never;
+        actionExecutionEvent?: never;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A request by an end user to upload a file during chat.</p>
+     * @public
+     */
+    interface AttachmentEventMember {
+        configurationEvent?: never;
+        textEvent?: never;
+        attachmentEvent: AttachmentInputEvent;
+        actionExecutionEvent?: never;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
+     * @public
+     */
+    interface ActionExecutionEventMember {
+        configurationEvent?: never;
+        textEvent?: never;
+        attachmentEvent?: never;
+        actionExecutionEvent: ActionExecutionEvent;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The end of the streaming input for the <code>Chat</code> API.</p>
+     * @public
+     */
+    interface EndOfInputEventMember {
+        configurationEvent?: never;
+        textEvent?: never;
+        attachmentEvent?: never;
+        actionExecutionEvent?: never;
+        endOfInputEvent: EndOfInputEvent;
+        authChallengeResponseEvent?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>An authentication verification event response by a third party authentication server
+     *             to Amazon Q Business.</p>
+     * @public
+     */
+    interface AuthChallengeResponseEventMember {
+        configurationEvent?: never;
+        textEvent?: never;
+        attachmentEvent?: never;
+        actionExecutionEvent?: never;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent: AuthChallengeResponseEvent;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        configurationEvent?: never;
+        textEvent?: never;
+        attachmentEvent?: never;
+        actionExecutionEvent?: never;
+        endOfInputEvent?: never;
+        authChallengeResponseEvent?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        configurationEvent: (value: ConfigurationEvent) => T;
+        textEvent: (value: TextInputEvent) => T;
+        attachmentEvent: (value: AttachmentInputEvent) => T;
+        actionExecutionEvent: (value: ActionExecutionEvent) => T;
+        endOfInputEvent: (value: EndOfInputEvent) => T;
+        authChallengeResponseEvent: (value: AuthChallengeResponseEvent) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ChatInputStream, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ChatInput {
+    /**
+     * <p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business
+     *             conversation.</p>
+     * @public
+     */
+    applicationId: string | undefined;
+    /**
+     * <p>The identifier of the user attached to the chat input. </p>
+     * @public
+     */
+    userId?: string;
+    /**
+     * <p>The groups that a user associated with the chat input belongs to.</p>
+     * @public
+     */
+    userGroups?: string[];
+    /**
+     * <p>The identifier of the Amazon Q Business conversation.</p>
+     * @public
+     */
+    conversationId?: string;
+    /**
+     * <p>The identifier used to associate a user message with a AI generated response.</p>
+     * @public
+     */
+    parentMessageId?: string;
+    /**
+     * <p>A token that you provide to identify the chat input.</p>
+     * @public
+     */
+    clientToken?: string;
+    /**
+     * <p>The streaming input for the <code>Chat</code> API.</p>
+     * @public
+     */
+    inputStream?: AsyncIterable<ChatInputStream>;
+}
+/**
+ * @internal
+ */
+export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any;
 /**
  * @internal
  */
@@ -5466,3 +6254,35 @@ export declare const CreateApplicationRequestFilterSensitiveLog: (obj: CreateApp
  * @internal
  */
 export declare const GetApplicationResponseFilterSensitiveLog: (obj: GetApplicationResponse) => any;
+/**
+ * @internal
+ */
+export declare const CustomPluginConfigurationFilterSensitiveLog: (obj: CustomPluginConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const CreatePluginRequestFilterSensitiveLog: (obj: CreatePluginRequest) => any;
+/**
+ * @internal
+ */
+export declare const GetPluginResponseFilterSensitiveLog: (obj: GetPluginResponse) => any;
+/**
+ * @internal
+ */
+export declare const UpdatePluginRequestFilterSensitiveLog: (obj: UpdatePluginRequest) => any;
+/**
+ * @internal
+ */
+export declare const ChatOutputStreamFilterSensitiveLog: (obj: ChatOutputStream) => any;
+/**
+ * @internal
+ */
+export declare const ChatOutputFilterSensitiveLog: (obj: ChatOutput) => any;
+/**
+ * @internal
+ */
+export declare const ChatInputStreamFilterSensitiveLog: (obj: ChatInputStream) => any;
+/**
+ * @internal
+ */
+export declare const ChatInputFilterSensitiveLog: (obj: ChatInput) => any;