@aws-sdk/client-qconnect 3.933.0 → 3.935.0

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

@@ -1,422 +1,4 @@
-import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { ChannelSubtype, Configuration, ContentDataDetails, ContentDisposition, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttributes, MessageTemplateAttributeType, MessageTemplateContentProvider, QueryResultType, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
-import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
-/**
- * <p>The data of a message template.</p>
- * @public
- */
-export interface MessageTemplateData {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the message template.</p>
-     * @public
-     */
-    messageTemplateArn: string | undefined;
-    /**
-     * <p>The identifier of the message template.</p>
-     * @public
-     */
-    messageTemplateId: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
-     * @public
-     */
-    knowledgeBaseArn: string | undefined;
-    /**
-     * <p>The identifier of the knowledge base.</p>
-     * @public
-     */
-    knowledgeBaseId: string | undefined;
-    /**
-     * <p>The name of the message template.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>The channel subtype this message template applies to.</p>
-     * @public
-     */
-    channelSubtype: ChannelSubtype | undefined;
-    /**
-     * <p>The timestamp when the message template was created.</p>
-     * @public
-     */
-    createdTime: Date | undefined;
-    /**
-     * <p>The timestamp when the message template data was last modified.</p>
-     * @public
-     */
-    lastModifiedTime: Date | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
-     * @public
-     */
-    lastModifiedBy: string | undefined;
-    /**
-     * <p>The content of the message template.</p>
-     * @public
-     */
-    content: MessageTemplateContentProvider | undefined;
-    /**
-     * <p>The description of the message template.</p>
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
-     * @public
-     */
-    language?: string | undefined;
-    /**
-     * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
-     * @public
-     */
-    groupingConfiguration?: GroupingConfiguration | undefined;
-    /**
-     * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
-     * @public
-     */
-    defaultAttributes?: MessageTemplateAttributes | undefined;
-    /**
-     * <p>The types of attributes that the message template contains.</p>
-     * @public
-     */
-    attributeTypes?: MessageTemplateAttributeType[] | undefined;
-    /**
-     * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
-     * @public
-     */
-    messageTemplateContentSha256: string | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
-     * @public
-     */
-    tags?: Record<string, string> | undefined;
-}
-/**
- * @public
- */
-export interface CreateMessageTemplateResponse {
-    /**
-     * <p>The message template.</p>
-     * @public
-     */
-    messageTemplate?: MessageTemplateData | undefined;
-}
-/**
- * @public
- */
-export interface CreateMessageTemplateAttachmentRequest {
-    /**
-     * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
-     * @public
-     */
-    knowledgeBaseId: string | undefined;
-    /**
-     * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
-     * @public
-     */
-    messageTemplateId: string | undefined;
-    /**
-     * <p>The presentation information for the attachment file.</p>
-     * @public
-     */
-    contentDisposition: ContentDisposition | undefined;
-    /**
-     * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
-     * @public
-     */
-    body: string | undefined;
-    /**
-     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
-     * @public
-     */
-    clientToken?: string | undefined;
-}
-/**
- * <p>Information about the message template attachment.</p>
- * @public
- */
-export interface MessageTemplateAttachment {
-    /**
-     * <p>The presentation information for the attachment file.</p>
-     * @public
-     */
-    contentDisposition: ContentDisposition | undefined;
-    /**
-     * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>The timestamp when the attachment file was uploaded.</p>
-     * @public
-     */
-    uploadedTime: Date | undefined;
-    /**
-     * <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
-     * @public
-     */
-    url: string | undefined;
-    /**
-     * <p>The expiration time of the pre-signed Amazon S3 URL.</p>
-     * @public
-     */
-    urlExpiry: Date | undefined;
-    /**
-     * <p>The identifier of the attachment file.</p>
-     * @public
-     */
-    attachmentId: string | undefined;
-}
-/**
- * @public
- */
-export interface CreateMessageTemplateAttachmentResponse {
-    /**
-     * <p>The message template attachment.</p>
-     * @public
-     */
-    attachment?: MessageTemplateAttachment | undefined;
-}
-/**
- * @public
- */
-export interface CreateMessageTemplateVersionRequest {
-    /**
-     * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
-     * @public
-     */
-    knowledgeBaseId: string | undefined;
-    /**
-     * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
-     * @public
-     */
-    messageTemplateId: string | undefined;
-    /**
-     * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the <code>$LATEST</code> qualifier by default.</p>
-     * @public
-     */
-    messageTemplateContentSha256?: string | undefined;
-}
-/**
- * <p>The extended data of a message template.</p>
- * @public
- */
-export interface ExtendedMessageTemplateData {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the message template.</p>
-     * @public
-     */
-    messageTemplateArn: string | undefined;
-    /**
-     * <p>The identifier of the message template.</p>
-     * @public
-     */
-    messageTemplateId: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
-     * @public
-     */
-    knowledgeBaseArn: string | undefined;
-    /**
-     * <p>The identifier of the knowledge base.</p>
-     * @public
-     */
-    knowledgeBaseId: string | undefined;
-    /**
-     * <p>The name of the message template.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>The channel subtype this message template applies to.</p>
-     * @public
-     */
-    channelSubtype: ChannelSubtype | undefined;
-    /**
-     * <p>The timestamp when the message template was created.</p>
-     * @public
-     */
-    createdTime: Date | undefined;
-    /**
-     * <p>The timestamp when the message template data was last modified.</p>
-     * @public
-     */
-    lastModifiedTime: Date | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
-     * @public
-     */
-    lastModifiedBy: string | undefined;
-    /**
-     * <p>The content of the message template.</p>
-     * @public
-     */
-    content: MessageTemplateContentProvider | undefined;
-    /**
-     * <p>The description of the message template.</p>
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
-     * @public
-     */
-    language?: string | undefined;
-    /**
-     * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
-     * @public
-     */
-    groupingConfiguration?: GroupingConfiguration | undefined;
-    /**
-     * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
-     * @public
-     */
-    defaultAttributes?: MessageTemplateAttributes | undefined;
-    /**
-     * <p>The types of attributes contain the message template.</p>
-     * @public
-     */
-    attributeTypes?: MessageTemplateAttributeType[] | undefined;
-    /**
-     * <p>The message template attachments.</p>
-     * @public
-     */
-    attachments?: MessageTemplateAttachment[] | undefined;
-    /**
-     * <p>Whether the version of the message template is activated.</p>
-     * @public
-     */
-    isActive?: boolean | undefined;
-    /**
-     * <p>The version number of the message template version.</p>
-     * @public
-     */
-    versionNumber?: number | undefined;
-    /**
-     * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
-     * @public
-     */
-    messageTemplateContentSha256: string | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
-     * @public
-     */
-    tags?: Record<string, string> | undefined;
-}
-/**
- * @public
- */
-export interface CreateMessageTemplateVersionResponse {
-    /**
-     * <p>The message template.</p>
-     * @public
-     */
-    messageTemplate?: ExtendedMessageTemplateData | undefined;
-}
-/**
- * <p>The container of quick response data.</p>
- * @public
- */
-export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
-/**
- * @public
- */
-export declare namespace QuickResponseDataProvider {
-    /**
-     * <p>The content of the quick response.</p>
-     * @public
-     */
-    interface ContentMember {
-        content: string;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        content?: never;
-        $unknown: [string, any];
-    }
-    /**
-     * @deprecated unused in schema-serde mode.
-     *
-     */
-    interface Visitor<T> {
-        content: (value: string) => T;
-        _: (name: string, value: any) => T;
-    }
-}
-/**
- * @public
- */
-export interface CreateQuickResponseRequest {
-    /**
-     * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
-     * @public
-     */
-    knowledgeBaseId: string | undefined;
-    /**
-     * <p>The name of the quick response.</p>
-     * @public
-     */
-    name: string | undefined;
-    /**
-     * <p>The content of the quick response.</p>
-     * @public
-     */
-    content: QuickResponseDataProvider | undefined;
-    /**
-     * <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p> </li> </ul>
-     * @public
-     */
-    contentType?: string | undefined;
-    /**
-     * <p>The configuration information of the user groups that the quick response is accessible to.</p>
-     * @public
-     */
-    groupingConfiguration?: GroupingConfiguration | undefined;
-    /**
-     * <p>The description of the quick response.</p>
-     * @public
-     */
-    description?: string | undefined;
-    /**
-     * <p>The shortcut key of the quick response. The value should be unique across the knowledge base. </p>
-     * @public
-     */
-    shortcutKey?: string | undefined;
-    /**
-     * <p>Whether the quick response is active.</p>
-     * @public
-     */
-    isActive?: boolean | undefined;
-    /**
-     * <p>The Amazon Connect channels this quick response applies to.</p>
-     * @public
-     */
-    channels?: string[] | undefined;
-    /**
-     * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
-     * @public
-     */
-    language?: string | undefined;
-    /**
-     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
-     * @public
-     */
-    clientToken?: string | undefined;
-    /**
-     * <p>The tags used to organize, track, or control access for this resource.</p>
-     * @public
-     */
-    tags?: Record<string, string> | undefined;
-}
+import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, ExtendedMessageTemplateData, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateContentProvider, MessageTemplateData, QueryResultType, QuickResponseDataProvider, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
 /**
  * <p>The container quick response content.</p>
  * @public
@@ -2378,23 +1960,6 @@ export interface TagResourceRequest {
  */
 export interface TagResourceResponse {
 }
-/**
- * <p>Amazon Q in Connect throws this exception if you have too many tags in your tag set.</p>
- * @public
- */
-export declare class TooManyTagsException extends __BaseException {
-    readonly name: "TooManyTagsException";
-    readonly $fault: "client";
-    /**
-     * <p>The specified resource name.</p>
-     * @public
-     */
-    resourceName?: string | undefined;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
-}
 /**
  * @public
  */

package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts

@@ -3,7 +3,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import {
   CreateMessageTemplateAttachmentRequest,
   CreateMessageTemplateAttachmentResponse,
-} from "../models/models_1";
+} from "../models/models_0";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts

