@aws-sdk/client-qconnect 3.938.0 → 3.939.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +415 -16
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +337 -0
- package/dist-es/models/models_0.js +1 -288
- package/dist-es/models/models_1.js +1 -49
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +1 -2
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +2 -1
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +825 -0
- package/dist-types/models/models_0.d.ts +1381 -685
- package/dist-types/models/models_1.d.ts +2 -1521
- package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +2 -4
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +442 -0
- package/dist-types/ts3.4/models/models_0.d.ts +411 -376
- package/dist-types/ts3.4/models/models_1.d.ts +21 -435
- package/package.json +2 -2
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { AIAgentAssociationConfigurationType, AIAgentType, AIPromptAPIFormat, AIPromptTemplateType, AIPromptType, AssistantCapabilityType, AssistantStatus, AssistantType, AssociationType, ChannelSubtype, ChunkingStrategy, ContentAssociationType, ContentDisposition, ContentStatus, ConversationStatus, ConversationStatusReason, ExternalSource, FilterField, FilterOperator, GuardrailContentFilterType, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailTopicType, ImportJobStatus, ImportJobType, KnowledgeBaseSearchType, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttributeType, MessageType, Origin, ParsingStrategy, Participant, PushMessageAction, QueryConditionComparisonOperator, QueryConditionFieldName, QuickResponseStatus, RecommendationSourceType, RecommendationTriggerType, ReferenceType, Relevance, RelevanceLevel, SessionDataNamespace, SourceContentType, Status, SyncStatus, TargetType, VisibilityStatus, WebScopeType, WhatsAppSourceConfigurationStatus } from "./enums";
|
|
1
2
|
/**
|
|
2
3
|
* @public
|
|
3
4
|
*/
|
|
@@ -174,18 +175,6 @@ export declare namespace TagFilter {
|
|
|
174
175
|
_: (name: string, value: any) => T;
|
|
175
176
|
}
|
|
176
177
|
}
|
|
177
|
-
/**
|
|
178
|
-
* @public
|
|
179
|
-
* @enum
|
|
180
|
-
*/
|
|
181
|
-
export declare const KnowledgeBaseSearchType: {
|
|
182
|
-
readonly HYBRID: "HYBRID";
|
|
183
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
184
|
-
};
|
|
185
|
-
/**
|
|
186
|
-
* @public
|
|
187
|
-
*/
|
|
188
|
-
export type KnowledgeBaseSearchType = (typeof KnowledgeBaseSearchType)[keyof typeof KnowledgeBaseSearchType];
|
|
189
178
|
/**
|
|
190
179
|
* <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect Assistant Association.</p>
|
|
191
180
|
* @public
|
|
@@ -240,17 +229,6 @@ export declare namespace AssociationConfigurationData {
|
|
|
240
229
|
_: (name: string, value: any) => T;
|
|
241
230
|
}
|
|
242
231
|
}
|
|
243
|
-
/**
|
|
244
|
-
* @public
|
|
245
|
-
* @enum
|
|
246
|
-
*/
|
|
247
|
-
export declare const AIAgentAssociationConfigurationType: {
|
|
248
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
249
|
-
};
|
|
250
|
-
/**
|
|
251
|
-
* @public
|
|
252
|
-
*/
|
|
253
|
-
export type AIAgentAssociationConfigurationType = (typeof AIAgentAssociationConfigurationType)[keyof typeof AIAgentAssociationConfigurationType];
|
|
254
232
|
/**
|
|
255
233
|
* <p>The configuration for an Amazon Q in Connect Assistant Association.</p>
|
|
256
234
|
* @public
|
|
@@ -541,34 +519,6 @@ export declare namespace AIAgentConfiguration {
|
|
|
541
519
|
_: (name: string, value: any) => T;
|
|
542
520
|
}
|
|
543
521
|
}
|
|
544
|
-
/**
|
|
545
|
-
* @public
|
|
546
|
-
* @enum
|
|
547
|
-
*/
|
|
548
|
-
export declare const AIAgentType: {
|
|
549
|
-
readonly ANSWER_RECOMMENDATION: "ANSWER_RECOMMENDATION";
|
|
550
|
-
readonly EMAIL_GENERATIVE_ANSWER: "EMAIL_GENERATIVE_ANSWER";
|
|
551
|
-
readonly EMAIL_OVERVIEW: "EMAIL_OVERVIEW";
|
|
552
|
-
readonly EMAIL_RESPONSE: "EMAIL_RESPONSE";
|
|
553
|
-
readonly MANUAL_SEARCH: "MANUAL_SEARCH";
|
|
554
|
-
readonly SELF_SERVICE: "SELF_SERVICE";
|
|
555
|
-
};
|
|
556
|
-
/**
|
|
557
|
-
* @public
|
|
558
|
-
*/
|
|
559
|
-
export type AIAgentType = (typeof AIAgentType)[keyof typeof AIAgentType];
|
|
560
|
-
/**
|
|
561
|
-
* @public
|
|
562
|
-
* @enum
|
|
563
|
-
*/
|
|
564
|
-
export declare const VisibilityStatus: {
|
|
565
|
-
readonly PUBLISHED: "PUBLISHED";
|
|
566
|
-
readonly SAVED: "SAVED";
|
|
567
|
-
};
|
|
568
|
-
/**
|
|
569
|
-
* @public
|
|
570
|
-
*/
|
|
571
|
-
export type VisibilityStatus = (typeof VisibilityStatus)[keyof typeof VisibilityStatus];
|
|
572
522
|
/**
|
|
573
523
|
* @public
|
|
574
524
|
*/
|
|
@@ -614,34 +564,6 @@ export interface CreateAIAgentRequest {
|
|
|
614
564
|
*/
|
|
615
565
|
description?: string | undefined;
|
|
616
566
|
}
|
|
617
|
-
/**
|
|
618
|
-
* @public
|
|
619
|
-
* @enum
|
|
620
|
-
*/
|
|
621
|
-
export declare const Origin: {
|
|
622
|
-
readonly CUSTOMER: "CUSTOMER";
|
|
623
|
-
readonly SYSTEM: "SYSTEM";
|
|
624
|
-
};
|
|
625
|
-
/**
|
|
626
|
-
* @public
|
|
627
|
-
*/
|
|
628
|
-
export type Origin = (typeof Origin)[keyof typeof Origin];
|
|
629
|
-
/**
|
|
630
|
-
* @public
|
|
631
|
-
* @enum
|
|
632
|
-
*/
|
|
633
|
-
export declare const Status: {
|
|
634
|
-
readonly ACTIVE: "ACTIVE";
|
|
635
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
636
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
637
|
-
readonly DELETED: "DELETED";
|
|
638
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
639
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
640
|
-
};
|
|
641
|
-
/**
|
|
642
|
-
* @public
|
|
643
|
-
*/
|
|
644
|
-
export type Status = (typeof Status)[keyof typeof Status];
|
|
645
567
|
/**
|
|
646
568
|
* <p>The data for the AI Agent.</p>
|
|
647
569
|
* @public
|
|
@@ -1066,36 +988,6 @@ export interface AIAgentConfigurationData {
|
|
|
1066
988
|
*/
|
|
1067
989
|
aiAgentId: string | undefined;
|
|
1068
990
|
}
|
|
1069
|
-
/**
|
|
1070
|
-
* @public
|
|
1071
|
-
* @enum
|
|
1072
|
-
*/
|
|
1073
|
-
export declare const GuardrailFilterStrength: {
|
|
1074
|
-
readonly HIGH: "HIGH";
|
|
1075
|
-
readonly LOW: "LOW";
|
|
1076
|
-
readonly MEDIUM: "MEDIUM";
|
|
1077
|
-
readonly NONE: "NONE";
|
|
1078
|
-
};
|
|
1079
|
-
/**
|
|
1080
|
-
* @public
|
|
1081
|
-
*/
|
|
1082
|
-
export type GuardrailFilterStrength = (typeof GuardrailFilterStrength)[keyof typeof GuardrailFilterStrength];
|
|
1083
|
-
/**
|
|
1084
|
-
* @public
|
|
1085
|
-
* @enum
|
|
1086
|
-
*/
|
|
1087
|
-
export declare const GuardrailContentFilterType: {
|
|
1088
|
-
readonly HATE: "HATE";
|
|
1089
|
-
readonly INSULTS: "INSULTS";
|
|
1090
|
-
readonly MISCONDUCT: "MISCONDUCT";
|
|
1091
|
-
readonly PROMPT_ATTACK: "PROMPT_ATTACK";
|
|
1092
|
-
readonly SEXUAL: "SEXUAL";
|
|
1093
|
-
readonly VIOLENCE: "VIOLENCE";
|
|
1094
|
-
};
|
|
1095
|
-
/**
|
|
1096
|
-
* @public
|
|
1097
|
-
*/
|
|
1098
|
-
export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
|
|
1099
991
|
/**
|
|
1100
992
|
* <p>Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b>: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b>: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b>: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b>: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i> Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p>
|
|
1101
993
|
* @public
|
|
@@ -1128,18 +1020,6 @@ export interface AIGuardrailContentPolicyConfig {
|
|
|
1128
1020
|
*/
|
|
1129
1021
|
filtersConfig: GuardrailContentFilterConfig[] | undefined;
|
|
1130
1022
|
}
|
|
1131
|
-
/**
|
|
1132
|
-
* @public
|
|
1133
|
-
* @enum
|
|
1134
|
-
*/
|
|
1135
|
-
export declare const GuardrailContextualGroundingFilterType: {
|
|
1136
|
-
readonly GROUNDING: "GROUNDING";
|
|
1137
|
-
readonly RELEVANCE: "RELEVANCE";
|
|
1138
|
-
};
|
|
1139
|
-
/**
|
|
1140
|
-
* @public
|
|
1141
|
-
*/
|
|
1142
|
-
export type GuardrailContextualGroundingFilterType = (typeof GuardrailContextualGroundingFilterType)[keyof typeof GuardrailContextualGroundingFilterType];
|
|
1143
1023
|
/**
|
|
1144
1024
|
* <p>The filter configuration details for the AI Guardrail's contextual grounding filter.</p>
|
|
1145
1025
|
* @public
|
|
@@ -1167,59 +1047,6 @@ export interface AIGuardrailContextualGroundingPolicyConfig {
|
|
|
1167
1047
|
*/
|
|
1168
1048
|
filtersConfig: GuardrailContextualGroundingFilterConfig[] | undefined;
|
|
1169
1049
|
}
|
|
1170
|
-
/**
|
|
1171
|
-
* @public
|
|
1172
|
-
* @enum
|
|
1173
|
-
*/
|
|
1174
|
-
export declare const GuardrailSensitiveInformationAction: {
|
|
1175
|
-
readonly ANONYMIZE: "ANONYMIZE";
|
|
1176
|
-
readonly BLOCK: "BLOCK";
|
|
1177
|
-
};
|
|
1178
|
-
/**
|
|
1179
|
-
* @public
|
|
1180
|
-
*/
|
|
1181
|
-
export type GuardrailSensitiveInformationAction = (typeof GuardrailSensitiveInformationAction)[keyof typeof GuardrailSensitiveInformationAction];
|
|
1182
|
-
/**
|
|
1183
|
-
* @public
|
|
1184
|
-
* @enum
|
|
1185
|
-
*/
|
|
1186
|
-
export declare const GuardrailPiiEntityType: {
|
|
1187
|
-
readonly ADDRESS: "ADDRESS";
|
|
1188
|
-
readonly AGE: "AGE";
|
|
1189
|
-
readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
|
|
1190
|
-
readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
|
|
1191
|
-
readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
|
|
1192
|
-
readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
|
|
1193
|
-
readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
|
|
1194
|
-
readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
|
|
1195
|
-
readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
|
|
1196
|
-
readonly DRIVER_ID: "DRIVER_ID";
|
|
1197
|
-
readonly EMAIL: "EMAIL";
|
|
1198
|
-
readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
|
|
1199
|
-
readonly IP_ADDRESS: "IP_ADDRESS";
|
|
1200
|
-
readonly LICENSE_PLATE: "LICENSE_PLATE";
|
|
1201
|
-
readonly MAC_ADDRESS: "MAC_ADDRESS";
|
|
1202
|
-
readonly NAME: "NAME";
|
|
1203
|
-
readonly PASSWORD: "PASSWORD";
|
|
1204
|
-
readonly PHONE: "PHONE";
|
|
1205
|
-
readonly PIN: "PIN";
|
|
1206
|
-
readonly SWIFT_CODE: "SWIFT_CODE";
|
|
1207
|
-
readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
|
|
1208
|
-
readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
|
|
1209
|
-
readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
|
|
1210
|
-
readonly URL: "URL";
|
|
1211
|
-
readonly USERNAME: "USERNAME";
|
|
1212
|
-
readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
|
|
1213
|
-
readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
|
|
1214
|
-
readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
|
|
1215
|
-
readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
|
|
1216
|
-
readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
|
|
1217
|
-
readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
|
|
1218
|
-
};
|
|
1219
|
-
/**
|
|
1220
|
-
* @public
|
|
1221
|
-
*/
|
|
1222
|
-
export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
|
|
1223
1050
|
/**
|
|
1224
1051
|
* <p>The PII entity to configure for the AI Guardrail.</p>
|
|
1225
1052
|
* @public
|
|
@@ -1278,17 +1105,6 @@ export interface AIGuardrailSensitiveInformationPolicyConfig {
|
|
|
1278
1105
|
*/
|
|
1279
1106
|
regexesConfig?: GuardrailRegexConfig[] | undefined;
|
|
1280
1107
|
}
|
|
1281
|
-
/**
|
|
1282
|
-
* @public
|
|
1283
|
-
* @enum
|
|
1284
|
-
*/
|
|
1285
|
-
export declare const GuardrailTopicType: {
|
|
1286
|
-
readonly DENY: "DENY";
|
|
1287
|
-
};
|
|
1288
|
-
/**
|
|
1289
|
-
* @public
|
|
1290
|
-
*/
|
|
1291
|
-
export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
|
|
1292
1108
|
/**
|
|
1293
1109
|
* <p>Details about topics for the AI Guardrail to identify and deny.</p>
|
|
1294
1110
|
* @public
|
|
@@ -1326,17 +1142,6 @@ export interface AIGuardrailTopicPolicyConfig {
|
|
|
1326
1142
|
*/
|
|
1327
1143
|
topicsConfig: GuardrailTopicConfig[] | undefined;
|
|
1328
1144
|
}
|
|
1329
|
-
/**
|
|
1330
|
-
* @public
|
|
1331
|
-
* @enum
|
|
1332
|
-
*/
|
|
1333
|
-
export declare const GuardrailManagedWordsType: {
|
|
1334
|
-
readonly PROFANITY: "PROFANITY";
|
|
1335
|
-
};
|
|
1336
|
-
/**
|
|
1337
|
-
* @public
|
|
1338
|
-
*/
|
|
1339
|
-
export type GuardrailManagedWordsType = (typeof GuardrailManagedWordsType)[keyof typeof GuardrailManagedWordsType];
|
|
1340
1145
|
/**
|
|
1341
1146
|
* <p>The managed word list to configure for the AI Guardrail.</p>
|
|
1342
1147
|
* @public
|
|
@@ -1883,20 +1688,6 @@ export interface UpdateAIGuardrailResponse {
|
|
|
1883
1688
|
*/
|
|
1884
1689
|
aiGuardrail?: AIGuardrailData | undefined;
|
|
1885
1690
|
}
|
|
1886
|
-
/**
|
|
1887
|
-
* @public
|
|
1888
|
-
* @enum
|
|
1889
|
-
*/
|
|
1890
|
-
export declare const AIPromptAPIFormat: {
|
|
1891
|
-
readonly ANTHROPIC_CLAUDE_MESSAGES: "ANTHROPIC_CLAUDE_MESSAGES";
|
|
1892
|
-
readonly ANTHROPIC_CLAUDE_TEXT_COMPLETIONS: "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS";
|
|
1893
|
-
readonly MESSAGES: "MESSAGES";
|
|
1894
|
-
readonly TEXT_COMPLETIONS: "TEXT_COMPLETIONS";
|
|
1895
|
-
};
|
|
1896
|
-
/**
|
|
1897
|
-
* @public
|
|
1898
|
-
*/
|
|
1899
|
-
export type AIPromptAPIFormat = (typeof AIPromptAPIFormat)[keyof typeof AIPromptAPIFormat];
|
|
1900
1691
|
/**
|
|
1901
1692
|
* <p>The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.</p>
|
|
1902
1693
|
* @public
|
|
@@ -1941,36 +1732,6 @@ export declare namespace AIPromptTemplateConfiguration {
|
|
|
1941
1732
|
_: (name: string, value: any) => T;
|
|
1942
1733
|
}
|
|
1943
1734
|
}
|
|
1944
|
-
/**
|
|
1945
|
-
* @public
|
|
1946
|
-
* @enum
|
|
1947
|
-
*/
|
|
1948
|
-
export declare const AIPromptTemplateType: {
|
|
1949
|
-
readonly TEXT: "TEXT";
|
|
1950
|
-
};
|
|
1951
|
-
/**
|
|
1952
|
-
* @public
|
|
1953
|
-
*/
|
|
1954
|
-
export type AIPromptTemplateType = (typeof AIPromptTemplateType)[keyof typeof AIPromptTemplateType];
|
|
1955
|
-
/**
|
|
1956
|
-
* @public
|
|
1957
|
-
* @enum
|
|
1958
|
-
*/
|
|
1959
|
-
export declare const AIPromptType: {
|
|
1960
|
-
readonly ANSWER_GENERATION: "ANSWER_GENERATION";
|
|
1961
|
-
readonly EMAIL_GENERATIVE_ANSWER: "EMAIL_GENERATIVE_ANSWER";
|
|
1962
|
-
readonly EMAIL_OVERVIEW: "EMAIL_OVERVIEW";
|
|
1963
|
-
readonly EMAIL_QUERY_REFORMULATION: "EMAIL_QUERY_REFORMULATION";
|
|
1964
|
-
readonly EMAIL_RESPONSE: "EMAIL_RESPONSE";
|
|
1965
|
-
readonly INTENT_LABELING_GENERATION: "INTENT_LABELING_GENERATION";
|
|
1966
|
-
readonly QUERY_REFORMULATION: "QUERY_REFORMULATION";
|
|
1967
|
-
readonly SELF_SERVICE_ANSWER_GENERATION: "SELF_SERVICE_ANSWER_GENERATION";
|
|
1968
|
-
readonly SELF_SERVICE_PRE_PROCESSING: "SELF_SERVICE_PRE_PROCESSING";
|
|
1969
|
-
};
|
|
1970
|
-
/**
|
|
1971
|
-
* @public
|
|
1972
|
-
*/
|
|
1973
|
-
export type AIPromptType = (typeof AIPromptType)[keyof typeof AIPromptType];
|
|
1974
1735
|
/**
|
|
1975
1736
|
* @public
|
|
1976
1737
|
*/
|
|
@@ -2534,17 +2295,6 @@ export declare namespace AssistantAssociationInputData {
|
|
|
2534
2295
|
_: (name: string, value: any) => T;
|
|
2535
2296
|
}
|
|
2536
2297
|
}
|
|
2537
|
-
/**
|
|
2538
|
-
* @public
|
|
2539
|
-
* @enum
|
|
2540
|
-
*/
|
|
2541
|
-
export declare const AssociationType: {
|
|
2542
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2543
|
-
};
|
|
2544
|
-
/**
|
|
2545
|
-
* @public
|
|
2546
|
-
*/
|
|
2547
|
-
export type AssociationType = (typeof AssociationType)[keyof typeof AssociationType];
|
|
2548
2298
|
/**
|
|
2549
2299
|
* @public
|
|
2550
2300
|
*/
|
|
@@ -2807,17 +2557,6 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
2807
2557
|
*/
|
|
2808
2558
|
kmsKeyId?: string | undefined;
|
|
2809
2559
|
}
|
|
2810
|
-
/**
|
|
2811
|
-
* @public
|
|
2812
|
-
* @enum
|
|
2813
|
-
*/
|
|
2814
|
-
export declare const AssistantType: {
|
|
2815
|
-
readonly AGENT: "AGENT";
|
|
2816
|
-
};
|
|
2817
|
-
/**
|
|
2818
|
-
* @public
|
|
2819
|
-
*/
|
|
2820
|
-
export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
|
|
2821
2560
|
/**
|
|
2822
2561
|
* @public
|
|
2823
2562
|
*/
|
|
@@ -2853,18 +2592,6 @@ export interface CreateAssistantRequest {
|
|
|
2853
2592
|
*/
|
|
2854
2593
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
2855
2594
|
}
|
|
2856
|
-
/**
|
|
2857
|
-
* @public
|
|
2858
|
-
* @enum
|
|
2859
|
-
*/
|
|
2860
|
-
export declare const AssistantCapabilityType: {
|
|
2861
|
-
readonly V1: "V1";
|
|
2862
|
-
readonly V2: "V2";
|
|
2863
|
-
};
|
|
2864
|
-
/**
|
|
2865
|
-
* @public
|
|
2866
|
-
*/
|
|
2867
|
-
export type AssistantCapabilityType = (typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType];
|
|
2868
2595
|
/**
|
|
2869
2596
|
* <p>The capability configuration for an Amazon Q in Connect assistant. </p>
|
|
2870
2597
|
* @public
|
|
@@ -2887,22 +2614,6 @@ export interface AssistantIntegrationConfiguration {
|
|
|
2887
2614
|
*/
|
|
2888
2615
|
topicIntegrationArn?: string | undefined;
|
|
2889
2616
|
}
|
|
2890
|
-
/**
|
|
2891
|
-
* @public
|
|
2892
|
-
* @enum
|
|
2893
|
-
*/
|
|
2894
|
-
export declare const AssistantStatus: {
|
|
2895
|
-
readonly ACTIVE: "ACTIVE";
|
|
2896
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
2897
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
2898
|
-
readonly DELETED: "DELETED";
|
|
2899
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
2900
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
2901
|
-
};
|
|
2902
|
-
/**
|
|
2903
|
-
* @public
|
|
2904
|
-
*/
|
|
2905
|
-
export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantStatus];
|
|
2906
2617
|
/**
|
|
2907
2618
|
* <p>The assistant data.</p>
|
|
2908
2619
|
* @public
|
|
@@ -3039,19 +2750,6 @@ export interface GetRecommendationsRequest {
|
|
|
3039
2750
|
*/
|
|
3040
2751
|
nextChunkToken?: string | undefined;
|
|
3041
2752
|
}
|
|
3042
|
-
/**
|
|
3043
|
-
* @public
|
|
3044
|
-
* @enum
|
|
3045
|
-
*/
|
|
3046
|
-
export declare const RelevanceLevel: {
|
|
3047
|
-
readonly HIGH: "HIGH";
|
|
3048
|
-
readonly LOW: "LOW";
|
|
3049
|
-
readonly MEDIUM: "MEDIUM";
|
|
3050
|
-
};
|
|
3051
|
-
/**
|
|
3052
|
-
* @public
|
|
3053
|
-
*/
|
|
3054
|
-
export type RelevanceLevel = (typeof RelevanceLevel)[keyof typeof RelevanceLevel];
|
|
3055
2753
|
/**
|
|
3056
2754
|
* <p>Details about the source content ranking data.</p>
|
|
3057
2755
|
* @public
|
|
@@ -3196,17 +2894,6 @@ export interface CitationSpan {
|
|
|
3196
2894
|
*/
|
|
3197
2895
|
endOffsetExclusive?: number | undefined;
|
|
3198
2896
|
}
|
|
3199
|
-
/**
|
|
3200
|
-
* @public
|
|
3201
|
-
* @enum
|
|
3202
|
-
*/
|
|
3203
|
-
export declare const SourceContentType: {
|
|
3204
|
-
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
3205
|
-
};
|
|
3206
|
-
/**
|
|
3207
|
-
* @public
|
|
3208
|
-
*/
|
|
3209
|
-
export type SourceContentType = (typeof SourceContentType)[keyof typeof SourceContentType];
|
|
3210
2897
|
/**
|
|
3211
2898
|
* <p>Details about the source content data.</p>
|
|
3212
2899
|
* @public
|
|
@@ -3238,18 +2925,6 @@ export interface SourceContentDataDetails {
|
|
|
3238
2925
|
*/
|
|
3239
2926
|
citationSpan?: CitationSpan | undefined;
|
|
3240
2927
|
}
|
|
3241
|
-
/**
|
|
3242
|
-
* @public
|
|
3243
|
-
* @enum
|
|
3244
|
-
*/
|
|
3245
|
-
export declare const ReferenceType: {
|
|
3246
|
-
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
3247
|
-
readonly WEB_CRAWLER: "WEB_CRAWLER";
|
|
3248
|
-
};
|
|
3249
|
-
/**
|
|
3250
|
-
* @public
|
|
3251
|
-
*/
|
|
3252
|
-
export type ReferenceType = (typeof ReferenceType)[keyof typeof ReferenceType];
|
|
3253
2928
|
/**
|
|
3254
2929
|
* <p>Reference information about the content.</p>
|
|
3255
2930
|
* @public
|
|
@@ -3368,27 +3043,6 @@ export interface Document {
|
|
|
3368
3043
|
*/
|
|
3369
3044
|
excerpt?: DocumentText | undefined;
|
|
3370
3045
|
}
|
|
3371
|
-
/**
|
|
3372
|
-
* @public
|
|
3373
|
-
* @enum
|
|
3374
|
-
*/
|
|
3375
|
-
export declare const RecommendationType: {
|
|
3376
|
-
readonly BLOCKED_GENERATIVE_ANSWER_CHUNK: "BLOCKED_GENERATIVE_ANSWER_CHUNK";
|
|
3377
|
-
readonly BLOCKED_INTENT_ANSWER_CHUNK: "BLOCKED_INTENT_ANSWER_CHUNK";
|
|
3378
|
-
readonly DETECTED_INTENT: "DETECTED_INTENT";
|
|
3379
|
-
readonly EMAIL_GENERATIVE_ANSWER_CHUNK: "EMAIL_GENERATIVE_ANSWER_CHUNK";
|
|
3380
|
-
readonly EMAIL_OVERVIEW_CHUNK: "EMAIL_OVERVIEW_CHUNK";
|
|
3381
|
-
readonly EMAIL_RESPONSE_CHUNK: "EMAIL_RESPONSE_CHUNK";
|
|
3382
|
-
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
3383
|
-
readonly GENERATIVE_ANSWER_CHUNK: "GENERATIVE_ANSWER_CHUNK";
|
|
3384
|
-
readonly GENERATIVE_RESPONSE: "GENERATIVE_RESPONSE";
|
|
3385
|
-
readonly INTENT_ANSWER_CHUNK: "INTENT_ANSWER_CHUNK";
|
|
3386
|
-
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
3387
|
-
};
|
|
3388
|
-
/**
|
|
3389
|
-
* @public
|
|
3390
|
-
*/
|
|
3391
|
-
export type RecommendationType = (typeof RecommendationType)[keyof typeof RecommendationType];
|
|
3392
3046
|
/**
|
|
3393
3047
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
3394
3048
|
* @public
|
|
@@ -3433,31 +3087,6 @@ export declare namespace RecommendationTriggerData {
|
|
|
3433
3087
|
_: (name: string, value: any) => T;
|
|
3434
3088
|
}
|
|
3435
3089
|
}
|
|
3436
|
-
/**
|
|
3437
|
-
* @public
|
|
3438
|
-
* @enum
|
|
3439
|
-
*/
|
|
3440
|
-
export declare const RecommendationSourceType: {
|
|
3441
|
-
readonly ISSUE_DETECTION: "ISSUE_DETECTION";
|
|
3442
|
-
readonly OTHER: "OTHER";
|
|
3443
|
-
readonly RULE_EVALUATION: "RULE_EVALUATION";
|
|
3444
|
-
};
|
|
3445
|
-
/**
|
|
3446
|
-
* @public
|
|
3447
|
-
*/
|
|
3448
|
-
export type RecommendationSourceType = (typeof RecommendationSourceType)[keyof typeof RecommendationSourceType];
|
|
3449
|
-
/**
|
|
3450
|
-
* @public
|
|
3451
|
-
* @enum
|
|
3452
|
-
*/
|
|
3453
|
-
export declare const RecommendationTriggerType: {
|
|
3454
|
-
readonly GENERATIVE: "GENERATIVE";
|
|
3455
|
-
readonly QUERY: "QUERY";
|
|
3456
|
-
};
|
|
3457
|
-
/**
|
|
3458
|
-
* @public
|
|
3459
|
-
*/
|
|
3460
|
-
export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
|
|
3461
3090
|
/**
|
|
3462
3091
|
* <p>A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a single RecommendationTrigger.</p>
|
|
3463
3092
|
* @public
|
|
@@ -3631,18 +3260,6 @@ export interface NotifyRecommendationsReceivedResponse {
|
|
|
3631
3260
|
*/
|
|
3632
3261
|
errors?: NotifyRecommendationsReceivedError[] | undefined;
|
|
3633
3262
|
}
|
|
3634
|
-
/**
|
|
3635
|
-
* @public
|
|
3636
|
-
* @enum
|
|
3637
|
-
*/
|
|
3638
|
-
export declare const Relevance: {
|
|
3639
|
-
readonly HELPFUL: "HELPFUL";
|
|
3640
|
-
readonly NOT_HELPFUL: "NOT_HELPFUL";
|
|
3641
|
-
};
|
|
3642
|
-
/**
|
|
3643
|
-
* @public
|
|
3644
|
-
*/
|
|
3645
|
-
export type Relevance = (typeof Relevance)[keyof typeof Relevance];
|
|
3646
3263
|
/**
|
|
3647
3264
|
* <p>The feedback information for a generative target type.</p>
|
|
3648
3265
|
* @public
|
|
@@ -3687,18 +3304,6 @@ export declare namespace ContentFeedbackData {
|
|
|
3687
3304
|
_: (name: string, value: any) => T;
|
|
3688
3305
|
}
|
|
3689
3306
|
}
|
|
3690
|
-
/**
|
|
3691
|
-
* @public
|
|
3692
|
-
* @enum
|
|
3693
|
-
*/
|
|
3694
|
-
export declare const TargetType: {
|
|
3695
|
-
readonly RECOMMENDATION: "RECOMMENDATION";
|
|
3696
|
-
readonly RESULT: "RESULT";
|
|
3697
|
-
};
|
|
3698
|
-
/**
|
|
3699
|
-
* @public
|
|
3700
|
-
*/
|
|
3701
|
-
export type TargetType = (typeof TargetType)[keyof typeof TargetType];
|
|
3702
3307
|
/**
|
|
3703
3308
|
* @public
|
|
3704
3309
|
*/
|
|
@@ -3754,28 +3359,6 @@ export interface PutFeedbackResponse {
|
|
|
3754
3359
|
*/
|
|
3755
3360
|
contentFeedback: ContentFeedbackData | undefined;
|
|
3756
3361
|
}
|
|
3757
|
-
/**
|
|
3758
|
-
* @public
|
|
3759
|
-
* @enum
|
|
3760
|
-
*/
|
|
3761
|
-
export declare const QueryConditionComparisonOperator: {
|
|
3762
|
-
readonly EQUALS: "EQUALS";
|
|
3763
|
-
};
|
|
3764
|
-
/**
|
|
3765
|
-
* @public
|
|
3766
|
-
*/
|
|
3767
|
-
export type QueryConditionComparisonOperator = (typeof QueryConditionComparisonOperator)[keyof typeof QueryConditionComparisonOperator];
|
|
3768
|
-
/**
|
|
3769
|
-
* @public
|
|
3770
|
-
* @enum
|
|
3771
|
-
*/
|
|
3772
|
-
export declare const QueryConditionFieldName: {
|
|
3773
|
-
readonly RESULT_TYPE: "RESULT_TYPE";
|
|
3774
|
-
};
|
|
3775
|
-
/**
|
|
3776
|
-
* @public
|
|
3777
|
-
*/
|
|
3778
|
-
export type QueryConditionFieldName = (typeof QueryConditionFieldName)[keyof typeof QueryConditionFieldName];
|
|
3779
3362
|
/**
|
|
3780
3363
|
* <p>The condition for the query.</p>
|
|
3781
3364
|
* @public
|
|
@@ -3942,26 +3525,6 @@ export interface QueryAssistantRequest {
|
|
|
3942
3525
|
*/
|
|
3943
3526
|
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
|
|
3944
3527
|
}
|
|
3945
|
-
/**
|
|
3946
|
-
* @public
|
|
3947
|
-
* @enum
|
|
3948
|
-
*/
|
|
3949
|
-
export declare const QueryResultType: {
|
|
3950
|
-
readonly BLOCKED_GENERATIVE_ANSWER_CHUNK: "BLOCKED_GENERATIVE_ANSWER_CHUNK";
|
|
3951
|
-
readonly BLOCKED_INTENT_ANSWER_CHUNK: "BLOCKED_INTENT_ANSWER_CHUNK";
|
|
3952
|
-
readonly EMAIL_GENERATIVE_ANSWER_CHUNK: "EMAIL_GENERATIVE_ANSWER_CHUNK";
|
|
3953
|
-
readonly EMAIL_OVERVIEW_CHUNK: "EMAIL_OVERVIEW_CHUNK";
|
|
3954
|
-
readonly EMAIL_RESPONSE_CHUNK: "EMAIL_RESPONSE_CHUNK";
|
|
3955
|
-
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
3956
|
-
readonly GENERATIVE_ANSWER_CHUNK: "GENERATIVE_ANSWER_CHUNK";
|
|
3957
|
-
readonly INTENT_ANSWER: "INTENT_ANSWER";
|
|
3958
|
-
readonly INTENT_ANSWER_CHUNK: "INTENT_ANSWER_CHUNK";
|
|
3959
|
-
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
3960
|
-
};
|
|
3961
|
-
/**
|
|
3962
|
-
* @public
|
|
3963
|
-
*/
|
|
3964
|
-
export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
|
|
3965
3528
|
/**
|
|
3966
3529
|
* @public
|
|
3967
3530
|
*/
|
|
@@ -3982,28 +3545,6 @@ export interface RemoveAssistantAIAgentRequest {
|
|
|
3982
3545
|
*/
|
|
3983
3546
|
export interface RemoveAssistantAIAgentResponse {
|
|
3984
3547
|
}
|
|
3985
|
-
/**
|
|
3986
|
-
* @public
|
|
3987
|
-
* @enum
|
|
3988
|
-
*/
|
|
3989
|
-
export declare const FilterField: {
|
|
3990
|
-
readonly NAME: "NAME";
|
|
3991
|
-
};
|
|
3992
|
-
/**
|
|
3993
|
-
* @public
|
|
3994
|
-
*/
|
|
3995
|
-
export type FilterField = (typeof FilterField)[keyof typeof FilterField];
|
|
3996
|
-
/**
|
|
3997
|
-
* @public
|
|
3998
|
-
* @enum
|
|
3999
|
-
*/
|
|
4000
|
-
export declare const FilterOperator: {
|
|
4001
|
-
readonly EQUALS: "EQUALS";
|
|
4002
|
-
};
|
|
4003
|
-
/**
|
|
4004
|
-
* @public
|
|
4005
|
-
*/
|
|
4006
|
-
export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
|
|
4007
3548
|
/**
|
|
4008
3549
|
* <p>A search filter.</p>
|
|
4009
3550
|
* @public
|
|
@@ -4288,32 +3829,6 @@ export interface RuntimeSessionData {
|
|
|
4288
3829
|
*/
|
|
4289
3830
|
value: RuntimeSessionDataValue | undefined;
|
|
4290
3831
|
}
|
|
4291
|
-
/**
|
|
4292
|
-
* @public
|
|
4293
|
-
* @enum
|
|
4294
|
-
*/
|
|
4295
|
-
export declare const ConversationStatusReason: {
|
|
4296
|
-
readonly FAILED: "FAILED";
|
|
4297
|
-
readonly REJECTED: "REJECTED";
|
|
4298
|
-
readonly SUCCESS: "SUCCESS";
|
|
4299
|
-
};
|
|
4300
|
-
/**
|
|
4301
|
-
* @public
|
|
4302
|
-
*/
|
|
4303
|
-
export type ConversationStatusReason = (typeof ConversationStatusReason)[keyof typeof ConversationStatusReason];
|
|
4304
|
-
/**
|
|
4305
|
-
* @public
|
|
4306
|
-
* @enum
|
|
4307
|
-
*/
|
|
4308
|
-
export declare const ConversationStatus: {
|
|
4309
|
-
readonly CLOSED: "CLOSED";
|
|
4310
|
-
readonly PROCESSING: "PROCESSING";
|
|
4311
|
-
readonly READY: "READY";
|
|
4312
|
-
};
|
|
4313
|
-
/**
|
|
4314
|
-
* @public
|
|
4315
|
-
*/
|
|
4316
|
-
export type ConversationStatus = (typeof ConversationStatus)[keyof typeof ConversationStatus];
|
|
4317
3832
|
/**
|
|
4318
3833
|
* <p>The conversation state associated to a message.</p>
|
|
4319
3834
|
* @public
|
|
@@ -4330,19 +3845,6 @@ export interface ConversationState {
|
|
|
4330
3845
|
*/
|
|
4331
3846
|
reason?: ConversationStatusReason | undefined;
|
|
4332
3847
|
}
|
|
4333
|
-
/**
|
|
4334
|
-
* @public
|
|
4335
|
-
* @enum
|
|
4336
|
-
*/
|
|
4337
|
-
export declare const Participant: {
|
|
4338
|
-
readonly AGENT: "AGENT";
|
|
4339
|
-
readonly BOT: "BOT";
|
|
4340
|
-
readonly CUSTOMER: "CUSTOMER";
|
|
4341
|
-
};
|
|
4342
|
-
/**
|
|
4343
|
-
* @public
|
|
4344
|
-
*/
|
|
4345
|
-
export type Participant = (typeof Participant)[keyof typeof Participant];
|
|
4346
3848
|
/**
|
|
4347
3849
|
* <p>The message data in text type.</p>
|
|
4348
3850
|
* @public
|
|
@@ -4413,17 +3915,6 @@ export interface MessageOutput {
|
|
|
4413
3915
|
*/
|
|
4414
3916
|
timestamp: Date | undefined;
|
|
4415
3917
|
}
|
|
4416
|
-
/**
|
|
4417
|
-
* @public
|
|
4418
|
-
* @enum
|
|
4419
|
-
*/
|
|
4420
|
-
export declare const MessageType: {
|
|
4421
|
-
readonly TEXT: "TEXT";
|
|
4422
|
-
};
|
|
4423
|
-
/**
|
|
4424
|
-
* @public
|
|
4425
|
-
*/
|
|
4426
|
-
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
4427
3918
|
/**
|
|
4428
3919
|
* @public
|
|
4429
3920
|
*/
|
|
@@ -4678,17 +4169,6 @@ export interface UpdateSessionResponse {
|
|
|
4678
4169
|
*/
|
|
4679
4170
|
session?: SessionData | undefined;
|
|
4680
4171
|
}
|
|
4681
|
-
/**
|
|
4682
|
-
* @public
|
|
4683
|
-
* @enum
|
|
4684
|
-
*/
|
|
4685
|
-
export declare const SessionDataNamespace: {
|
|
4686
|
-
readonly Custom: "Custom";
|
|
4687
|
-
};
|
|
4688
|
-
/**
|
|
4689
|
-
* @public
|
|
4690
|
-
*/
|
|
4691
|
-
export type SessionDataNamespace = (typeof SessionDataNamespace)[keyof typeof SessionDataNamespace];
|
|
4692
4172
|
/**
|
|
4693
4173
|
* @public
|
|
4694
4174
|
*/
|
|
@@ -4796,34 +4276,6 @@ export interface BedrockFoundationModelConfigurationForParsing {
|
|
|
4796
4276
|
*/
|
|
4797
4277
|
parsingPrompt?: ParsingPrompt | undefined;
|
|
4798
4278
|
}
|
|
4799
|
-
/**
|
|
4800
|
-
* @public
|
|
4801
|
-
* @enum
|
|
4802
|
-
*/
|
|
4803
|
-
export declare const ChannelSubtype: {
|
|
4804
|
-
readonly EMAIL: "EMAIL";
|
|
4805
|
-
readonly PUSH: "PUSH";
|
|
4806
|
-
readonly SMS: "SMS";
|
|
4807
|
-
readonly WHATSAPP: "WHATSAPP";
|
|
4808
|
-
};
|
|
4809
|
-
/**
|
|
4810
|
-
* @public
|
|
4811
|
-
*/
|
|
4812
|
-
export type ChannelSubtype = (typeof ChannelSubtype)[keyof typeof ChannelSubtype];
|
|
4813
|
-
/**
|
|
4814
|
-
* @public
|
|
4815
|
-
* @enum
|
|
4816
|
-
*/
|
|
4817
|
-
export declare const ChunkingStrategy: {
|
|
4818
|
-
readonly FIXED_SIZE: "FIXED_SIZE";
|
|
4819
|
-
readonly HIERARCHICAL: "HIERARCHICAL";
|
|
4820
|
-
readonly NONE: "NONE";
|
|
4821
|
-
readonly SEMANTIC: "SEMANTIC";
|
|
4822
|
-
};
|
|
4823
|
-
/**
|
|
4824
|
-
* @public
|
|
4825
|
-
*/
|
|
4826
|
-
export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
|
|
4827
4279
|
/**
|
|
4828
4280
|
* <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
4829
4281
|
* @public
|
|
@@ -4991,17 +4443,6 @@ export declare namespace ContentAssociationContents {
|
|
|
4991
4443
|
_: (name: string, value: any) => T;
|
|
4992
4444
|
}
|
|
4993
4445
|
}
|
|
4994
|
-
/**
|
|
4995
|
-
* @public
|
|
4996
|
-
* @enum
|
|
4997
|
-
*/
|
|
4998
|
-
export declare const ContentAssociationType: {
|
|
4999
|
-
readonly AMAZON_CONNECT_GUIDE: "AMAZON_CONNECT_GUIDE";
|
|
5000
|
-
};
|
|
5001
|
-
/**
|
|
5002
|
-
* @public
|
|
5003
|
-
*/
|
|
5004
|
-
export type ContentAssociationType = (typeof ContentAssociationType)[keyof typeof ContentAssociationType];
|
|
5005
4446
|
/**
|
|
5006
4447
|
* @public
|
|
5007
4448
|
*/
|
|
@@ -5289,23 +4730,6 @@ export interface CreateContentRequest {
|
|
|
5289
4730
|
*/
|
|
5290
4731
|
tags?: Record<string, string> | undefined;
|
|
5291
4732
|
}
|
|
5292
|
-
/**
|
|
5293
|
-
* @public
|
|
5294
|
-
* @enum
|
|
5295
|
-
*/
|
|
5296
|
-
export declare const ContentStatus: {
|
|
5297
|
-
readonly ACTIVE: "ACTIVE";
|
|
5298
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
5299
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
5300
|
-
readonly DELETED: "DELETED";
|
|
5301
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
5302
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
5303
|
-
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
5304
|
-
};
|
|
5305
|
-
/**
|
|
5306
|
-
* @public
|
|
5307
|
-
*/
|
|
5308
|
-
export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
|
|
5309
4733
|
/**
|
|
5310
4734
|
* <p>Information about the content.</p>
|
|
5311
4735
|
* @public
|
|
@@ -5614,33 +5038,7 @@ export interface UpdateContentResponse {
|
|
|
5614
5038
|
content?: ContentData | undefined;
|
|
5615
5039
|
}
|
|
5616
5040
|
/**
|
|
5617
|
-
*
|
|
5618
|
-
* @enum
|
|
5619
|
-
*/
|
|
5620
|
-
export declare const ContentDisposition: {
|
|
5621
|
-
readonly ATTACHMENT: "ATTACHMENT";
|
|
5622
|
-
};
|
|
5623
|
-
/**
|
|
5624
|
-
* @public
|
|
5625
|
-
*/
|
|
5626
|
-
export type ContentDisposition = (typeof ContentDisposition)[keyof typeof ContentDisposition];
|
|
5627
|
-
/**
|
|
5628
|
-
* @public
|
|
5629
|
-
* @enum
|
|
5630
|
-
*/
|
|
5631
|
-
export declare const KnowledgeBaseType: {
|
|
5632
|
-
readonly CUSTOM: "CUSTOM";
|
|
5633
|
-
readonly EXTERNAL: "EXTERNAL";
|
|
5634
|
-
readonly MANAGED: "MANAGED";
|
|
5635
|
-
readonly MESSAGE_TEMPLATES: "MESSAGE_TEMPLATES";
|
|
5636
|
-
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
5637
|
-
};
|
|
5638
|
-
/**
|
|
5639
|
-
* @public
|
|
5640
|
-
*/
|
|
5641
|
-
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
5642
|
-
/**
|
|
5643
|
-
* <p>Information about how to render the content.</p>
|
|
5041
|
+
* <p>Information about how to render the content.</p>
|
|
5644
5042
|
* @public
|
|
5645
5043
|
*/
|
|
5646
5044
|
export interface RenderingConfiguration {
|
|
@@ -5661,18 +5059,6 @@ export interface WebCrawlerLimits {
|
|
|
5661
5059
|
*/
|
|
5662
5060
|
rateLimit?: number | undefined;
|
|
5663
5061
|
}
|
|
5664
|
-
/**
|
|
5665
|
-
* @public
|
|
5666
|
-
* @enum
|
|
5667
|
-
*/
|
|
5668
|
-
export declare const WebScopeType: {
|
|
5669
|
-
readonly HOST_ONLY: "HOST_ONLY";
|
|
5670
|
-
readonly SUBDOMAINS: "SUBDOMAINS";
|
|
5671
|
-
};
|
|
5672
|
-
/**
|
|
5673
|
-
* @public
|
|
5674
|
-
*/
|
|
5675
|
-
export type WebScopeType = (typeof WebScopeType)[keyof typeof WebScopeType];
|
|
5676
5062
|
/**
|
|
5677
5063
|
* <p>A URL for crawling.</p>
|
|
5678
5064
|
* @public
|
|
@@ -5804,17 +5190,6 @@ export declare namespace SourceConfiguration {
|
|
|
5804
5190
|
_: (name: string, value: any) => T;
|
|
5805
5191
|
}
|
|
5806
5192
|
}
|
|
5807
|
-
/**
|
|
5808
|
-
* @public
|
|
5809
|
-
* @enum
|
|
5810
|
-
*/
|
|
5811
|
-
export declare const ParsingStrategy: {
|
|
5812
|
-
readonly BEDROCK_FOUNDATION_MODEL: "BEDROCK_FOUNDATION_MODEL";
|
|
5813
|
-
};
|
|
5814
|
-
/**
|
|
5815
|
-
* @public
|
|
5816
|
-
*/
|
|
5817
|
-
export type ParsingStrategy = (typeof ParsingStrategy)[keyof typeof ParsingStrategy];
|
|
5818
5193
|
/**
|
|
5819
5194
|
* <p>Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.</p>
|
|
5820
5195
|
* @public
|
|
@@ -5897,36 +5272,6 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
5897
5272
|
*/
|
|
5898
5273
|
tags?: Record<string, string> | undefined;
|
|
5899
5274
|
}
|
|
5900
|
-
/**
|
|
5901
|
-
* @public
|
|
5902
|
-
* @enum
|
|
5903
|
-
*/
|
|
5904
|
-
export declare const SyncStatus: {
|
|
5905
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
5906
|
-
readonly SYNCING_IN_PROGRESS: "SYNCING_IN_PROGRESS";
|
|
5907
|
-
readonly SYNC_FAILED: "SYNC_FAILED";
|
|
5908
|
-
readonly SYNC_SUCCESS: "SYNC_SUCCESS";
|
|
5909
|
-
};
|
|
5910
|
-
/**
|
|
5911
|
-
* @public
|
|
5912
|
-
*/
|
|
5913
|
-
export type SyncStatus = (typeof SyncStatus)[keyof typeof SyncStatus];
|
|
5914
|
-
/**
|
|
5915
|
-
* @public
|
|
5916
|
-
* @enum
|
|
5917
|
-
*/
|
|
5918
|
-
export declare const KnowledgeBaseStatus: {
|
|
5919
|
-
readonly ACTIVE: "ACTIVE";
|
|
5920
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
5921
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
5922
|
-
readonly DELETED: "DELETED";
|
|
5923
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
5924
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
5925
|
-
};
|
|
5926
|
-
/**
|
|
5927
|
-
* @public
|
|
5928
|
-
*/
|
|
5929
|
-
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
5930
5275
|
/**
|
|
5931
5276
|
* <p>Information about the knowledge base.</p>
|
|
5932
5277
|
* @public
|
|
@@ -6099,19 +5444,6 @@ export interface EmailMessageTemplateContent {
|
|
|
6099
5444
|
*/
|
|
6100
5445
|
headers?: EmailHeader[] | undefined;
|
|
6101
5446
|
}
|
|
6102
|
-
/**
|
|
6103
|
-
* @public
|
|
6104
|
-
* @enum
|
|
6105
|
-
*/
|
|
6106
|
-
export declare const PushMessageAction: {
|
|
6107
|
-
readonly DEEP_LINK: "DEEP_LINK";
|
|
6108
|
-
readonly OPEN_APP: "OPEN_APP";
|
|
6109
|
-
readonly URL: "URL";
|
|
6110
|
-
};
|
|
6111
|
-
/**
|
|
6112
|
-
* @public
|
|
6113
|
-
*/
|
|
6114
|
-
export type PushMessageAction = (typeof PushMessageAction)[keyof typeof PushMessageAction];
|
|
6115
5447
|
/**
|
|
6116
5448
|
* <p>The content of the push message template that applies to ADM (Amazon Device Messaging) notification service.</p>
|
|
6117
5449
|
* @public
|
|
@@ -6924,30 +6256,1394 @@ export interface CreateMessageTemplateRequest {
|
|
|
6924
6256
|
*/
|
|
6925
6257
|
tags?: Record<string, string> | undefined;
|
|
6926
6258
|
}
|
|
6259
|
+
/**
|
|
6260
|
+
* <p>Configuration information about the external data source.</p>
|
|
6261
|
+
* @public
|
|
6262
|
+
*/
|
|
6263
|
+
export interface WhatsAppMessageTemplateSourceConfigurationSummary {
|
|
6264
|
+
/**
|
|
6265
|
+
* <p>The ID of the End User Messaging WhatsApp Business Account to associate with this template.</p>
|
|
6266
|
+
* @public
|
|
6267
|
+
*/
|
|
6268
|
+
businessAccountId: string | undefined;
|
|
6269
|
+
/**
|
|
6270
|
+
* <p>The ID of WhatsApp template.</p>
|
|
6271
|
+
* @public
|
|
6272
|
+
*/
|
|
6273
|
+
templateId: string | undefined;
|
|
6274
|
+
/**
|
|
6275
|
+
* <p>The name of the WhatsApp template.</p>
|
|
6276
|
+
* @public
|
|
6277
|
+
*/
|
|
6278
|
+
name?: string | undefined;
|
|
6279
|
+
/**
|
|
6280
|
+
* <p>The language of the WhatsApp template.</p>
|
|
6281
|
+
* @public
|
|
6282
|
+
*/
|
|
6283
|
+
language?: string | undefined;
|
|
6284
|
+
/**
|
|
6285
|
+
* <p>The list of component mapping from WhatsApp template parameters to Message Template attributes.</p>
|
|
6286
|
+
* @public
|
|
6287
|
+
*/
|
|
6288
|
+
components?: string[] | undefined;
|
|
6289
|
+
/**
|
|
6290
|
+
* <p>The status of the message template.</p>
|
|
6291
|
+
* @public
|
|
6292
|
+
*/
|
|
6293
|
+
status?: WhatsAppSourceConfigurationStatus | undefined;
|
|
6294
|
+
/**
|
|
6295
|
+
* <p>The status reason of the message template.</p>
|
|
6296
|
+
* @public
|
|
6297
|
+
*/
|
|
6298
|
+
statusReason?: string | undefined;
|
|
6299
|
+
}
|
|
6300
|
+
/**
|
|
6301
|
+
* <p>The container of message template source configuration summary.</p>
|
|
6302
|
+
* @public
|
|
6303
|
+
*/
|
|
6304
|
+
export type MessageTemplateSourceConfigurationSummary = MessageTemplateSourceConfigurationSummary.WhatsAppMember | MessageTemplateSourceConfigurationSummary.$UnknownMember;
|
|
6305
|
+
/**
|
|
6306
|
+
* @public
|
|
6307
|
+
*/
|
|
6308
|
+
export declare namespace MessageTemplateSourceConfigurationSummary {
|
|
6309
|
+
/**
|
|
6310
|
+
* <p>The sourceConfiguration summary of the message template that applies to the WHATSAPP channel subtype.</p>
|
|
6311
|
+
* @public
|
|
6312
|
+
*/
|
|
6313
|
+
interface WhatsAppMember {
|
|
6314
|
+
whatsApp: WhatsAppMessageTemplateSourceConfigurationSummary;
|
|
6315
|
+
$unknown?: never;
|
|
6316
|
+
}
|
|
6317
|
+
/**
|
|
6318
|
+
* @public
|
|
6319
|
+
*/
|
|
6320
|
+
interface $UnknownMember {
|
|
6321
|
+
whatsApp?: never;
|
|
6322
|
+
$unknown: [string, any];
|
|
6323
|
+
}
|
|
6324
|
+
/**
|
|
6325
|
+
* @deprecated unused in schema-serde mode.
|
|
6326
|
+
*
|
|
6327
|
+
*/
|
|
6328
|
+
interface Visitor<T> {
|
|
6329
|
+
whatsApp: (value: WhatsAppMessageTemplateSourceConfigurationSummary) => T;
|
|
6330
|
+
_: (name: string, value: any) => T;
|
|
6331
|
+
}
|
|
6332
|
+
}
|
|
6333
|
+
/**
|
|
6334
|
+
* <p>The data of a message template.</p>
|
|
6335
|
+
* @public
|
|
6336
|
+
*/
|
|
6337
|
+
export interface MessageTemplateData {
|
|
6338
|
+
/**
|
|
6339
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
6340
|
+
* @public
|
|
6341
|
+
*/
|
|
6342
|
+
messageTemplateArn: string | undefined;
|
|
6343
|
+
/**
|
|
6344
|
+
* <p>The identifier of the message template.</p>
|
|
6345
|
+
* @public
|
|
6346
|
+
*/
|
|
6347
|
+
messageTemplateId: string | undefined;
|
|
6348
|
+
/**
|
|
6349
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
6350
|
+
* @public
|
|
6351
|
+
*/
|
|
6352
|
+
knowledgeBaseArn: string | undefined;
|
|
6353
|
+
/**
|
|
6354
|
+
* <p>The identifier of the knowledge base.</p>
|
|
6355
|
+
* @public
|
|
6356
|
+
*/
|
|
6357
|
+
knowledgeBaseId: string | undefined;
|
|
6358
|
+
/**
|
|
6359
|
+
* <p>The name of the message template.</p>
|
|
6360
|
+
* @public
|
|
6361
|
+
*/
|
|
6362
|
+
name: string | undefined;
|
|
6363
|
+
/**
|
|
6364
|
+
* <p>The channel of the message template.</p>
|
|
6365
|
+
* @public
|
|
6366
|
+
*/
|
|
6367
|
+
channel?: string | undefined;
|
|
6368
|
+
/**
|
|
6369
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
6370
|
+
* @public
|
|
6371
|
+
*/
|
|
6372
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
6373
|
+
/**
|
|
6374
|
+
* <p>The timestamp when the message template was created.</p>
|
|
6375
|
+
* @public
|
|
6376
|
+
*/
|
|
6377
|
+
createdTime: Date | undefined;
|
|
6378
|
+
/**
|
|
6379
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
6380
|
+
* @public
|
|
6381
|
+
*/
|
|
6382
|
+
lastModifiedTime: Date | undefined;
|
|
6383
|
+
/**
|
|
6384
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
6385
|
+
* @public
|
|
6386
|
+
*/
|
|
6387
|
+
lastModifiedBy: string | undefined;
|
|
6388
|
+
/**
|
|
6389
|
+
* <p>The content of the message template.</p>
|
|
6390
|
+
* @public
|
|
6391
|
+
*/
|
|
6392
|
+
content?: MessageTemplateContentProvider | undefined;
|
|
6393
|
+
/**
|
|
6394
|
+
* <p>The description of the message template.</p>
|
|
6395
|
+
* @public
|
|
6396
|
+
*/
|
|
6397
|
+
description?: string | undefined;
|
|
6398
|
+
/**
|
|
6399
|
+
* <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>
|
|
6400
|
+
* @public
|
|
6401
|
+
*/
|
|
6402
|
+
language?: string | undefined;
|
|
6403
|
+
/**
|
|
6404
|
+
* <p>The source configuration summary of the message template.</p>
|
|
6405
|
+
* @public
|
|
6406
|
+
*/
|
|
6407
|
+
sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
|
|
6408
|
+
/**
|
|
6409
|
+
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
6410
|
+
* @public
|
|
6411
|
+
*/
|
|
6412
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6413
|
+
/**
|
|
6414
|
+
* <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>
|
|
6415
|
+
* @public
|
|
6416
|
+
*/
|
|
6417
|
+
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
6418
|
+
/**
|
|
6419
|
+
* <p>The types of attributes that the message template contains.</p>
|
|
6420
|
+
* @public
|
|
6421
|
+
*/
|
|
6422
|
+
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
6423
|
+
/**
|
|
6424
|
+
* <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>
|
|
6425
|
+
* @public
|
|
6426
|
+
*/
|
|
6427
|
+
messageTemplateContentSha256: string | undefined;
|
|
6428
|
+
/**
|
|
6429
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6430
|
+
* @public
|
|
6431
|
+
*/
|
|
6432
|
+
tags?: Record<string, string> | undefined;
|
|
6433
|
+
}
|
|
6434
|
+
/**
|
|
6435
|
+
* @public
|
|
6436
|
+
*/
|
|
6437
|
+
export interface CreateMessageTemplateResponse {
|
|
6438
|
+
/**
|
|
6439
|
+
* <p>The message template.</p>
|
|
6440
|
+
* @public
|
|
6441
|
+
*/
|
|
6442
|
+
messageTemplate?: MessageTemplateData | undefined;
|
|
6443
|
+
}
|
|
6927
6444
|
/**
|
|
6928
6445
|
* @public
|
|
6929
|
-
* @enum
|
|
6930
6446
|
*/
|
|
6931
|
-
export
|
|
6932
|
-
|
|
6933
|
-
|
|
6934
|
-
|
|
6935
|
-
|
|
6936
|
-
|
|
6447
|
+
export interface CreateMessageTemplateAttachmentRequest {
|
|
6448
|
+
/**
|
|
6449
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6450
|
+
* @public
|
|
6451
|
+
*/
|
|
6452
|
+
knowledgeBaseId: string | undefined;
|
|
6453
|
+
/**
|
|
6454
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
6455
|
+
* @public
|
|
6456
|
+
*/
|
|
6457
|
+
messageTemplateId: string | undefined;
|
|
6458
|
+
/**
|
|
6459
|
+
* <p>The presentation information for the attachment file.</p>
|
|
6460
|
+
* @public
|
|
6461
|
+
*/
|
|
6462
|
+
contentDisposition: ContentDisposition | undefined;
|
|
6463
|
+
/**
|
|
6464
|
+
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
6465
|
+
* @public
|
|
6466
|
+
*/
|
|
6467
|
+
name: string | undefined;
|
|
6468
|
+
/**
|
|
6469
|
+
* <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
|
|
6470
|
+
* @public
|
|
6471
|
+
*/
|
|
6472
|
+
body: string | undefined;
|
|
6473
|
+
/**
|
|
6474
|
+
* <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>
|
|
6475
|
+
* @public
|
|
6476
|
+
*/
|
|
6477
|
+
clientToken?: string | undefined;
|
|
6478
|
+
}
|
|
6937
6479
|
/**
|
|
6480
|
+
* <p>Information about the message template attachment.</p>
|
|
6938
6481
|
* @public
|
|
6939
6482
|
*/
|
|
6940
|
-
export
|
|
6483
|
+
export interface MessageTemplateAttachment {
|
|
6484
|
+
/**
|
|
6485
|
+
* <p>The presentation information for the attachment file.</p>
|
|
6486
|
+
* @public
|
|
6487
|
+
*/
|
|
6488
|
+
contentDisposition: ContentDisposition | undefined;
|
|
6489
|
+
/**
|
|
6490
|
+
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
6491
|
+
* @public
|
|
6492
|
+
*/
|
|
6493
|
+
name: string | undefined;
|
|
6494
|
+
/**
|
|
6495
|
+
* <p>The timestamp when the attachment file was uploaded.</p>
|
|
6496
|
+
* @public
|
|
6497
|
+
*/
|
|
6498
|
+
uploadedTime: Date | undefined;
|
|
6499
|
+
/**
|
|
6500
|
+
* <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
|
|
6501
|
+
* @public
|
|
6502
|
+
*/
|
|
6503
|
+
url: string | undefined;
|
|
6504
|
+
/**
|
|
6505
|
+
* <p>The expiration time of the pre-signed Amazon S3 URL.</p>
|
|
6506
|
+
* @public
|
|
6507
|
+
*/
|
|
6508
|
+
urlExpiry: Date | undefined;
|
|
6509
|
+
/**
|
|
6510
|
+
* <p>The identifier of the attachment file.</p>
|
|
6511
|
+
* @public
|
|
6512
|
+
*/
|
|
6513
|
+
attachmentId: string | undefined;
|
|
6514
|
+
}
|
|
6941
6515
|
/**
|
|
6942
6516
|
* @public
|
|
6943
|
-
* @enum
|
|
6944
6517
|
*/
|
|
6945
|
-
export
|
|
6946
|
-
|
|
6947
|
-
|
|
6948
|
-
|
|
6949
|
-
|
|
6518
|
+
export interface CreateMessageTemplateAttachmentResponse {
|
|
6519
|
+
/**
|
|
6520
|
+
* <p>The message template attachment.</p>
|
|
6521
|
+
* @public
|
|
6522
|
+
*/
|
|
6523
|
+
attachment?: MessageTemplateAttachment | undefined;
|
|
6524
|
+
}
|
|
6950
6525
|
/**
|
|
6951
6526
|
* @public
|
|
6952
6527
|
*/
|
|
6953
|
-
export
|
|
6528
|
+
export interface CreateMessageTemplateVersionRequest {
|
|
6529
|
+
/**
|
|
6530
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6531
|
+
* @public
|
|
6532
|
+
*/
|
|
6533
|
+
knowledgeBaseId: string | undefined;
|
|
6534
|
+
/**
|
|
6535
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
6536
|
+
* @public
|
|
6537
|
+
*/
|
|
6538
|
+
messageTemplateId: string | undefined;
|
|
6539
|
+
/**
|
|
6540
|
+
* <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>
|
|
6541
|
+
* @public
|
|
6542
|
+
*/
|
|
6543
|
+
messageTemplateContentSha256?: string | undefined;
|
|
6544
|
+
}
|
|
6545
|
+
/**
|
|
6546
|
+
* <p>The extended data of a message template.</p>
|
|
6547
|
+
* @public
|
|
6548
|
+
*/
|
|
6549
|
+
export interface ExtendedMessageTemplateData {
|
|
6550
|
+
/**
|
|
6551
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
6552
|
+
* @public
|
|
6553
|
+
*/
|
|
6554
|
+
messageTemplateArn: string | undefined;
|
|
6555
|
+
/**
|
|
6556
|
+
* <p>The identifier of the message template.</p>
|
|
6557
|
+
* @public
|
|
6558
|
+
*/
|
|
6559
|
+
messageTemplateId: string | undefined;
|
|
6560
|
+
/**
|
|
6561
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
6562
|
+
* @public
|
|
6563
|
+
*/
|
|
6564
|
+
knowledgeBaseArn: string | undefined;
|
|
6565
|
+
/**
|
|
6566
|
+
* <p>The identifier of the knowledge base.</p>
|
|
6567
|
+
* @public
|
|
6568
|
+
*/
|
|
6569
|
+
knowledgeBaseId: string | undefined;
|
|
6570
|
+
/**
|
|
6571
|
+
* <p>The name of the message template.</p>
|
|
6572
|
+
* @public
|
|
6573
|
+
*/
|
|
6574
|
+
name: string | undefined;
|
|
6575
|
+
/**
|
|
6576
|
+
* <p>The channel of the message template.</p>
|
|
6577
|
+
* @public
|
|
6578
|
+
*/
|
|
6579
|
+
channel?: string | undefined;
|
|
6580
|
+
/**
|
|
6581
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
6582
|
+
* @public
|
|
6583
|
+
*/
|
|
6584
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
6585
|
+
/**
|
|
6586
|
+
* <p>The timestamp when the message template was created.</p>
|
|
6587
|
+
* @public
|
|
6588
|
+
*/
|
|
6589
|
+
createdTime: Date | undefined;
|
|
6590
|
+
/**
|
|
6591
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
6592
|
+
* @public
|
|
6593
|
+
*/
|
|
6594
|
+
lastModifiedTime: Date | undefined;
|
|
6595
|
+
/**
|
|
6596
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
6597
|
+
* @public
|
|
6598
|
+
*/
|
|
6599
|
+
lastModifiedBy: string | undefined;
|
|
6600
|
+
/**
|
|
6601
|
+
* <p>The content of the message template.</p>
|
|
6602
|
+
* @public
|
|
6603
|
+
*/
|
|
6604
|
+
content?: MessageTemplateContentProvider | undefined;
|
|
6605
|
+
/**
|
|
6606
|
+
* <p>The description of the message template.</p>
|
|
6607
|
+
* @public
|
|
6608
|
+
*/
|
|
6609
|
+
description?: string | undefined;
|
|
6610
|
+
/**
|
|
6611
|
+
* <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>
|
|
6612
|
+
* @public
|
|
6613
|
+
*/
|
|
6614
|
+
language?: string | undefined;
|
|
6615
|
+
/**
|
|
6616
|
+
* <p>The source configuration summary of the message template.</p>
|
|
6617
|
+
* @public
|
|
6618
|
+
*/
|
|
6619
|
+
sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
|
|
6620
|
+
/**
|
|
6621
|
+
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
6622
|
+
* @public
|
|
6623
|
+
*/
|
|
6624
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6625
|
+
/**
|
|
6626
|
+
* <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>
|
|
6627
|
+
* @public
|
|
6628
|
+
*/
|
|
6629
|
+
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
6630
|
+
/**
|
|
6631
|
+
* <p>The types of attributes contain the message template.</p>
|
|
6632
|
+
* @public
|
|
6633
|
+
*/
|
|
6634
|
+
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
6635
|
+
/**
|
|
6636
|
+
* <p>The message template attachments.</p>
|
|
6637
|
+
* @public
|
|
6638
|
+
*/
|
|
6639
|
+
attachments?: MessageTemplateAttachment[] | undefined;
|
|
6640
|
+
/**
|
|
6641
|
+
* <p>Whether the version of the message template is activated.</p>
|
|
6642
|
+
* @public
|
|
6643
|
+
*/
|
|
6644
|
+
isActive?: boolean | undefined;
|
|
6645
|
+
/**
|
|
6646
|
+
* <p>The version number of the message template version.</p>
|
|
6647
|
+
* @public
|
|
6648
|
+
*/
|
|
6649
|
+
versionNumber?: number | undefined;
|
|
6650
|
+
/**
|
|
6651
|
+
* <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>
|
|
6652
|
+
* @public
|
|
6653
|
+
*/
|
|
6654
|
+
messageTemplateContentSha256: string | undefined;
|
|
6655
|
+
/**
|
|
6656
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6657
|
+
* @public
|
|
6658
|
+
*/
|
|
6659
|
+
tags?: Record<string, string> | undefined;
|
|
6660
|
+
}
|
|
6661
|
+
/**
|
|
6662
|
+
* @public
|
|
6663
|
+
*/
|
|
6664
|
+
export interface CreateMessageTemplateVersionResponse {
|
|
6665
|
+
/**
|
|
6666
|
+
* <p>The message template.</p>
|
|
6667
|
+
* @public
|
|
6668
|
+
*/
|
|
6669
|
+
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
6670
|
+
}
|
|
6671
|
+
/**
|
|
6672
|
+
* <p>The container of quick response data.</p>
|
|
6673
|
+
* @public
|
|
6674
|
+
*/
|
|
6675
|
+
export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
|
|
6676
|
+
/**
|
|
6677
|
+
* @public
|
|
6678
|
+
*/
|
|
6679
|
+
export declare namespace QuickResponseDataProvider {
|
|
6680
|
+
/**
|
|
6681
|
+
* <p>The content of the quick response.</p>
|
|
6682
|
+
* @public
|
|
6683
|
+
*/
|
|
6684
|
+
interface ContentMember {
|
|
6685
|
+
content: string;
|
|
6686
|
+
$unknown?: never;
|
|
6687
|
+
}
|
|
6688
|
+
/**
|
|
6689
|
+
* @public
|
|
6690
|
+
*/
|
|
6691
|
+
interface $UnknownMember {
|
|
6692
|
+
content?: never;
|
|
6693
|
+
$unknown: [string, any];
|
|
6694
|
+
}
|
|
6695
|
+
/**
|
|
6696
|
+
* @deprecated unused in schema-serde mode.
|
|
6697
|
+
*
|
|
6698
|
+
*/
|
|
6699
|
+
interface Visitor<T> {
|
|
6700
|
+
content: (value: string) => T;
|
|
6701
|
+
_: (name: string, value: any) => T;
|
|
6702
|
+
}
|
|
6703
|
+
}
|
|
6704
|
+
/**
|
|
6705
|
+
* @public
|
|
6706
|
+
*/
|
|
6707
|
+
export interface CreateQuickResponseRequest {
|
|
6708
|
+
/**
|
|
6709
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6710
|
+
* @public
|
|
6711
|
+
*/
|
|
6712
|
+
knowledgeBaseId: string | undefined;
|
|
6713
|
+
/**
|
|
6714
|
+
* <p>The name of the quick response.</p>
|
|
6715
|
+
* @public
|
|
6716
|
+
*/
|
|
6717
|
+
name: string | undefined;
|
|
6718
|
+
/**
|
|
6719
|
+
* <p>The content of the quick response.</p>
|
|
6720
|
+
* @public
|
|
6721
|
+
*/
|
|
6722
|
+
content: QuickResponseDataProvider | undefined;
|
|
6723
|
+
/**
|
|
6724
|
+
* <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>
|
|
6725
|
+
* @public
|
|
6726
|
+
*/
|
|
6727
|
+
contentType?: string | undefined;
|
|
6728
|
+
/**
|
|
6729
|
+
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
6730
|
+
* @public
|
|
6731
|
+
*/
|
|
6732
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6733
|
+
/**
|
|
6734
|
+
* <p>The description of the quick response.</p>
|
|
6735
|
+
* @public
|
|
6736
|
+
*/
|
|
6737
|
+
description?: string | undefined;
|
|
6738
|
+
/**
|
|
6739
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base. </p>
|
|
6740
|
+
* @public
|
|
6741
|
+
*/
|
|
6742
|
+
shortcutKey?: string | undefined;
|
|
6743
|
+
/**
|
|
6744
|
+
* <p>Whether the quick response is active.</p>
|
|
6745
|
+
* @public
|
|
6746
|
+
*/
|
|
6747
|
+
isActive?: boolean | undefined;
|
|
6748
|
+
/**
|
|
6749
|
+
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
6750
|
+
* @public
|
|
6751
|
+
*/
|
|
6752
|
+
channels?: string[] | undefined;
|
|
6753
|
+
/**
|
|
6754
|
+
* <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>
|
|
6755
|
+
* @public
|
|
6756
|
+
*/
|
|
6757
|
+
language?: string | undefined;
|
|
6758
|
+
/**
|
|
6759
|
+
* <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>
|
|
6760
|
+
* @public
|
|
6761
|
+
*/
|
|
6762
|
+
clientToken?: string | undefined;
|
|
6763
|
+
/**
|
|
6764
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6765
|
+
* @public
|
|
6766
|
+
*/
|
|
6767
|
+
tags?: Record<string, string> | undefined;
|
|
6768
|
+
}
|
|
6769
|
+
/**
|
|
6770
|
+
* <p>The container quick response content.</p>
|
|
6771
|
+
* @public
|
|
6772
|
+
*/
|
|
6773
|
+
export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
|
|
6774
|
+
/**
|
|
6775
|
+
* @public
|
|
6776
|
+
*/
|
|
6777
|
+
export declare namespace QuickResponseContentProvider {
|
|
6778
|
+
/**
|
|
6779
|
+
* <p>The content of the quick response.</p>
|
|
6780
|
+
* @public
|
|
6781
|
+
*/
|
|
6782
|
+
interface ContentMember {
|
|
6783
|
+
content: string;
|
|
6784
|
+
$unknown?: never;
|
|
6785
|
+
}
|
|
6786
|
+
/**
|
|
6787
|
+
* @public
|
|
6788
|
+
*/
|
|
6789
|
+
interface $UnknownMember {
|
|
6790
|
+
content?: never;
|
|
6791
|
+
$unknown: [string, any];
|
|
6792
|
+
}
|
|
6793
|
+
/**
|
|
6794
|
+
* @deprecated unused in schema-serde mode.
|
|
6795
|
+
*
|
|
6796
|
+
*/
|
|
6797
|
+
interface Visitor<T> {
|
|
6798
|
+
content: (value: string) => T;
|
|
6799
|
+
_: (name: string, value: any) => T;
|
|
6800
|
+
}
|
|
6801
|
+
}
|
|
6802
|
+
/**
|
|
6803
|
+
* <p>The content of the quick response stored in different media types.</p>
|
|
6804
|
+
* @public
|
|
6805
|
+
*/
|
|
6806
|
+
export interface QuickResponseContents {
|
|
6807
|
+
/**
|
|
6808
|
+
* <p>The container quick response content.</p>
|
|
6809
|
+
* @public
|
|
6810
|
+
*/
|
|
6811
|
+
plainText?: QuickResponseContentProvider | undefined;
|
|
6812
|
+
/**
|
|
6813
|
+
* <p>The container quick response content.</p>
|
|
6814
|
+
* @public
|
|
6815
|
+
*/
|
|
6816
|
+
markdown?: QuickResponseContentProvider | undefined;
|
|
6817
|
+
}
|
|
6818
|
+
/**
|
|
6819
|
+
* <p>Information about the quick response.</p>
|
|
6820
|
+
* @public
|
|
6821
|
+
*/
|
|
6822
|
+
export interface QuickResponseData {
|
|
6823
|
+
/**
|
|
6824
|
+
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
6825
|
+
* @public
|
|
6826
|
+
*/
|
|
6827
|
+
quickResponseArn: string | undefined;
|
|
6828
|
+
/**
|
|
6829
|
+
* <p>The identifier of the quick response.</p>
|
|
6830
|
+
* @public
|
|
6831
|
+
*/
|
|
6832
|
+
quickResponseId: string | undefined;
|
|
6833
|
+
/**
|
|
6834
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
6835
|
+
* @public
|
|
6836
|
+
*/
|
|
6837
|
+
knowledgeBaseArn: string | undefined;
|
|
6838
|
+
/**
|
|
6839
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6840
|
+
* @public
|
|
6841
|
+
*/
|
|
6842
|
+
knowledgeBaseId: string | undefined;
|
|
6843
|
+
/**
|
|
6844
|
+
* <p>The name of the quick response.</p>
|
|
6845
|
+
* @public
|
|
6846
|
+
*/
|
|
6847
|
+
name: string | undefined;
|
|
6848
|
+
/**
|
|
6849
|
+
* <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p> </li> </ul>
|
|
6850
|
+
* @public
|
|
6851
|
+
*/
|
|
6852
|
+
contentType: string | undefined;
|
|
6853
|
+
/**
|
|
6854
|
+
* <p>The status of the quick response data.</p>
|
|
6855
|
+
* @public
|
|
6856
|
+
*/
|
|
6857
|
+
status: QuickResponseStatus | undefined;
|
|
6858
|
+
/**
|
|
6859
|
+
* <p>The timestamp when the quick response was created.</p>
|
|
6860
|
+
* @public
|
|
6861
|
+
*/
|
|
6862
|
+
createdTime: Date | undefined;
|
|
6863
|
+
/**
|
|
6864
|
+
* <p>The timestamp when the quick response data was last modified.</p>
|
|
6865
|
+
* @public
|
|
6866
|
+
*/
|
|
6867
|
+
lastModifiedTime: Date | undefined;
|
|
6868
|
+
/**
|
|
6869
|
+
* <p>The contents of the quick response.</p>
|
|
6870
|
+
* @public
|
|
6871
|
+
*/
|
|
6872
|
+
contents?: QuickResponseContents | undefined;
|
|
6873
|
+
/**
|
|
6874
|
+
* <p>The description of the quick response.</p>
|
|
6875
|
+
* @public
|
|
6876
|
+
*/
|
|
6877
|
+
description?: string | undefined;
|
|
6878
|
+
/**
|
|
6879
|
+
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
6880
|
+
* @public
|
|
6881
|
+
*/
|
|
6882
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6883
|
+
/**
|
|
6884
|
+
* <p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>
|
|
6885
|
+
* @public
|
|
6886
|
+
*/
|
|
6887
|
+
shortcutKey?: string | undefined;
|
|
6888
|
+
/**
|
|
6889
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
6890
|
+
* @public
|
|
6891
|
+
*/
|
|
6892
|
+
lastModifiedBy?: string | undefined;
|
|
6893
|
+
/**
|
|
6894
|
+
* <p>Whether the quick response is active.</p>
|
|
6895
|
+
* @public
|
|
6896
|
+
*/
|
|
6897
|
+
isActive?: boolean | undefined;
|
|
6898
|
+
/**
|
|
6899
|
+
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
6900
|
+
* @public
|
|
6901
|
+
*/
|
|
6902
|
+
channels?: string[] | undefined;
|
|
6903
|
+
/**
|
|
6904
|
+
* <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>
|
|
6905
|
+
* @public
|
|
6906
|
+
*/
|
|
6907
|
+
language?: string | undefined;
|
|
6908
|
+
/**
|
|
6909
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6910
|
+
* @public
|
|
6911
|
+
*/
|
|
6912
|
+
tags?: Record<string, string> | undefined;
|
|
6913
|
+
}
|
|
6914
|
+
/**
|
|
6915
|
+
* @public
|
|
6916
|
+
*/
|
|
6917
|
+
export interface CreateQuickResponseResponse {
|
|
6918
|
+
/**
|
|
6919
|
+
* <p>The quick response.</p>
|
|
6920
|
+
* @public
|
|
6921
|
+
*/
|
|
6922
|
+
quickResponse?: QuickResponseData | undefined;
|
|
6923
|
+
}
|
|
6924
|
+
/**
|
|
6925
|
+
* @public
|
|
6926
|
+
*/
|
|
6927
|
+
export interface DeactivateMessageTemplateRequest {
|
|
6928
|
+
/**
|
|
6929
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6930
|
+
* @public
|
|
6931
|
+
*/
|
|
6932
|
+
knowledgeBaseId: string | undefined;
|
|
6933
|
+
/**
|
|
6934
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
6935
|
+
* @public
|
|
6936
|
+
*/
|
|
6937
|
+
messageTemplateId: string | undefined;
|
|
6938
|
+
/**
|
|
6939
|
+
* <p>The version number of the message template version to deactivate.</p>
|
|
6940
|
+
* @public
|
|
6941
|
+
*/
|
|
6942
|
+
versionNumber: number | undefined;
|
|
6943
|
+
}
|
|
6944
|
+
/**
|
|
6945
|
+
* @public
|
|
6946
|
+
*/
|
|
6947
|
+
export interface DeactivateMessageTemplateResponse {
|
|
6948
|
+
/**
|
|
6949
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
6950
|
+
* @public
|
|
6951
|
+
*/
|
|
6952
|
+
messageTemplateArn: string | undefined;
|
|
6953
|
+
/**
|
|
6954
|
+
* <p>The identifier of the message template.</p>
|
|
6955
|
+
* @public
|
|
6956
|
+
*/
|
|
6957
|
+
messageTemplateId: string | undefined;
|
|
6958
|
+
/**
|
|
6959
|
+
* <p>The version number of the message template version that has been deactivated.</p>
|
|
6960
|
+
* @public
|
|
6961
|
+
*/
|
|
6962
|
+
versionNumber: number | undefined;
|
|
6963
|
+
}
|
|
6964
|
+
/**
|
|
6965
|
+
* @public
|
|
6966
|
+
*/
|
|
6967
|
+
export interface DeleteImportJobRequest {
|
|
6968
|
+
/**
|
|
6969
|
+
* <p>The identifier of the knowledge base.</p>
|
|
6970
|
+
* @public
|
|
6971
|
+
*/
|
|
6972
|
+
knowledgeBaseId: string | undefined;
|
|
6973
|
+
/**
|
|
6974
|
+
* <p>The identifier of the import job to be deleted.</p>
|
|
6975
|
+
* @public
|
|
6976
|
+
*/
|
|
6977
|
+
importJobId: string | undefined;
|
|
6978
|
+
}
|
|
6979
|
+
/**
|
|
6980
|
+
* @public
|
|
6981
|
+
*/
|
|
6982
|
+
export interface DeleteImportJobResponse {
|
|
6983
|
+
}
|
|
6984
|
+
/**
|
|
6985
|
+
* @public
|
|
6986
|
+
*/
|
|
6987
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
6988
|
+
/**
|
|
6989
|
+
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6990
|
+
* @public
|
|
6991
|
+
*/
|
|
6992
|
+
knowledgeBaseId: string | undefined;
|
|
6993
|
+
}
|
|
6994
|
+
/**
|
|
6995
|
+
* @public
|
|
6996
|
+
*/
|
|
6997
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
6998
|
+
}
|
|
6999
|
+
/**
|
|
7000
|
+
* @public
|
|
7001
|
+
*/
|
|
7002
|
+
export interface DeleteMessageTemplateRequest {
|
|
7003
|
+
/**
|
|
7004
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7005
|
+
* @public
|
|
7006
|
+
*/
|
|
7007
|
+
knowledgeBaseId: string | undefined;
|
|
7008
|
+
/**
|
|
7009
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7010
|
+
* @public
|
|
7011
|
+
*/
|
|
7012
|
+
messageTemplateId: string | undefined;
|
|
7013
|
+
}
|
|
7014
|
+
/**
|
|
7015
|
+
* @public
|
|
7016
|
+
*/
|
|
7017
|
+
export interface DeleteMessageTemplateResponse {
|
|
7018
|
+
}
|
|
7019
|
+
/**
|
|
7020
|
+
* @public
|
|
7021
|
+
*/
|
|
7022
|
+
export interface DeleteMessageTemplateAttachmentRequest {
|
|
7023
|
+
/**
|
|
7024
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7025
|
+
* @public
|
|
7026
|
+
*/
|
|
7027
|
+
knowledgeBaseId: string | undefined;
|
|
7028
|
+
/**
|
|
7029
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
7030
|
+
* @public
|
|
7031
|
+
*/
|
|
7032
|
+
messageTemplateId: string | undefined;
|
|
7033
|
+
/**
|
|
7034
|
+
* <p>The identifier of the attachment file.</p>
|
|
7035
|
+
* @public
|
|
7036
|
+
*/
|
|
7037
|
+
attachmentId: string | undefined;
|
|
7038
|
+
}
|
|
7039
|
+
/**
|
|
7040
|
+
* @public
|
|
7041
|
+
*/
|
|
7042
|
+
export interface DeleteMessageTemplateAttachmentResponse {
|
|
7043
|
+
}
|
|
7044
|
+
/**
|
|
7045
|
+
* @public
|
|
7046
|
+
*/
|
|
7047
|
+
export interface DeleteQuickResponseRequest {
|
|
7048
|
+
/**
|
|
7049
|
+
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
7050
|
+
* @public
|
|
7051
|
+
*/
|
|
7052
|
+
knowledgeBaseId: string | undefined;
|
|
7053
|
+
/**
|
|
7054
|
+
* <p>The identifier of the quick response to delete.</p>
|
|
7055
|
+
* @public
|
|
7056
|
+
*/
|
|
7057
|
+
quickResponseId: string | undefined;
|
|
7058
|
+
}
|
|
7059
|
+
/**
|
|
7060
|
+
* @public
|
|
7061
|
+
*/
|
|
7062
|
+
export interface DeleteQuickResponseResponse {
|
|
7063
|
+
}
|
|
7064
|
+
/**
|
|
7065
|
+
* <p>The configuration information of the external data source.</p>
|
|
7066
|
+
* @public
|
|
7067
|
+
*/
|
|
7068
|
+
export interface ExternalSourceConfiguration {
|
|
7069
|
+
/**
|
|
7070
|
+
* <p>The type of the external data source.</p>
|
|
7071
|
+
* @public
|
|
7072
|
+
*/
|
|
7073
|
+
source: ExternalSource | undefined;
|
|
7074
|
+
/**
|
|
7075
|
+
* <p>The configuration information of the external data source.</p>
|
|
7076
|
+
* @public
|
|
7077
|
+
*/
|
|
7078
|
+
configuration: Configuration | undefined;
|
|
7079
|
+
}
|
|
7080
|
+
/**
|
|
7081
|
+
* @public
|
|
7082
|
+
*/
|
|
7083
|
+
export interface GetImportJobRequest {
|
|
7084
|
+
/**
|
|
7085
|
+
* <p>The identifier of the import job to retrieve.</p>
|
|
7086
|
+
* @public
|
|
7087
|
+
*/
|
|
7088
|
+
importJobId: string | undefined;
|
|
7089
|
+
/**
|
|
7090
|
+
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
7091
|
+
* @public
|
|
7092
|
+
*/
|
|
7093
|
+
knowledgeBaseId: string | undefined;
|
|
7094
|
+
}
|
|
7095
|
+
/**
|
|
7096
|
+
* <p>Summary information about the import job.</p>
|
|
7097
|
+
* @public
|
|
7098
|
+
*/
|
|
7099
|
+
export interface ImportJobData {
|
|
7100
|
+
/**
|
|
7101
|
+
* <p>The identifier of the import job.</p>
|
|
7102
|
+
* @public
|
|
7103
|
+
*/
|
|
7104
|
+
importJobId: string | undefined;
|
|
7105
|
+
/**
|
|
7106
|
+
* <p>The identifier of the knowledge base.</p>
|
|
7107
|
+
* @public
|
|
7108
|
+
*/
|
|
7109
|
+
knowledgeBaseId: string | undefined;
|
|
7110
|
+
/**
|
|
7111
|
+
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
7112
|
+
* @public
|
|
7113
|
+
*/
|
|
7114
|
+
uploadId: string | undefined;
|
|
7115
|
+
/**
|
|
7116
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7117
|
+
* @public
|
|
7118
|
+
*/
|
|
7119
|
+
knowledgeBaseArn: string | undefined;
|
|
7120
|
+
/**
|
|
7121
|
+
* <p>The type of the import job.</p>
|
|
7122
|
+
* @public
|
|
7123
|
+
*/
|
|
7124
|
+
importJobType: ImportJobType | undefined;
|
|
7125
|
+
/**
|
|
7126
|
+
* <p>The status of the import job.</p>
|
|
7127
|
+
* @public
|
|
7128
|
+
*/
|
|
7129
|
+
status: ImportJobStatus | undefined;
|
|
7130
|
+
/**
|
|
7131
|
+
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
7132
|
+
* @public
|
|
7133
|
+
*/
|
|
7134
|
+
url: string | undefined;
|
|
7135
|
+
/**
|
|
7136
|
+
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
7137
|
+
* @public
|
|
7138
|
+
*/
|
|
7139
|
+
failedRecordReport?: string | undefined;
|
|
7140
|
+
/**
|
|
7141
|
+
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
7142
|
+
* @public
|
|
7143
|
+
*/
|
|
7144
|
+
urlExpiry: Date | undefined;
|
|
7145
|
+
/**
|
|
7146
|
+
* <p>The timestamp when the import job was created.</p>
|
|
7147
|
+
* @public
|
|
7148
|
+
*/
|
|
7149
|
+
createdTime: Date | undefined;
|
|
7150
|
+
/**
|
|
7151
|
+
* <p>The timestamp when the import job data was last modified.</p>
|
|
7152
|
+
* @public
|
|
7153
|
+
*/
|
|
7154
|
+
lastModifiedTime: Date | undefined;
|
|
7155
|
+
/**
|
|
7156
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
7157
|
+
* @public
|
|
7158
|
+
*/
|
|
7159
|
+
metadata?: Record<string, string> | undefined;
|
|
7160
|
+
/**
|
|
7161
|
+
* <p>The configuration information of the external data source.</p>
|
|
7162
|
+
* @public
|
|
7163
|
+
*/
|
|
7164
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
7165
|
+
}
|
|
7166
|
+
/**
|
|
7167
|
+
* @public
|
|
7168
|
+
*/
|
|
7169
|
+
export interface GetImportJobResponse {
|
|
7170
|
+
/**
|
|
7171
|
+
* <p>The import job.</p>
|
|
7172
|
+
* @public
|
|
7173
|
+
*/
|
|
7174
|
+
importJob?: ImportJobData | undefined;
|
|
7175
|
+
}
|
|
7176
|
+
/**
|
|
7177
|
+
* @public
|
|
7178
|
+
*/
|
|
7179
|
+
export interface GetKnowledgeBaseRequest {
|
|
7180
|
+
/**
|
|
7181
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7182
|
+
* @public
|
|
7183
|
+
*/
|
|
7184
|
+
knowledgeBaseId: string | undefined;
|
|
7185
|
+
}
|
|
7186
|
+
/**
|
|
7187
|
+
* @public
|
|
7188
|
+
*/
|
|
7189
|
+
export interface GetKnowledgeBaseResponse {
|
|
7190
|
+
/**
|
|
7191
|
+
* <p>The knowledge base.</p>
|
|
7192
|
+
* @public
|
|
7193
|
+
*/
|
|
7194
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
7195
|
+
}
|
|
7196
|
+
/**
|
|
7197
|
+
* @public
|
|
7198
|
+
*/
|
|
7199
|
+
export interface GetMessageTemplateRequest {
|
|
7200
|
+
/**
|
|
7201
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7202
|
+
* @public
|
|
7203
|
+
*/
|
|
7204
|
+
messageTemplateId: string | undefined;
|
|
7205
|
+
/**
|
|
7206
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7207
|
+
* @public
|
|
7208
|
+
*/
|
|
7209
|
+
knowledgeBaseId: string | undefined;
|
|
7210
|
+
}
|
|
7211
|
+
/**
|
|
7212
|
+
* @public
|
|
7213
|
+
*/
|
|
7214
|
+
export interface GetMessageTemplateResponse {
|
|
7215
|
+
/**
|
|
7216
|
+
* <p>The message template.</p>
|
|
7217
|
+
* @public
|
|
7218
|
+
*/
|
|
7219
|
+
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
7220
|
+
}
|
|
7221
|
+
/**
|
|
7222
|
+
* @public
|
|
7223
|
+
*/
|
|
7224
|
+
export interface GetQuickResponseRequest {
|
|
7225
|
+
/**
|
|
7226
|
+
* <p>The identifier of the quick response.</p>
|
|
7227
|
+
* @public
|
|
7228
|
+
*/
|
|
7229
|
+
quickResponseId: string | undefined;
|
|
7230
|
+
/**
|
|
7231
|
+
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
7232
|
+
* @public
|
|
7233
|
+
*/
|
|
7234
|
+
knowledgeBaseId: string | undefined;
|
|
7235
|
+
}
|
|
7236
|
+
/**
|
|
7237
|
+
* @public
|
|
7238
|
+
*/
|
|
7239
|
+
export interface GetQuickResponseResponse {
|
|
7240
|
+
/**
|
|
7241
|
+
* <p>The quick response.</p>
|
|
7242
|
+
* @public
|
|
7243
|
+
*/
|
|
7244
|
+
quickResponse?: QuickResponseData | undefined;
|
|
7245
|
+
}
|
|
7246
|
+
/**
|
|
7247
|
+
* <p>Summary information about the import job.</p>
|
|
7248
|
+
* @public
|
|
7249
|
+
*/
|
|
7250
|
+
export interface ImportJobSummary {
|
|
7251
|
+
/**
|
|
7252
|
+
* <p>The identifier of the import job.</p>
|
|
7253
|
+
* @public
|
|
7254
|
+
*/
|
|
7255
|
+
importJobId: string | undefined;
|
|
7256
|
+
/**
|
|
7257
|
+
* <p>The identifier of the knowledge base.</p>
|
|
7258
|
+
* @public
|
|
7259
|
+
*/
|
|
7260
|
+
knowledgeBaseId: string | undefined;
|
|
7261
|
+
/**
|
|
7262
|
+
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
7263
|
+
* @public
|
|
7264
|
+
*/
|
|
7265
|
+
uploadId: string | undefined;
|
|
7266
|
+
/**
|
|
7267
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7268
|
+
* @public
|
|
7269
|
+
*/
|
|
7270
|
+
knowledgeBaseArn: string | undefined;
|
|
7271
|
+
/**
|
|
7272
|
+
* <p>The type of import job.</p>
|
|
7273
|
+
* @public
|
|
7274
|
+
*/
|
|
7275
|
+
importJobType: ImportJobType | undefined;
|
|
7276
|
+
/**
|
|
7277
|
+
* <p>The status of the import job.</p>
|
|
7278
|
+
* @public
|
|
7279
|
+
*/
|
|
7280
|
+
status: ImportJobStatus | undefined;
|
|
7281
|
+
/**
|
|
7282
|
+
* <p>The timestamp when the import job was created.</p>
|
|
7283
|
+
* @public
|
|
7284
|
+
*/
|
|
7285
|
+
createdTime: Date | undefined;
|
|
7286
|
+
/**
|
|
7287
|
+
* <p>The timestamp when the import job was last modified.</p>
|
|
7288
|
+
* @public
|
|
7289
|
+
*/
|
|
7290
|
+
lastModifiedTime: Date | undefined;
|
|
7291
|
+
/**
|
|
7292
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
7293
|
+
* @public
|
|
7294
|
+
*/
|
|
7295
|
+
metadata?: Record<string, string> | undefined;
|
|
7296
|
+
/**
|
|
7297
|
+
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
7298
|
+
* @public
|
|
7299
|
+
*/
|
|
7300
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
7301
|
+
}
|
|
7302
|
+
/**
|
|
7303
|
+
* @public
|
|
7304
|
+
*/
|
|
7305
|
+
export interface ListImportJobsRequest {
|
|
7306
|
+
/**
|
|
7307
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7308
|
+
* @public
|
|
7309
|
+
*/
|
|
7310
|
+
nextToken?: string | undefined;
|
|
7311
|
+
/**
|
|
7312
|
+
* <p>The maximum number of results to return per page.</p>
|
|
7313
|
+
* @public
|
|
7314
|
+
*/
|
|
7315
|
+
maxResults?: number | undefined;
|
|
7316
|
+
/**
|
|
7317
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7318
|
+
* @public
|
|
7319
|
+
*/
|
|
7320
|
+
knowledgeBaseId: string | undefined;
|
|
7321
|
+
}
|
|
7322
|
+
/**
|
|
7323
|
+
* @public
|
|
7324
|
+
*/
|
|
7325
|
+
export interface ListImportJobsResponse {
|
|
7326
|
+
/**
|
|
7327
|
+
* <p>Summary information about the import jobs.</p>
|
|
7328
|
+
* @public
|
|
7329
|
+
*/
|
|
7330
|
+
importJobSummaries: ImportJobSummary[] | undefined;
|
|
7331
|
+
/**
|
|
7332
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7333
|
+
* @public
|
|
7334
|
+
*/
|
|
7335
|
+
nextToken?: string | undefined;
|
|
7336
|
+
}
|
|
7337
|
+
/**
|
|
7338
|
+
* @public
|
|
7339
|
+
*/
|
|
7340
|
+
export interface ListKnowledgeBasesRequest {
|
|
7341
|
+
/**
|
|
7342
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7343
|
+
* @public
|
|
7344
|
+
*/
|
|
7345
|
+
nextToken?: string | undefined;
|
|
7346
|
+
/**
|
|
7347
|
+
* <p>The maximum number of results to return per page.</p>
|
|
7348
|
+
* @public
|
|
7349
|
+
*/
|
|
7350
|
+
maxResults?: number | undefined;
|
|
7351
|
+
}
|
|
7352
|
+
/**
|
|
7353
|
+
* <p>Summary information about the knowledge base.</p>
|
|
7354
|
+
* @public
|
|
7355
|
+
*/
|
|
7356
|
+
export interface KnowledgeBaseSummary {
|
|
7357
|
+
/**
|
|
7358
|
+
* <p>The identifier of the knowledge base.</p>
|
|
7359
|
+
* @public
|
|
7360
|
+
*/
|
|
7361
|
+
knowledgeBaseId: string | undefined;
|
|
7362
|
+
/**
|
|
7363
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7364
|
+
* @public
|
|
7365
|
+
*/
|
|
7366
|
+
knowledgeBaseArn: string | undefined;
|
|
7367
|
+
/**
|
|
7368
|
+
* <p>The name of the knowledge base.</p>
|
|
7369
|
+
* @public
|
|
7370
|
+
*/
|
|
7371
|
+
name: string | undefined;
|
|
7372
|
+
/**
|
|
7373
|
+
* <p>The type of knowledge base.</p>
|
|
7374
|
+
* @public
|
|
7375
|
+
*/
|
|
7376
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
7377
|
+
/**
|
|
7378
|
+
* <p>The status of the knowledge base summary.</p>
|
|
7379
|
+
* @public
|
|
7380
|
+
*/
|
|
7381
|
+
status: KnowledgeBaseStatus | undefined;
|
|
7382
|
+
/**
|
|
7383
|
+
* <p>Configuration information about the external data source.</p>
|
|
7384
|
+
* @public
|
|
7385
|
+
*/
|
|
7386
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
7387
|
+
/**
|
|
7388
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
7389
|
+
* @public
|
|
7390
|
+
*/
|
|
7391
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
7392
|
+
/**
|
|
7393
|
+
* <p>Information about how to render the content.</p>
|
|
7394
|
+
* @public
|
|
7395
|
+
*/
|
|
7396
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
7397
|
+
/**
|
|
7398
|
+
* <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
|
|
7399
|
+
* @public
|
|
7400
|
+
*/
|
|
7401
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
7402
|
+
/**
|
|
7403
|
+
* <p>The description of the knowledge base.</p>
|
|
7404
|
+
* @public
|
|
7405
|
+
*/
|
|
7406
|
+
description?: string | undefined;
|
|
7407
|
+
/**
|
|
7408
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7409
|
+
* @public
|
|
7410
|
+
*/
|
|
7411
|
+
tags?: Record<string, string> | undefined;
|
|
7412
|
+
}
|
|
7413
|
+
/**
|
|
7414
|
+
* @public
|
|
7415
|
+
*/
|
|
7416
|
+
export interface ListKnowledgeBasesResponse {
|
|
7417
|
+
/**
|
|
7418
|
+
* <p>Information about the knowledge bases.</p>
|
|
7419
|
+
* @public
|
|
7420
|
+
*/
|
|
7421
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
7422
|
+
/**
|
|
7423
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7424
|
+
* @public
|
|
7425
|
+
*/
|
|
7426
|
+
nextToken?: string | undefined;
|
|
7427
|
+
}
|
|
7428
|
+
/**
|
|
7429
|
+
* @public
|
|
7430
|
+
*/
|
|
7431
|
+
export interface ListMessageTemplatesRequest {
|
|
7432
|
+
/**
|
|
7433
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7434
|
+
* @public
|
|
7435
|
+
*/
|
|
7436
|
+
nextToken?: string | undefined;
|
|
7437
|
+
/**
|
|
7438
|
+
* <p>The maximum number of results to return per page.</p>
|
|
7439
|
+
* @public
|
|
7440
|
+
*/
|
|
7441
|
+
maxResults?: number | undefined;
|
|
7442
|
+
/**
|
|
7443
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7444
|
+
* @public
|
|
7445
|
+
*/
|
|
7446
|
+
knowledgeBaseId: string | undefined;
|
|
7447
|
+
}
|
|
7448
|
+
/**
|
|
7449
|
+
* <p>The summary of the message template.</p>
|
|
7450
|
+
* @public
|
|
7451
|
+
*/
|
|
7452
|
+
export interface MessageTemplateSummary {
|
|
7453
|
+
/**
|
|
7454
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
7455
|
+
* @public
|
|
7456
|
+
*/
|
|
7457
|
+
messageTemplateArn: string | undefined;
|
|
7458
|
+
/**
|
|
7459
|
+
* <p>The identifier of the message template.</p>
|
|
7460
|
+
* @public
|
|
7461
|
+
*/
|
|
7462
|
+
messageTemplateId: string | undefined;
|
|
7463
|
+
/**
|
|
7464
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7465
|
+
* @public
|
|
7466
|
+
*/
|
|
7467
|
+
knowledgeBaseArn: string | undefined;
|
|
7468
|
+
/**
|
|
7469
|
+
* <p>The identifier of the knowledge base.</p>
|
|
7470
|
+
* @public
|
|
7471
|
+
*/
|
|
7472
|
+
knowledgeBaseId: string | undefined;
|
|
7473
|
+
/**
|
|
7474
|
+
* <p>The name of the message template.</p>
|
|
7475
|
+
* @public
|
|
7476
|
+
*/
|
|
7477
|
+
name: string | undefined;
|
|
7478
|
+
/**
|
|
7479
|
+
* <p>The channel this message template applies to.</p>
|
|
7480
|
+
* @public
|
|
7481
|
+
*/
|
|
7482
|
+
channel?: string | undefined;
|
|
7483
|
+
/**
|
|
7484
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
7485
|
+
* @public
|
|
7486
|
+
*/
|
|
7487
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
7488
|
+
/**
|
|
7489
|
+
* <p>The timestamp when the message template was created.</p>
|
|
7490
|
+
* @public
|
|
7491
|
+
*/
|
|
7492
|
+
createdTime: Date | undefined;
|
|
7493
|
+
/**
|
|
7494
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
7495
|
+
* @public
|
|
7496
|
+
*/
|
|
7497
|
+
lastModifiedTime: Date | undefined;
|
|
7498
|
+
/**
|
|
7499
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
7500
|
+
* @public
|
|
7501
|
+
*/
|
|
7502
|
+
lastModifiedBy: string | undefined;
|
|
7503
|
+
/**
|
|
7504
|
+
* <p>The container of message template source configuration.</p>
|
|
7505
|
+
* @public
|
|
7506
|
+
*/
|
|
7507
|
+
sourceConfiguration?: MessageTemplateSourceConfiguration | undefined;
|
|
7508
|
+
/**
|
|
7509
|
+
* <p>The version number of the message template version that is activated.</p>
|
|
7510
|
+
* @public
|
|
7511
|
+
*/
|
|
7512
|
+
activeVersionNumber?: number | undefined;
|
|
7513
|
+
/**
|
|
7514
|
+
* <p>The description of the message template.</p>
|
|
7515
|
+
* @public
|
|
7516
|
+
*/
|
|
7517
|
+
description?: string | undefined;
|
|
7518
|
+
/**
|
|
7519
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7520
|
+
* @public
|
|
7521
|
+
*/
|
|
7522
|
+
tags?: Record<string, string> | undefined;
|
|
7523
|
+
}
|
|
7524
|
+
/**
|
|
7525
|
+
* @public
|
|
7526
|
+
*/
|
|
7527
|
+
export interface ListMessageTemplatesResponse {
|
|
7528
|
+
/**
|
|
7529
|
+
* <p>Summary information about the message template.</p>
|
|
7530
|
+
* @public
|
|
7531
|
+
*/
|
|
7532
|
+
messageTemplateSummaries: MessageTemplateSummary[] | undefined;
|
|
7533
|
+
/**
|
|
7534
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7535
|
+
* @public
|
|
7536
|
+
*/
|
|
7537
|
+
nextToken?: string | undefined;
|
|
7538
|
+
}
|
|
7539
|
+
/**
|
|
7540
|
+
* @public
|
|
7541
|
+
*/
|
|
7542
|
+
export interface ListMessageTemplateVersionsRequest {
|
|
7543
|
+
/**
|
|
7544
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7545
|
+
* @public
|
|
7546
|
+
*/
|
|
7547
|
+
knowledgeBaseId: string | undefined;
|
|
7548
|
+
/**
|
|
7549
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
7550
|
+
* @public
|
|
7551
|
+
*/
|
|
7552
|
+
messageTemplateId: string | undefined;
|
|
7553
|
+
/**
|
|
7554
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7555
|
+
* @public
|
|
7556
|
+
*/
|
|
7557
|
+
nextToken?: string | undefined;
|
|
7558
|
+
/**
|
|
7559
|
+
* <p>The maximum number of results to return per page.</p>
|
|
7560
|
+
* @public
|
|
7561
|
+
*/
|
|
7562
|
+
maxResults?: number | undefined;
|
|
7563
|
+
}
|
|
7564
|
+
/**
|
|
7565
|
+
* <p>The summary of the message template version.</p>
|
|
7566
|
+
* @public
|
|
7567
|
+
*/
|
|
7568
|
+
export interface MessageTemplateVersionSummary {
|
|
7569
|
+
/**
|
|
7570
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
7571
|
+
* @public
|
|
7572
|
+
*/
|
|
7573
|
+
messageTemplateArn: string | undefined;
|
|
7574
|
+
/**
|
|
7575
|
+
* <p>The identifier of the message template.</p>
|
|
7576
|
+
* @public
|
|
7577
|
+
*/
|
|
7578
|
+
messageTemplateId: string | undefined;
|
|
7579
|
+
/**
|
|
7580
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7581
|
+
* @public
|
|
7582
|
+
*/
|
|
7583
|
+
knowledgeBaseArn: string | undefined;
|
|
7584
|
+
/**
|
|
7585
|
+
* <p>The identifier of the knowledge base.</p>
|
|
7586
|
+
* @public
|
|
7587
|
+
*/
|
|
7588
|
+
knowledgeBaseId: string | undefined;
|
|
7589
|
+
/**
|
|
7590
|
+
* <p>The name of the message template.</p>
|
|
7591
|
+
* @public
|
|
7592
|
+
*/
|
|
7593
|
+
name: string | undefined;
|
|
7594
|
+
/**
|
|
7595
|
+
* <p>The channel of the message template.</p>
|
|
7596
|
+
* @public
|
|
7597
|
+
*/
|
|
7598
|
+
channel?: string | undefined;
|
|
7599
|
+
/**
|
|
7600
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
7601
|
+
* @public
|
|
7602
|
+
*/
|
|
7603
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
7604
|
+
/**
|
|
7605
|
+
* <p>Whether the version of the message template is activated.</p>
|
|
7606
|
+
* @public
|
|
7607
|
+
*/
|
|
7608
|
+
isActive: boolean | undefined;
|
|
7609
|
+
/**
|
|
7610
|
+
* <p>The version number of the message template version.</p>
|
|
7611
|
+
* @public
|
|
7612
|
+
*/
|
|
7613
|
+
versionNumber: number | undefined;
|
|
7614
|
+
}
|
|
7615
|
+
/**
|
|
7616
|
+
* @public
|
|
7617
|
+
*/
|
|
7618
|
+
export interface ListMessageTemplateVersionsResponse {
|
|
7619
|
+
/**
|
|
7620
|
+
* <p>Summary information about the versions of a message template.</p>
|
|
7621
|
+
* @public
|
|
7622
|
+
*/
|
|
7623
|
+
messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
|
|
7624
|
+
/**
|
|
7625
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7626
|
+
* @public
|
|
7627
|
+
*/
|
|
7628
|
+
nextToken?: string | undefined;
|
|
7629
|
+
}
|
|
7630
|
+
/**
|
|
7631
|
+
* @public
|
|
7632
|
+
*/
|
|
7633
|
+
export interface RenderMessageTemplateRequest {
|
|
7634
|
+
/**
|
|
7635
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7636
|
+
* @public
|
|
7637
|
+
*/
|
|
7638
|
+
knowledgeBaseId: string | undefined;
|
|
7639
|
+
/**
|
|
7640
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7641
|
+
* @public
|
|
7642
|
+
*/
|
|
7643
|
+
messageTemplateId: string | undefined;
|
|
7644
|
+
/**
|
|
7645
|
+
* <p>An object that specifies the 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 value for that variable.</p>
|
|
7646
|
+
* @public
|
|
7647
|
+
*/
|
|
7648
|
+
attributes: MessageTemplateAttributes | undefined;
|
|
7649
|
+
}
|