@aws-sdk/client-qconnect 3.699.0 → 3.703.0

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

@@ -1,27 +1,390 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import {
   ChannelSubtype,
+  Configuration,
   ContentDataDetails,
   ContentSummary,
   DataReference,
   Document,
-  ExternalSourceConfiguration,
+  ExtendedMessageTemplateData,
   GroupingConfiguration,
-  ImportJobData,
-  ImportJobType,
   IntentDetectedDataDetails,
   KnowledgeBaseData,
+  KnowledgeBaseStatus,
+  KnowledgeBaseType,
+  MessageTemplateAttachment,
+  MessageTemplateAttributes,
+  MessageTemplateContentProvider,
+  MessageTemplateData,
   QueryResultType,
-  QuickResponseContents,
-  QuickResponseStatus,
   RankingData,
   RecommendationTrigger,
   RecommendationType,
   RelevanceLevel,
+  RenderingConfiguration,
   SearchExpression,
+  ServerSideEncryptionConfiguration,
+  SourceConfiguration,
   SourceContentDataDetails,
+  VectorIngestionConfiguration,
 } from "./models_0";
 import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
+export type QuickResponseDataProvider =
+  | QuickResponseDataProvider.ContentMember
+  | QuickResponseDataProvider.$UnknownMember;
+export declare namespace QuickResponseDataProvider {
+  interface ContentMember {
+    content: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    content?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    content: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
+}
+export interface CreateQuickResponseRequest {
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  content: QuickResponseDataProvider | undefined;
+  contentType?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+  description?: string | undefined;
+  shortcutKey?: string | undefined;
+  isActive?: boolean | undefined;
+  channels?: string[] | undefined;
+  language?: string | undefined;
+  clientToken?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export type QuickResponseContentProvider =
+  | QuickResponseContentProvider.ContentMember
+  | QuickResponseContentProvider.$UnknownMember;
+export declare namespace QuickResponseContentProvider {
+  interface ContentMember {
+    content: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    content?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    content: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(
+    value: QuickResponseContentProvider,
+    visitor: Visitor<T>
+  ) => T;
+}
+export interface QuickResponseContents {
+  plainText?: QuickResponseContentProvider | undefined;
+  markdown?: QuickResponseContentProvider | undefined;
+}
+export declare const QuickResponseStatus: {
+  readonly CREATED: "CREATED";
+  readonly CREATE_FAILED: "CREATE_FAILED";
+  readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
+  readonly DELETED: "DELETED";
+  readonly DELETE_FAILED: "DELETE_FAILED";
+  readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
+  readonly UPDATE_FAILED: "UPDATE_FAILED";
+  readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
+};
+export type QuickResponseStatus =
+  (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
+export interface QuickResponseData {
+  quickResponseArn: string | undefined;
+  quickResponseId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  contentType: string | undefined;
+  status: QuickResponseStatus | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  contents?: QuickResponseContents | undefined;
+  description?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+  shortcutKey?: string | undefined;
+  lastModifiedBy?: string | undefined;
+  isActive?: boolean | undefined;
+  channels?: string[] | undefined;
+  language?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface CreateQuickResponseResponse {
+  quickResponse?: QuickResponseData | undefined;
+}
+export interface DeactivateMessageTemplateRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  versionNumber: number | undefined;
+}
+export interface DeactivateMessageTemplateResponse {
+  messageTemplateArn: string | undefined;
+  messageTemplateId: string | undefined;
+  versionNumber: number | undefined;
+}
+export interface DeleteImportJobRequest {
+  knowledgeBaseId: string | undefined;
+  importJobId: string | undefined;
+}
+export interface DeleteImportJobResponse {}
+export interface DeleteKnowledgeBaseRequest {
+  knowledgeBaseId: string | undefined;
+}
+export interface DeleteKnowledgeBaseResponse {}
+export interface DeleteMessageTemplateRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+}
+export interface DeleteMessageTemplateResponse {}
+export interface DeleteMessageTemplateAttachmentRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  attachmentId: string | undefined;
+}
+export interface DeleteMessageTemplateAttachmentResponse {}
+export interface DeleteQuickResponseRequest {
+  knowledgeBaseId: string | undefined;
+  quickResponseId: string | undefined;
+}
+export interface DeleteQuickResponseResponse {}
+export declare const ExternalSource: {
+  readonly AMAZON_CONNECT: "AMAZON_CONNECT";
+};
+export type ExternalSource =
+  (typeof ExternalSource)[keyof typeof ExternalSource];
+export interface ExternalSourceConfiguration {
+  source: ExternalSource | undefined;
+  configuration: Configuration | undefined;
+}
+export interface GetImportJobRequest {
+  importJobId: string | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export declare const ImportJobType: {
+  readonly QUICK_RESPONSES: "QUICK_RESPONSES";
+};
+export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
+export declare const ImportJobStatus: {
+  readonly COMPLETE: "COMPLETE";
+  readonly DELETED: "DELETED";
+  readonly DELETE_FAILED: "DELETE_FAILED";
+  readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
+  readonly FAILED: "FAILED";
+  readonly START_IN_PROGRESS: "START_IN_PROGRESS";
+};
+export type ImportJobStatus =
+  (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
+export interface ImportJobData {
+  importJobId: string | undefined;
+  knowledgeBaseId: string | undefined;
+  uploadId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  importJobType: ImportJobType | undefined;
+  status: ImportJobStatus | undefined;
+  url: string | undefined;
+  failedRecordReport?: string | undefined;
+  urlExpiry: Date | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  metadata?: Record<string, string> | undefined;
+  externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
+}
+export interface GetImportJobResponse {
+  importJob?: ImportJobData | undefined;
+}
+export interface GetKnowledgeBaseRequest {
+  knowledgeBaseId: string | undefined;
+}
+export interface GetKnowledgeBaseResponse {
+  knowledgeBase?: KnowledgeBaseData | undefined;
+}
+export interface GetMessageTemplateRequest {
+  messageTemplateId: string | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export interface GetMessageTemplateResponse {
+  messageTemplate?: ExtendedMessageTemplateData | undefined;
+}
+export interface GetQuickResponseRequest {
+  quickResponseId: string | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export interface GetQuickResponseResponse {
+  quickResponse?: QuickResponseData | undefined;
+}
+export interface ImportJobSummary {
+  importJobId: string | undefined;
+  knowledgeBaseId: string | undefined;
+  uploadId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  importJobType: ImportJobType | undefined;
+  status: ImportJobStatus | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  metadata?: Record<string, string> | undefined;
+  externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
+}
+export interface ListImportJobsRequest {
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export interface ListImportJobsResponse {
+  importJobSummaries: ImportJobSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListKnowledgeBasesRequest {
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+}
+export interface KnowledgeBaseSummary {
+  knowledgeBaseId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  name: string | undefined;
+  knowledgeBaseType: KnowledgeBaseType | undefined;
+  status: KnowledgeBaseStatus | undefined;
+  sourceConfiguration?: SourceConfiguration | undefined;
+  vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
+  renderingConfiguration?: RenderingConfiguration | undefined;
+  serverSideEncryptionConfiguration?:
+    | ServerSideEncryptionConfiguration
+    | undefined;
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface ListKnowledgeBasesResponse {
+  knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListMessageTemplatesRequest {
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export interface MessageTemplateSummary {
+  messageTemplateArn: string | undefined;
+  messageTemplateId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  channelSubtype: ChannelSubtype | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  lastModifiedBy: string | undefined;
+  activeVersionNumber?: number | undefined;
+  description?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface ListMessageTemplatesResponse {
+  messageTemplateSummaries: MessageTemplateSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListMessageTemplateVersionsRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+}
+export interface MessageTemplateVersionSummary {
+  messageTemplateArn: string | undefined;
+  messageTemplateId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  channelSubtype: ChannelSubtype | undefined;
+  isActive: boolean | undefined;
+  versionNumber: number | undefined;
+}
+export interface ListMessageTemplateVersionsResponse {
+  messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface RenderMessageTemplateRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  attributes: MessageTemplateAttributes | undefined;
+}
+export interface RenderMessageTemplateResponse {
+  content: MessageTemplateContentProvider | undefined;
+  attributesNotInterpolated?: string[] | undefined;
+  attachments?: MessageTemplateAttachment[] | undefined;
+}
+export interface UpdateMessageTemplateRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  content?: MessageTemplateContentProvider | undefined;
+  language?: string | undefined;
+  defaultAttributes?: MessageTemplateAttributes | undefined;
+}
+export interface UpdateMessageTemplateResponse {
+  messageTemplate?: MessageTemplateData | undefined;
+}
+export interface UpdateMessageTemplateMetadataRequest {
+  knowledgeBaseId: string | undefined;
+  messageTemplateId: string | undefined;
+  name?: string | undefined;
+  description?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+}
+export interface UpdateMessageTemplateMetadataResponse {
+  messageTemplate?: MessageTemplateData | undefined;
+}
+export interface ListQuickResponsesRequest {
+  nextToken?: string | undefined;
+  maxResults?: number | undefined;
+  knowledgeBaseId: string | undefined;
+}
+export interface QuickResponseSummary {
+  quickResponseArn: string | undefined;
+  quickResponseId: string | undefined;
+  knowledgeBaseArn: string | undefined;
+  knowledgeBaseId: string | undefined;
+  name: string | undefined;
+  contentType: string | undefined;
+  status: QuickResponseStatus | undefined;
+  createdTime: Date | undefined;
+  lastModifiedTime: Date | undefined;
+  description?: string | undefined;
+  lastModifiedBy?: string | undefined;
+  isActive?: boolean | undefined;
+  channels?: string[] | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface ListQuickResponsesResponse {
+  quickResponseSummaries: QuickResponseSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface UpdateQuickResponseRequest {
+  knowledgeBaseId: string | undefined;
+  quickResponseId: string | undefined;
+  name?: string | undefined;
+  content?: QuickResponseDataProvider | undefined;
+  contentType?: string | undefined;
+  groupingConfiguration?: GroupingConfiguration | undefined;
+  removeGroupingConfiguration?: boolean | undefined;
+  description?: string | undefined;
+  removeDescription?: boolean | undefined;
+  shortcutKey?: string | undefined;
+  removeShortcutKey?: boolean | undefined;
+  isActive?: boolean | undefined;
+  channels?: string[] | undefined;
+  language?: string | undefined;
+}
+export interface UpdateQuickResponseResponse {
+  quickResponse?: QuickResponseData | undefined;
+}
+export interface RemoveKnowledgeBaseTemplateUriRequest {
+  knowledgeBaseId: string | undefined;
+}
 export interface RemoveKnowledgeBaseTemplateUriResponse {}
 export interface SearchContentRequest {
   nextToken?: string | undefined;
@@ -308,6 +671,75 @@ export interface QueryAssistantResponse {
   results: ResultData[] | undefined;
   nextToken?: string | undefined;
 }
+export declare const QuickResponseDataProviderFilterSensitiveLog: (
+  obj: QuickResponseDataProvider
+) => any;
+export declare const CreateQuickResponseRequestFilterSensitiveLog: (
+  obj: CreateQuickResponseRequest
+) => any;
+export declare const QuickResponseContentProviderFilterSensitiveLog: (
+  obj: QuickResponseContentProvider
+) => any;
+export declare const QuickResponseContentsFilterSensitiveLog: (
+  obj: QuickResponseContents
+) => any;
+export declare const QuickResponseDataFilterSensitiveLog: (
+  obj: QuickResponseData
+) => any;
+export declare const CreateQuickResponseResponseFilterSensitiveLog: (
+  obj: CreateQuickResponseResponse
+) => any;
+export declare const ImportJobDataFilterSensitiveLog: (
+  obj: ImportJobData
+) => any;
+export declare const GetImportJobResponseFilterSensitiveLog: (
+  obj: GetImportJobResponse
+) => any;
+export declare const GetKnowledgeBaseResponseFilterSensitiveLog: (
+  obj: GetKnowledgeBaseResponse
+) => any;
+export declare const GetMessageTemplateResponseFilterSensitiveLog: (
+  obj: GetMessageTemplateResponse
+) => any;
+export declare const GetQuickResponseResponseFilterSensitiveLog: (
+  obj: GetQuickResponseResponse
+) => any;
+export declare const KnowledgeBaseSummaryFilterSensitiveLog: (
+  obj: KnowledgeBaseSummary
+) => any;
+export declare const ListKnowledgeBasesResponseFilterSensitiveLog: (
+  obj: ListKnowledgeBasesResponse
+) => any;
+export declare const RenderMessageTemplateRequestFilterSensitiveLog: (
+  obj: RenderMessageTemplateRequest
+) => any;
+export declare const RenderMessageTemplateResponseFilterSensitiveLog: (
+  obj: RenderMessageTemplateResponse
+) => any;
+export declare const UpdateMessageTemplateRequestFilterSensitiveLog: (
+  obj: UpdateMessageTemplateRequest
+) => any;
+export declare const UpdateMessageTemplateResponseFilterSensitiveLog: (
+  obj: UpdateMessageTemplateResponse
+) => any;
+export declare const UpdateMessageTemplateMetadataRequestFilterSensitiveLog: (
+  obj: UpdateMessageTemplateMetadataRequest
+) => any;
+export declare const UpdateMessageTemplateMetadataResponseFilterSensitiveLog: (
+  obj: UpdateMessageTemplateMetadataResponse
+) => any;
+export declare const QuickResponseSummaryFilterSensitiveLog: (
+  obj: QuickResponseSummary
+) => any;
+export declare const ListQuickResponsesResponseFilterSensitiveLog: (
+  obj: ListQuickResponsesResponse
+) => any;
+export declare const UpdateQuickResponseRequestFilterSensitiveLog: (
+  obj: UpdateQuickResponseRequest
+) => any;
+export declare const UpdateQuickResponseResponseFilterSensitiveLog: (
+  obj: UpdateQuickResponseResponse
+) => any;
 export declare const MessageTemplateSearchResultDataFilterSensitiveLog: (
   obj: MessageTemplateSearchResultData
 ) => any;

package/dist-types/ts3.4/pagination/ListAIGuardrailVersionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListAIGuardrailVersionsCommandInput,
+  ListAIGuardrailVersionsCommandOutput,
+} from "../commands/ListAIGuardrailVersionsCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateListAIGuardrailVersions: (
+  config: QConnectPaginationConfiguration,
+  input: ListAIGuardrailVersionsCommandInput,
+  ...rest: any[]
+) => Paginator<ListAIGuardrailVersionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListAIGuardrailsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListAIGuardrailsCommandInput,
+  ListAIGuardrailsCommandOutput,
+} from "../commands/ListAIGuardrailsCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateListAIGuardrails: (
+  config: QConnectPaginationConfiguration,
+  input: ListAIGuardrailsCommandInput,
+  ...rest: any[]
+) => Paginator<ListAIGuardrailsCommandOutput>;

package/dist-types/ts3.4/pagination/ListMessagesPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListMessagesCommandInput,
+  ListMessagesCommandOutput,
+} from "../commands/ListMessagesCommand";
+import { QConnectPaginationConfiguration } from "./Interfaces";
+export declare const paginateListMessages: (
+  config: QConnectPaginationConfiguration,
+  input: ListMessagesCommandInput,
+  ...rest: any[]
+) => Paginator<ListMessagesCommandOutput>;

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

@@ -1,6 +1,8 @@
 export * from "./Interfaces";
 export * from "./ListAIAgentVersionsPaginator";
 export * from "./ListAIAgentsPaginator";
+export * from "./ListAIGuardrailVersionsPaginator";
+export * from "./ListAIGuardrailsPaginator";
 export * from "./ListAIPromptVersionsPaginator";
 export * from "./ListAIPromptsPaginator";
 export * from "./ListAssistantAssociationsPaginator";
@@ -11,6 +13,7 @@ export * from "./ListImportJobsPaginator";
 export * from "./ListKnowledgeBasesPaginator";
 export * from "./ListMessageTemplateVersionsPaginator";
 export * from "./ListMessageTemplatesPaginator";
+export * from "./ListMessagesPaginator";
 export * from "./ListQuickResponsesPaginator";
 export * from "./QueryAssistantPaginator";
 export * from "./SearchContentPaginator";