@@ -1,7 +1,9 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { CreateMessageTemplateRequest } from "../models/models_0";
-import { CreateMessageTemplateResponse } from "../models/models_1";
+import {
+  CreateMessageTemplateRequest,
+  CreateMessageTemplateResponse,
+} from "../models/models_0";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts

@@ -3,7 +3,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import {
   CreateMessageTemplateVersionRequest,
   CreateMessageTemplateVersionResponse,
-} from "../models/models_1";
+} from "../models/models_0";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts

@@ -1,9 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import {
-  CreateQuickResponseRequest,
-  CreateQuickResponseResponse,
-} from "../models/models_1";
+import { CreateQuickResponseRequest } from "../models/models_0";
+import { CreateQuickResponseResponse } from "../models/models_1";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/index.d.ts

@@ -5,5 +5,7 @@ export { RuntimeExtension } from "./runtimeExtensions";
 export { QConnectExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
-export * from "./models";
+export * from "./models/errors";
+export * from "./models/models_0";
+export * from "./models/models_1";
 export { QConnectServiceException } from "./models/QConnectServiceException";

package/dist-types/ts3.4/models/errors.d.ts

@@ -0,0 +1,81 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  resourceName?: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "client";
+  $retryable: {};
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class UnauthorizedException extends __BaseException {
+  readonly name: "UnauthorizedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<UnauthorizedException, __BaseException>
+  );
+}
+export declare class RequestTimeoutException extends __BaseException {
+  readonly name: "RequestTimeoutException";
+  readonly $fault: "client";
+  $retryable: {};
+  constructor(
+    opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>
+  );
+}
+export declare class DependencyFailedException extends __BaseException {
+  readonly name: "DependencyFailedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<DependencyFailedException, __BaseException>
+  );
+}
+export declare class PreconditionFailedException extends __BaseException {
+  readonly name: "PreconditionFailedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>
+  );
+}
+export declare class TooManyTagsException extends __BaseException {
+  readonly name: "TooManyTagsException";
+  readonly $fault: "client";
+  resourceName?: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<TooManyTagsException, __BaseException>
+  );
+}