@aws-sdk/client-connect 3.934.0 → 3.936.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.
Files changed (339) hide show
  1. package/dist-cjs/index.js +1326 -1328
  2. package/dist-es/index.js +2 -1
  3. package/dist-es/models/enums.js +1078 -0
  4. package/dist-es/models/errors.js +375 -0
  5. package/dist-es/models/models_0.js +1 -663
  6. package/dist-es/models/models_1.js +1 -538
  7. package/dist-es/models/models_2.js +1 -183
  8. package/dist-es/models/models_3.js +1 -72
  9. package/dist-es/schemas/schemas_0.js +1 -1
  10. package/dist-types/commands/CreateContactCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateViewCommand.d.ts +1 -2
  12. package/dist-types/commands/CreateViewVersionCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateVocabularyCommand.d.ts +1 -1
  14. package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteAttachedFileCommand.d.ts +1 -1
  16. package/dist-types/commands/DeleteContactEvaluationCommand.d.ts +1 -1
  17. package/dist-types/commands/DeleteContactFlowCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteContactFlowModuleCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteContactFlowVersionCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +1 -1
  22. package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +1 -1
  23. package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteInstanceCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
  26. package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +1 -1
  27. package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
  28. package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteQueueCommand.d.ts +1 -1
  30. package/dist-types/commands/DeleteQuickConnectCommand.d.ts +1 -1
  31. package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +1 -1
  32. package/dist-types/commands/DeleteRuleCommand.d.ts +1 -1
  33. package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +1 -1
  34. package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +1 -1
  35. package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
  36. package/dist-types/commands/DeleteUseCaseCommand.d.ts +1 -1
  37. package/dist-types/commands/DeleteUserCommand.d.ts +1 -1
  38. package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
  39. package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
  40. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -1
  41. package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -1
  42. package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -1
  43. package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
  44. package/dist-types/commands/DescribeContactCommand.d.ts +1 -1
  45. package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  46. package/dist-types/commands/ListBotsCommand.d.ts +1 -2
  47. package/dist-types/commands/ListContactEvaluationsCommand.d.ts +1 -1
  48. package/dist-types/commands/ListContactFlowModulesCommand.d.ts +1 -1
  49. package/dist-types/commands/ListContactFlowVersionsCommand.d.ts +1 -1
  50. package/dist-types/commands/ListContactFlowsCommand.d.ts +1 -1
  51. package/dist-types/commands/ListContactReferencesCommand.d.ts +1 -1
  52. package/dist-types/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
  53. package/dist-types/commands/ListEvaluationFormVersionsCommand.d.ts +1 -1
  54. package/dist-types/commands/ListEvaluationFormsCommand.d.ts +1 -1
  55. package/dist-types/commands/ListFlowAssociationsCommand.d.ts +1 -1
  56. package/dist-types/commands/ListHoursOfOperationOverridesCommand.d.ts +1 -1
  57. package/dist-types/commands/ListHoursOfOperationsCommand.d.ts +1 -1
  58. package/dist-types/commands/ListInstanceAttributesCommand.d.ts +1 -1
  59. package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
  60. package/dist-types/commands/ListInstancesCommand.d.ts +1 -1
  61. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  62. package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +1 -1
  63. package/dist-types/commands/ListLexBotsCommand.d.ts +1 -1
  64. package/dist-types/commands/ListPhoneNumbersCommand.d.ts +1 -1
  65. package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +1 -1
  66. package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +1 -1
  67. package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
  68. package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -1
  69. package/dist-types/commands/ListQueuesCommand.d.ts +1 -1
  70. package/dist-types/commands/ListQuickConnectsCommand.d.ts +1 -1
  71. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  72. package/dist-types/commands/ListRoutingProfileManualAssignmentQueuesCommand.d.ts +1 -1
  73. package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
  74. package/dist-types/commands/ListRoutingProfilesCommand.d.ts +1 -1
  75. package/dist-types/commands/ListRulesCommand.d.ts +1 -1
  76. package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -1
  77. package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
  78. package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -1
  79. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +1 -1
  80. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  81. package/dist-types/commands/ListTaskTemplatesCommand.d.ts +1 -1
  82. package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +2 -1
  83. package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
  84. package/dist-types/commands/SearchAgentStatusesCommand.d.ts +1 -2
  85. package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +1 -2
  86. package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -2
  87. package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -2
  88. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -2
  89. package/dist-types/commands/SearchEvaluationFormsCommand.d.ts +1 -2
  90. package/dist-types/commands/SearchHoursOfOperationOverridesCommand.d.ts +1 -2
  91. package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +1 -2
  92. package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +1 -2
  93. package/dist-types/commands/SearchPromptsCommand.d.ts +1 -2
  94. package/dist-types/commands/SearchQueuesCommand.d.ts +1 -2
  95. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +1 -2
  96. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +1 -2
  97. package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +1 -2
  98. package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +1 -2
  99. package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
  100. package/dist-types/commands/StartChatContactCommand.d.ts +1 -2
  101. package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
  102. package/dist-types/commands/StartScreenSharingCommand.d.ts +1 -1
  103. package/dist-types/commands/StartTaskContactCommand.d.ts +2 -1
  104. package/dist-types/commands/StartWebRTCContactCommand.d.ts +1 -1
  105. package/dist-types/commands/StopContactCommand.d.ts +1 -1
  106. package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -1
  107. package/dist-types/commands/StopContactStreamingCommand.d.ts +1 -1
  108. package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +1 -1
  109. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -1
  110. package/dist-types/commands/TagContactCommand.d.ts +1 -1
  111. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  112. package/dist-types/commands/TransferContactCommand.d.ts +1 -1
  113. package/dist-types/commands/UntagContactCommand.d.ts +1 -1
  114. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  115. package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -1
  116. package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
  117. package/dist-types/commands/UpdateContactAttributesCommand.d.ts +1 -1
  118. package/dist-types/commands/UpdateContactCommand.d.ts +2 -1
  119. package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +1 -1
  120. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  121. package/dist-types/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
  122. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  123. package/dist-types/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
  124. package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +1 -1
  125. package/dist-types/commands/UpdateContactRoutingDataCommand.d.ts +2 -1
  126. package/dist-types/commands/UpdateContactScheduleCommand.d.ts +1 -1
  127. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +1 -1
  128. package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +2 -1
  129. package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
  130. package/dist-types/commands/UpdateHoursOfOperationOverrideCommand.d.ts +1 -1
  131. package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
  132. package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
  133. package/dist-types/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
  134. package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +1 -1
  135. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
  136. package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
  137. package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
  138. package/dist-types/commands/UpdatePromptCommand.d.ts +1 -1
  139. package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
  140. package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
  141. package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -1
  142. package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
  143. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
  144. package/dist-types/commands/UpdateQueueStatusCommand.d.ts +1 -1
  145. package/dist-types/commands/UpdateQuickConnectConfigCommand.d.ts +1 -1
  146. package/dist-types/commands/UpdateQuickConnectNameCommand.d.ts +1 -1
  147. package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +1 -1
  148. package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
  149. package/dist-types/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
  150. package/dist-types/commands/UpdateRoutingProfileNameCommand.d.ts +1 -1
  151. package/dist-types/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
  152. package/dist-types/commands/UpdateRuleCommand.d.ts +1 -1
  153. package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +1 -1
  154. package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +1 -1
  155. package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
  156. package/dist-types/commands/UpdateUserHierarchyCommand.d.ts +1 -1
  157. package/dist-types/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
  158. package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  159. package/dist-types/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  160. package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  161. package/dist-types/commands/UpdateUserProficienciesCommand.d.ts +1 -1
  162. package/dist-types/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  163. package/dist-types/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  164. package/dist-types/commands/UpdateViewContentCommand.d.ts +1 -1
  165. package/dist-types/commands/UpdateViewMetadataCommand.d.ts +1 -1
  166. package/dist-types/index.d.ts +6 -1
  167. package/dist-types/models/enums.d.ts +2166 -0
  168. package/dist-types/models/errors.d.ts +406 -0
  169. package/dist-types/models/models_0.d.ts +1607 -1219
  170. package/dist-types/models/models_1.d.ts +6272 -5379
  171. package/dist-types/models/models_2.d.ts +4108 -3852
  172. package/dist-types/models/models_3.d.ts +4 -4113
  173. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +1 -1
  174. package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +1 -2
  175. package/dist-types/ts3.4/commands/CreateViewVersionCommand.d.ts +1 -1
  176. package/dist-types/ts3.4/commands/CreateVocabularyCommand.d.ts +1 -1
  177. package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  178. package/dist-types/ts3.4/commands/DeleteAttachedFileCommand.d.ts +1 -1
  179. package/dist-types/ts3.4/commands/DeleteContactEvaluationCommand.d.ts +1 -1
  180. package/dist-types/ts3.4/commands/DeleteContactFlowCommand.d.ts +1 -1
  181. package/dist-types/ts3.4/commands/DeleteContactFlowModuleCommand.d.ts +1 -1
  182. package/dist-types/ts3.4/commands/DeleteContactFlowVersionCommand.d.ts +1 -1
  183. package/dist-types/ts3.4/commands/DeleteEmailAddressCommand.d.ts +1 -1
  184. package/dist-types/ts3.4/commands/DeleteEvaluationFormCommand.d.ts +1 -1
  185. package/dist-types/ts3.4/commands/DeleteHoursOfOperationCommand.d.ts +1 -1
  186. package/dist-types/ts3.4/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
  187. package/dist-types/ts3.4/commands/DeleteInstanceCommand.d.ts +1 -1
  188. package/dist-types/ts3.4/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
  189. package/dist-types/ts3.4/commands/DeletePredefinedAttributeCommand.d.ts +1 -1
  190. package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
  191. package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -1
  192. package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +1 -1
  193. package/dist-types/ts3.4/commands/DeleteQuickConnectCommand.d.ts +1 -1
  194. package/dist-types/ts3.4/commands/DeleteRoutingProfileCommand.d.ts +1 -1
  195. package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts +1 -1
  196. package/dist-types/ts3.4/commands/DeleteSecurityProfileCommand.d.ts +1 -1
  197. package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +1 -1
  198. package/dist-types/ts3.4/commands/DeleteTrafficDistributionGroupCommand.d.ts +1 -1
  199. package/dist-types/ts3.4/commands/DeleteUseCaseCommand.d.ts +1 -1
  200. package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +1 -1
  201. package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
  202. package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
  203. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
  204. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +1 -1
  205. package/dist-types/ts3.4/commands/DescribeAgentStatusCommand.d.ts +1 -1
  206. package/dist-types/ts3.4/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
  207. package/dist-types/ts3.4/commands/DescribeContactCommand.d.ts +1 -1
  208. package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  209. package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +1 -2
  210. package/dist-types/ts3.4/commands/ListContactEvaluationsCommand.d.ts +1 -1
  211. package/dist-types/ts3.4/commands/ListContactFlowModulesCommand.d.ts +1 -1
  212. package/dist-types/ts3.4/commands/ListContactFlowVersionsCommand.d.ts +1 -1
  213. package/dist-types/ts3.4/commands/ListContactFlowsCommand.d.ts +1 -1
  214. package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +1 -1
  215. package/dist-types/ts3.4/commands/ListDefaultVocabulariesCommand.d.ts +1 -1
  216. package/dist-types/ts3.4/commands/ListEvaluationFormVersionsCommand.d.ts +1 -1
  217. package/dist-types/ts3.4/commands/ListEvaluationFormsCommand.d.ts +1 -1
  218. package/dist-types/ts3.4/commands/ListFlowAssociationsCommand.d.ts +1 -1
  219. package/dist-types/ts3.4/commands/ListHoursOfOperationOverridesCommand.d.ts +1 -1
  220. package/dist-types/ts3.4/commands/ListHoursOfOperationsCommand.d.ts +1 -1
  221. package/dist-types/ts3.4/commands/ListInstanceAttributesCommand.d.ts +1 -1
  222. package/dist-types/ts3.4/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
  223. package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +1 -1
  224. package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  225. package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +1 -1
  226. package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +1 -1
  227. package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +1 -1
  228. package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +1 -1
  229. package/dist-types/ts3.4/commands/ListPredefinedAttributesCommand.d.ts +1 -1
  230. package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
  231. package/dist-types/ts3.4/commands/ListQueueQuickConnectsCommand.d.ts +1 -1
  232. package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +1 -1
  233. package/dist-types/ts3.4/commands/ListQuickConnectsCommand.d.ts +1 -1
  234. package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  235. package/dist-types/ts3.4/commands/ListRoutingProfileManualAssignmentQueuesCommand.d.ts +1 -1
  236. package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
  237. package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +1 -1
  238. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
  239. package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +1 -1
  240. package/dist-types/ts3.4/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
  241. package/dist-types/ts3.4/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -1
  242. package/dist-types/ts3.4/commands/ListSecurityProfilesCommand.d.ts +1 -1
  243. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  244. package/dist-types/ts3.4/commands/ListTaskTemplatesCommand.d.ts +1 -1
  245. package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +2 -4
  246. package/dist-types/ts3.4/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
  247. package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +4 -2
  248. package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +4 -2
  249. package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +4 -2
  250. package/dist-types/ts3.4/commands/SearchContactFlowsCommand.d.ts +4 -2
  251. package/dist-types/ts3.4/commands/SearchEmailAddressesCommand.d.ts +4 -2
  252. package/dist-types/ts3.4/commands/SearchEvaluationFormsCommand.d.ts +4 -2
  253. package/dist-types/ts3.4/commands/SearchHoursOfOperationOverridesCommand.d.ts +4 -2
  254. package/dist-types/ts3.4/commands/SearchHoursOfOperationsCommand.d.ts +4 -2
  255. package/dist-types/ts3.4/commands/SearchPredefinedAttributesCommand.d.ts +4 -2
  256. package/dist-types/ts3.4/commands/SearchPromptsCommand.d.ts +4 -2
  257. package/dist-types/ts3.4/commands/SearchQueuesCommand.d.ts +1 -2
  258. package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +4 -2
  259. package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +4 -2
  260. package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +4 -2
  261. package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +4 -2
  262. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
  263. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +4 -2
  264. package/dist-types/ts3.4/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
  265. package/dist-types/ts3.4/commands/StartScreenSharingCommand.d.ts +1 -1
  266. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  267. package/dist-types/ts3.4/commands/StartWebRTCContactCommand.d.ts +1 -1
  268. package/dist-types/ts3.4/commands/StopContactCommand.d.ts +1 -1
  269. package/dist-types/ts3.4/commands/StopContactRecordingCommand.d.ts +1 -1
  270. package/dist-types/ts3.4/commands/StopContactStreamingCommand.d.ts +1 -1
  271. package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +1 -1
  272. package/dist-types/ts3.4/commands/SuspendContactRecordingCommand.d.ts +1 -1
  273. package/dist-types/ts3.4/commands/TagContactCommand.d.ts +1 -1
  274. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  275. package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +1 -1
  276. package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +1 -1
  277. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  278. package/dist-types/ts3.4/commands/UpdateAgentStatusCommand.d.ts +1 -1
  279. package/dist-types/ts3.4/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
  280. package/dist-types/ts3.4/commands/UpdateContactAttributesCommand.d.ts +1 -1
  281. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  282. package/dist-types/ts3.4/commands/UpdateContactEvaluationCommand.d.ts +1 -1
  283. package/dist-types/ts3.4/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  284. package/dist-types/ts3.4/commands/UpdateContactFlowMetadataCommand.d.ts +1 -1
  285. package/dist-types/ts3.4/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  286. package/dist-types/ts3.4/commands/UpdateContactFlowModuleMetadataCommand.d.ts +1 -1
  287. package/dist-types/ts3.4/commands/UpdateContactFlowNameCommand.d.ts +1 -1
  288. package/dist-types/ts3.4/commands/UpdateContactRoutingDataCommand.d.ts +2 -4
  289. package/dist-types/ts3.4/commands/UpdateContactScheduleCommand.d.ts +1 -1
  290. package/dist-types/ts3.4/commands/UpdateEmailAddressMetadataCommand.d.ts +1 -1
  291. package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +2 -4
  292. package/dist-types/ts3.4/commands/UpdateHoursOfOperationCommand.d.ts +1 -1
  293. package/dist-types/ts3.4/commands/UpdateHoursOfOperationOverrideCommand.d.ts +1 -1
  294. package/dist-types/ts3.4/commands/UpdateInstanceAttributeCommand.d.ts +1 -1
  295. package/dist-types/ts3.4/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
  296. package/dist-types/ts3.4/commands/UpdateParticipantAuthenticationCommand.d.ts +1 -1
  297. package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +1 -1
  298. package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +1 -1
  299. package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
  300. package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
  301. package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
  302. package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
  303. package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
  304. package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +1 -1
  305. package/dist-types/ts3.4/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
  306. package/dist-types/ts3.4/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +1 -1
  307. package/dist-types/ts3.4/commands/UpdateQueueStatusCommand.d.ts +1 -1
  308. package/dist-types/ts3.4/commands/UpdateQuickConnectConfigCommand.d.ts +1 -1
  309. package/dist-types/ts3.4/commands/UpdateQuickConnectNameCommand.d.ts +1 -1
  310. package/dist-types/ts3.4/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +1 -1
  311. package/dist-types/ts3.4/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
  312. package/dist-types/ts3.4/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
  313. package/dist-types/ts3.4/commands/UpdateRoutingProfileNameCommand.d.ts +1 -1
  314. package/dist-types/ts3.4/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
  315. package/dist-types/ts3.4/commands/UpdateRuleCommand.d.ts +1 -1
  316. package/dist-types/ts3.4/commands/UpdateSecurityProfileCommand.d.ts +1 -1
  317. package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +1 -1
  318. package/dist-types/ts3.4/commands/UpdateTrafficDistributionCommand.d.ts +1 -1
  319. package/dist-types/ts3.4/commands/UpdateUserHierarchyCommand.d.ts +1 -1
  320. package/dist-types/ts3.4/commands/UpdateUserHierarchyGroupNameCommand.d.ts +1 -1
  321. package/dist-types/ts3.4/commands/UpdateUserHierarchyStructureCommand.d.ts +1 -1
  322. package/dist-types/ts3.4/commands/UpdateUserIdentityInfoCommand.d.ts +1 -1
  323. package/dist-types/ts3.4/commands/UpdateUserPhoneConfigCommand.d.ts +1 -1
  324. package/dist-types/ts3.4/commands/UpdateUserProficienciesCommand.d.ts +1 -1
  325. package/dist-types/ts3.4/commands/UpdateUserRoutingProfileCommand.d.ts +1 -1
  326. package/dist-types/ts3.4/commands/UpdateUserSecurityProfilesCommand.d.ts +1 -1
  327. package/dist-types/ts3.4/commands/UpdateViewContentCommand.d.ts +1 -1
  328. package/dist-types/ts3.4/commands/UpdateViewMetadataCommand.d.ts +1 -1
  329. package/dist-types/ts3.4/index.d.ts +6 -1
  330. package/dist-types/ts3.4/models/enums.d.ts +1321 -0
  331. package/dist-types/ts3.4/models/errors.d.ts +232 -0
  332. package/dist-types/ts3.4/models/models_0.d.ts +482 -681
  333. package/dist-types/ts3.4/models/models_1.d.ts +959 -1012
  334. package/dist-types/ts3.4/models/models_2.d.ts +1390 -1568
  335. package/dist-types/ts3.4/models/models_3.d.ts +20 -1046
  336. package/package.json +19 -19
  337. package/dist-es/models/index.js +0 -4
  338. package/dist-types/models/index.d.ts +0 -4
  339. package/dist-types/ts3.4/models/index.d.ts +0 -4
@@ -1,4116 +1,7 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, AgentStatusState, AllowedCapabilities, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementExpression, EvaluationFormItemEnablementOperator, EvaluationFormQuestionType, EvaluationFormQuestionTypeProperties, EvaluationFormScoringStrategy, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InitiateAs, InputPredefinedAttributeConfiguration, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
4
- import { AnsweringMachineDetectionStatus, AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, Expiry, InstanceAttributeType, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TaskTemplateInfoV2, TelephonyConfig, WisdomInfo } from "./models_1";
5
- import { BooleanCondition, ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, ContactRecordingType, ContactSearchSummaryAgentInfo, ContactSearchSummaryQueueInfo, DateCondition, DateTimeCondition, DecimalCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, EvaluationFormSearchFilter, EvaluationSearchFilter, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, NumberCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, TrafficType, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
6
- /**
7
- * <p>Outbound calls to the destination number are not allowed.</p>
8
- * @public
9
- */
10
- export declare class DestinationNotAllowedException extends __BaseException {
11
- readonly name: "DestinationNotAllowedException";
12
- readonly $fault: "client";
13
- /**
14
- * <p>The message about the outbound calls.</p>
15
- * @public
16
- */
17
- Message?: string | undefined;
18
- /**
19
- * @internal
20
- */
21
- constructor(opts: __ExceptionOptionType<DestinationNotAllowedException, __BaseException>);
22
- }
23
- /**
24
- * <p>The contact is not permitted.</p>
25
- * @public
26
- */
27
- export declare class OutboundContactNotPermittedException extends __BaseException {
28
- readonly name: "OutboundContactNotPermittedException";
29
- readonly $fault: "client";
30
- /**
31
- * <p>The message about the contact.</p>
32
- * @public
33
- */
34
- Message?: string | undefined;
35
- /**
36
- * @internal
37
- */
38
- constructor(opts: __ExceptionOptionType<OutboundContactNotPermittedException, __BaseException>);
39
- }
40
- /**
41
- * <p>Configuration of the answering machine detection.</p>
42
- * @public
43
- */
44
- export interface AnswerMachineDetectionConfig {
45
- /**
46
- * <p>The flag to indicate if answer machine detection analysis needs to be performed for a voice
47
- * call. If set to <code>true</code>, <code>TrafficType</code> must be set as <code>CAMPAIGN</code>.
48
- * </p>
49
- * @public
50
- */
51
- EnableAnswerMachineDetection?: boolean | undefined;
52
- /**
53
- * <p>Wait for the answering machine prompt.</p>
54
- * @public
55
- */
56
- AwaitAnswerMachinePrompt?: boolean | undefined;
57
- }
58
- /**
59
- * @public
60
- */
61
- export interface StartOutboundVoiceContactRequest {
62
- /**
63
- * <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
64
- * (CCP).</p>
65
- * @public
66
- */
67
- Name?: string | undefined;
68
- /**
69
- * <p>A description of the voice contact that appears in the agent's snapshot in the CCP logs. For
70
- * more information about CCP logs, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/download-ccp-logs.html">Download and review CCP logs</a> in
71
- * the <i>Amazon Connect Administrator Guide</i>.</p>
72
- * @public
73
- */
74
- Description?: string | undefined;
75
- /**
76
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
77
- * have the following reference types at the time of creation: <code>URL</code> |
78
- * <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
79
- * <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
80
- * @public
81
- */
82
- References?: Record<string, Reference> | undefined;
83
- /**
84
- * <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by
85
- * using <code>RelatedContactID</code> copies over contact attributes from the related contact to
86
- * the new contact. All updates to user-defined attributes in the new contact are limited to the
87
- * individual contact ID. There are no limits to the number of contacts that can be linked by using
88
- * <code>RelatedContactId</code>. </p>
89
- * @public
90
- */
91
- RelatedContactId?: string | undefined;
92
- /**
93
- * <p>The phone number of the customer, in E.164 format.</p>
94
- * @public
95
- */
96
- DestinationPhoneNumber: string | undefined;
97
- /**
98
- * <p>The
99
- * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the
100
- * navigation menu go to <b>Routing</b>, <b>Contact
101
- * Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
102
- * <b>Show additional flow information</b>. The ContactFlowId is the last
103
- * part of the ARN, shown here in bold: </p>
104
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
105
- * </p>
106
- * @public
107
- */
108
- ContactFlowId: string | undefined;
109
- /**
110
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
111
- * @public
112
- */
113
- InstanceId: string | undefined;
114
- /**
115
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
116
- * request. If not provided, the Amazon Web Services
117
- * SDK populates this field. For more information about idempotency, see
118
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started,
119
- * the contact ID is returned.
120
- * </p>
121
- * @public
122
- */
123
- ClientToken?: string | undefined;
124
- /**
125
- * <p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do
126
- * not specify a source phone number, you must specify a queue.</p>
127
- * @public
128
- */
129
- SourcePhoneNumber?: string | undefined;
130
- /**
131
- * <p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the
132
- * phone number specified in the queue. If you do not specify a queue, the queue defined in the flow
133
- * is used. If you do not specify a queue, you must specify a source phone number.</p>
134
- * @public
135
- */
136
- QueueId?: string | undefined;
137
- /**
138
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
139
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
140
- * can include only alphanumeric, dash, and underscore characters.</p>
141
- * @public
142
- */
143
- Attributes?: Record<string, string> | undefined;
144
- /**
145
- * <p>Configuration of the answering machine detection for this outbound call. </p>
146
- * @public
147
- */
148
- AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
149
- /**
150
- * <p>The campaign identifier of the outbound communication.</p>
151
- * @public
152
- */
153
- CampaignId?: string | undefined;
154
- /**
155
- * <p>Denotes the class of traffic. Calls with different traffic types are handled differently by
156
- * Amazon Connect. The default value is <code>GENERAL</code>. Use <code>CAMPAIGN</code> if
157
- * <code>EnableAnswerMachineDetection</code> is set to <code>true</code>. For all other cases, use
158
- * <code>GENERAL</code>. </p>
159
- * @public
160
- */
161
- TrafficType?: TrafficType | undefined;
162
- /**
163
- * <p>Information about the outbound strategy.</p>
164
- * @public
165
- */
166
- OutboundStrategy?: OutboundStrategy | undefined;
167
- /**
168
- * <p>The maximum time the outbound call will wait for the destination to answer the call, in seconds </p>
169
- * @public
170
- */
171
- RingTimeoutInSeconds?: number | undefined;
172
- }
173
- /**
174
- * @public
175
- */
176
- export interface StartOutboundVoiceContactResponse {
177
- /**
178
- * <p>The identifier of this contact within the Amazon Connect instance.</p>
179
- * @public
180
- */
181
- ContactId?: string | undefined;
182
- }
183
- /**
184
- * @public
185
- */
186
- export interface StartScreenSharingRequest {
187
- /**
188
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
189
- * request. If not provided, the Amazon Web Services
190
- * SDK populates this field. For more information about idempotency, see
191
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
192
- * @public
193
- */
194
- ClientToken?: string | undefined;
195
- /**
196
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
197
- * @public
198
- */
199
- InstanceId: string | undefined;
200
- /**
201
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
202
- * @public
203
- */
204
- ContactId: string | undefined;
205
- }
206
- /**
207
- * @public
208
- */
209
- export interface StartScreenSharingResponse {
210
- }
211
- /**
212
- * @public
213
- */
214
- export interface StartTaskContactResponse {
215
- /**
216
- * <p>The identifier of this contact within the Amazon Connect instance.</p>
217
- * @public
218
- */
219
- ContactId?: string | undefined;
220
- }
221
- /**
222
- * @public
223
- */
224
- export interface StartWebRTCContactRequest {
225
- /**
226
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
227
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
228
- * can include only alphanumeric, -, and _ characters.</p>
229
- * @public
230
- */
231
- Attributes?: Record<string, string> | undefined;
232
- /**
233
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
234
- * request. If not provided, the Amazon Web Services
235
- * SDK populates this field. For more information about idempotency, see
236
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
237
- * <p>The token is valid for 7 days after creation. If a contact is already started, the contact
238
- * ID is returned.</p>
239
- * @public
240
- */
241
- ClientToken?: string | undefined;
242
- /**
243
- * <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the
244
- * navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
245
- * <b>Show additional flow information</b>. The ContactFlowId is the last
246
- * part of the ARN, shown here in bold: </p>
247
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
248
- * </p>
249
- * @public
250
- */
251
- ContactFlowId: string | undefined;
252
- /**
253
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
254
- * @public
255
- */
256
- InstanceId: string | undefined;
257
- /**
258
- * <p>Information about the video sharing capabilities of the participants (customer,
259
- * agent).</p>
260
- * @public
261
- */
262
- AllowedCapabilities?: AllowedCapabilities | undefined;
263
- /**
264
- * <p>The customer's details.</p>
265
- * @public
266
- */
267
- ParticipantDetails: ParticipantDetails | undefined;
268
- /**
269
- * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
270
- * contact starting.</p>
271
- * @public
272
- */
273
- RelatedContactId?: string | undefined;
274
- /**
275
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
276
- * the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
277
- * <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
278
- * supported reference type during task creation.</p>
279
- * @public
280
- */
281
- References?: Record<string, Reference> | undefined;
282
- /**
283
- * <p>A description of the task that is shown to an agent in the Contact Control Panel
284
- * (CCP).</p>
285
- * @public
286
- */
287
- Description?: string | undefined;
288
- }
289
- /**
290
- * <p>The attendee information, including attendee ID and join token.</p>
291
- * @public
292
- */
293
- export interface Attendee {
294
- /**
295
- * <p>The Amazon Chime SDK attendee ID.</p>
296
- * @public
297
- */
298
- AttendeeId?: string | undefined;
299
- /**
300
- * <p>The join token used by the Amazon Chime SDK attendee.</p>
301
- * @public
302
- */
303
- JoinToken?: string | undefined;
304
- }
305
- /**
306
- * <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
307
- * @public
308
- */
309
- export interface MediaPlacement {
310
- /**
311
- * <p>The audio host URL.</p>
312
- * @public
313
- */
314
- AudioHostUrl?: string | undefined;
315
- /**
316
- * <p>The audio fallback URL.</p>
317
- * @public
318
- */
319
- AudioFallbackUrl?: string | undefined;
320
- /**
321
- * <p>The signaling URL.</p>
322
- * @public
323
- */
324
- SignalingUrl?: string | undefined;
325
- /**
326
- * <p>The turn control URL.</p>
327
- * @public
328
- */
329
- TurnControlUrl?: string | undefined;
330
- /**
331
- * <p>The event ingestion URL to which you send client meeting events.</p>
332
- * @public
333
- */
334
- EventIngestionUrl?: string | undefined;
335
- }
336
- /**
337
- * @public
338
- * @enum
339
- */
340
- export declare const MeetingFeatureStatus: {
341
- readonly AVAILABLE: "AVAILABLE";
342
- readonly UNAVAILABLE: "UNAVAILABLE";
343
- };
344
- /**
345
- * @public
346
- */
347
- export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
348
- /**
349
- * <p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>
350
- * @public
351
- */
352
- export interface AudioFeatures {
353
- /**
354
- * <p>Makes echo reduction available to clients who connect to the meeting.</p>
355
- * @public
356
- */
357
- EchoReduction?: MeetingFeatureStatus | undefined;
358
- }
359
- /**
360
- * <p>The configuration settings of the features available to a meeting.</p>
361
- * @public
362
- */
363
- export interface MeetingFeaturesConfiguration {
364
- /**
365
- * <p>The configuration settings for the audio features available to a meeting.</p>
366
- * @public
367
- */
368
- Audio?: AudioFeatures | undefined;
369
- }
370
- /**
371
- * <p>A meeting created using the Amazon Chime SDK.</p>
372
- * @public
373
- */
374
- export interface Meeting {
375
- /**
376
- * <p>The Amazon Web Services Region in which you create the meeting.</p>
377
- * @public
378
- */
379
- MediaRegion?: string | undefined;
380
- /**
381
- * <p>The media placement for the meeting.</p>
382
- * @public
383
- */
384
- MediaPlacement?: MediaPlacement | undefined;
385
- /**
386
- * <p>The configuration settings of the features available to a meeting.</p>
387
- * @public
388
- */
389
- MeetingFeatures?: MeetingFeaturesConfiguration | undefined;
390
- /**
391
- * <p>The Amazon Chime SDK meeting ID.</p>
392
- * @public
393
- */
394
- MeetingId?: string | undefined;
395
- }
396
- /**
397
- * <p>Information required to join the call.</p>
398
- * @public
399
- */
400
- export interface ConnectionData {
401
- /**
402
- * <p>The attendee information, including attendee ID and join token.</p>
403
- * @public
404
- */
405
- Attendee?: Attendee | undefined;
406
- /**
407
- * <p>A meeting created using the Amazon Chime SDK.</p>
408
- * @public
409
- */
410
- Meeting?: Meeting | undefined;
411
- }
412
- /**
413
- * @public
414
- */
415
- export interface StartWebRTCContactResponse {
416
- /**
417
- * <p>Information required for the client application (mobile application or website) to connect
418
- * to the call.</p>
419
- * @public
420
- */
421
- ConnectionData?: ConnectionData | undefined;
422
- /**
423
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
424
- * @public
425
- */
426
- ContactId?: string | undefined;
427
- /**
428
- * <p>The identifier for a contact participant. The <code>ParticipantId</code> for a contact
429
- * participant is the same throughout the contact lifecycle.</p>
430
- * @public
431
- */
432
- ParticipantId?: string | undefined;
433
- /**
434
- * <p>The token used by the contact participant to call the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API. The participant token is valid for the lifetime of a
435
- * contact participant.</p>
436
- * @public
437
- */
438
- ParticipantToken?: string | undefined;
439
- }
440
- /**
441
- * <p>The contact with the specified ID does not exist.</p>
442
- * @public
443
- */
444
- export declare class ContactNotFoundException extends __BaseException {
445
- readonly name: "ContactNotFoundException";
446
- readonly $fault: "client";
447
- /**
448
- * <p>The message.</p>
449
- * @public
450
- */
451
- Message?: string | undefined;
452
- /**
453
- * @internal
454
- */
455
- constructor(opts: __ExceptionOptionType<ContactNotFoundException, __BaseException>);
456
- }
457
- /**
458
- * <p>Contains details about why a contact was disconnected. Only Amazon Connect outbound
459
- * campaigns can provide this field.</p>
460
- * @public
461
- */
462
- export interface DisconnectReason {
463
- /**
464
- * <p>A code that indicates how the contact was terminated.</p>
465
- * @public
466
- */
467
- Code?: string | undefined;
468
- }
469
- /**
470
- * @public
471
- */
472
- export interface StopContactRequest {
473
- /**
474
- * <p>The ID of the contact.</p>
475
- * @public
476
- */
477
- ContactId: string | undefined;
478
- /**
479
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
480
- * @public
481
- */
482
- InstanceId: string | undefined;
483
- /**
484
- * <p>The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can
485
- * provide this field. For a list and description of all the possible
486
- * disconnect reasons by channel (including outbound campaign voice contacts) see DisconnectReason under <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
487
- * @public
488
- */
489
- DisconnectReason?: DisconnectReason | undefined;
490
- }
491
- /**
492
- * @public
493
- */
494
- export interface StopContactResponse {
495
- }
496
- /**
497
- * @public
498
- */
499
- export interface StopContactRecordingRequest {
500
- /**
501
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
502
- * @public
503
- */
504
- InstanceId: string | undefined;
505
- /**
506
- * <p>The identifier of the contact.</p>
507
- * @public
508
- */
509
- ContactId: string | undefined;
510
- /**
511
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
512
- * first interaction with the contact center.</p>
513
- * @public
514
- */
515
- InitialContactId: string | undefined;
516
- /**
517
- * <p>The type of recording being operated on.</p>
518
- * @public
519
- */
520
- ContactRecordingType?: ContactRecordingType | undefined;
521
- }
522
- /**
523
- * @public
524
- */
525
- export interface StopContactRecordingResponse {
526
- }
527
- /**
528
- * @public
529
- */
530
- export interface StopContactStreamingRequest {
531
- /**
532
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
533
- * @public
534
- */
535
- InstanceId: string | undefined;
536
- /**
537
- * <p>The identifier of the contact. This is the identifier of the contact that is associated with
538
- * the first interaction with the contact center.</p>
539
- * @public
540
- */
541
- ContactId: string | undefined;
542
- /**
543
- * <p>The identifier of the streaming configuration enabled. </p>
544
- * @public
545
- */
546
- StreamingId: string | undefined;
547
- }
548
- /**
549
- * @public
550
- */
551
- export interface StopContactStreamingResponse {
552
- }
553
- /**
554
- * <p>Information about input answers for a contact evaluation.</p>
555
- * @public
556
- */
557
- export interface EvaluationAnswerInput {
558
- /**
559
- * <p>The value for an answer in a contact evaluation.</p>
560
- * @public
561
- */
562
- Value?: EvaluationAnswerData | undefined;
563
- }
564
- /**
565
- * <p>Represents the entity that performed the action on the evaluation.</p>
566
- * @public
567
- */
568
- export type EvaluatorUserUnion = EvaluatorUserUnion.ConnectUserArnMember | EvaluatorUserUnion.$UnknownMember;
569
- /**
570
- * @public
571
- */
572
- export declare namespace EvaluatorUserUnion {
573
- /**
574
- * <p>Represents the Amazon Connect ARN of the user.</p>
575
- * @public
576
- */
577
- interface ConnectUserArnMember {
578
- ConnectUserArn: string;
579
- $unknown?: never;
580
- }
581
- /**
582
- * @public
583
- */
584
- interface $UnknownMember {
585
- ConnectUserArn?: never;
586
- $unknown: [string, any];
587
- }
588
- /**
589
- * @deprecated unused in schema-serde mode.
590
- *
591
- */
592
- interface Visitor<T> {
593
- ConnectUserArn: (value: string) => T;
594
- _: (name: string, value: any) => T;
595
- }
596
- }
597
- /**
598
- * @public
599
- */
600
- export interface SubmitContactEvaluationRequest {
601
- /**
602
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
603
- * @public
604
- */
605
- InstanceId: string | undefined;
606
- /**
607
- * <p>A unique identifier for the contact evaluation.</p>
608
- * @public
609
- */
610
- EvaluationId: string | undefined;
611
- /**
612
- * <p>A map of question identifiers to answer value.</p>
613
- * @public
614
- */
615
- Answers?: Record<string, EvaluationAnswerInput> | undefined;
616
- /**
617
- * <p>A map of question identifiers to note value.</p>
618
- * @public
619
- */
620
- Notes?: Record<string, EvaluationNote> | undefined;
621
- /**
622
- * <p>The ID of the user who submitted the contact evaluation.</p>
623
- * @public
624
- */
625
- SubmittedBy?: EvaluatorUserUnion | undefined;
626
- }
627
- /**
628
- * @public
629
- */
630
- export interface SubmitContactEvaluationResponse {
631
- /**
632
- * <p>A unique identifier for the contact evaluation.</p>
633
- * @public
634
- */
635
- EvaluationId: string | undefined;
636
- /**
637
- * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
638
- * @public
639
- */
640
- EvaluationArn: string | undefined;
641
- }
642
- /**
643
- * @public
644
- */
645
- export interface SuspendContactRecordingRequest {
646
- /**
647
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
648
- * @public
649
- */
650
- InstanceId: string | undefined;
651
- /**
652
- * <p>The identifier of the contact.</p>
653
- * @public
654
- */
655
- ContactId: string | undefined;
656
- /**
657
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
658
- * first interaction with the contact center.</p>
659
- * @public
660
- */
661
- InitialContactId: string | undefined;
662
- /**
663
- * <p>The type of recording being operated on.</p>
664
- * @public
665
- */
666
- ContactRecordingType?: ContactRecordingType | undefined;
667
- }
668
- /**
669
- * @public
670
- */
671
- export interface SuspendContactRecordingResponse {
672
- }
673
- /**
674
- * @public
675
- */
676
- export interface TagContactRequest {
677
- /**
678
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
679
- * @public
680
- */
681
- ContactId: string | undefined;
682
- /**
683
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
684
- * @public
685
- */
686
- InstanceId: string | undefined;
687
- /**
688
- * <p>The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1",
689
- * "key2":"value2"\} \}.</p>
690
- * <note>
691
- * <p>Authorization is not supported by this tag.</p>
692
- * </note>
693
- * @public
694
- */
695
- Tags: Record<string, string> | undefined;
696
- }
697
- /**
698
- * @public
699
- */
700
- export interface TagContactResponse {
701
- }
702
- /**
703
- * @public
704
- */
705
- export interface TagResourceRequest {
706
- /**
707
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
708
- * @public
709
- */
710
- resourceArn: string | undefined;
711
- /**
712
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
713
- * @public
714
- */
715
- tags: Record<string, string> | undefined;
716
- }
717
- /**
718
- * @public
719
- */
720
- export interface TransferContactRequest {
721
- /**
722
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
723
- * @public
724
- */
725
- InstanceId: string | undefined;
726
- /**
727
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
728
- * @public
729
- */
730
- ContactId: string | undefined;
731
- /**
732
- * <p>The identifier for the queue.</p>
733
- * @public
734
- */
735
- QueueId?: string | undefined;
736
- /**
737
- * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
738
- * @public
739
- */
740
- UserId?: string | undefined;
741
- /**
742
- * <p>The identifier of the flow.</p>
743
- * @public
744
- */
745
- ContactFlowId: string | undefined;
746
- /**
747
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
748
- * request. If not provided, the Amazon Web Services
749
- * SDK populates this field. For more information about idempotency, see
750
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
751
- * @public
752
- */
753
- ClientToken?: string | undefined;
754
- }
755
- /**
756
- * @public
757
- */
758
- export interface TransferContactResponse {
759
- /**
760
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
761
- * @public
762
- */
763
- ContactId?: string | undefined;
764
- /**
765
- * <p>The Amazon Resource Name (ARN) of the contact.</p>
766
- * @public
767
- */
768
- ContactArn?: string | undefined;
769
- }
770
- /**
771
- * @public
772
- */
773
- export interface UntagContactRequest {
774
- /**
775
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
776
- * @public
777
- */
778
- ContactId: string | undefined;
779
- /**
780
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
781
- * @public
782
- */
783
- InstanceId: string | undefined;
784
- /**
785
- * <p>A list of tag keys. Existing tags on the contact whose keys are members of this list will be
786
- * removed.</p>
787
- * @public
788
- */
789
- TagKeys: string[] | undefined;
790
- }
791
- /**
792
- * @public
793
- */
794
- export interface UntagContactResponse {
795
- }
796
- /**
797
- * @public
798
- */
799
- export interface UntagResourceRequest {
800
- /**
801
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
802
- * @public
803
- */
804
- resourceArn: string | undefined;
805
- /**
806
- * <p>The tag keys.</p>
807
- * @public
808
- */
809
- tagKeys: string[] | undefined;
810
- }
811
- /**
812
- * @public
813
- */
814
- export interface UpdateAgentStatusRequest {
815
- /**
816
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
817
- * @public
818
- */
819
- InstanceId: string | undefined;
820
- /**
821
- * <p>The identifier of the agent status.</p>
822
- * @public
823
- */
824
- AgentStatusId: string | undefined;
825
- /**
826
- * <p>The name of the agent status.</p>
827
- * @public
828
- */
829
- Name?: string | undefined;
830
- /**
831
- * <p>The description of the agent status.</p>
832
- * @public
833
- */
834
- Description?: string | undefined;
835
- /**
836
- * <p>The state of the agent status.</p>
837
- * @public
838
- */
839
- State?: AgentStatusState | undefined;
840
- /**
841
- * <p>The display order of the agent status.</p>
842
- * @public
843
- */
844
- DisplayOrder?: number | undefined;
845
- /**
846
- * <p>A number indicating the reset order of the agent status.</p>
847
- * @public
848
- */
849
- ResetOrderNumber?: boolean | undefined;
850
- }
851
- /**
852
- * @public
853
- */
854
- export interface UpdateAuthenticationProfileRequest {
855
- /**
856
- * <p>A unique identifier for the authentication profile. </p>
857
- * @public
858
- */
859
- AuthenticationProfileId: string | undefined;
860
- /**
861
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
862
- * @public
863
- */
864
- InstanceId: string | undefined;
865
- /**
866
- * <p>The name for the authentication profile.</p>
867
- * @public
868
- */
869
- Name?: string | undefined;
870
- /**
871
- * <p>The description for the authentication profile.</p>
872
- * @public
873
- */
874
- Description?: string | undefined;
875
- /**
876
- * <p>A list of IP address range strings that are allowed to access the instance. For more
877
- * information on how to configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator
878
- * Guide</i>.</p>
879
- * @public
880
- */
881
- AllowedIps?: string[] | undefined;
882
- /**
883
- * <p>A list of IP address range strings that are blocked from accessing the instance. For more
884
- * information on how to configure IP addresses, For more information on how to configure IP
885
- * addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
886
- * IP-based access control</a> in the <i>Amazon Connect Administrator
887
- * Guide</i>. </p>
888
- * @public
889
- */
890
- BlockedIps?: string[] | undefined;
891
- /**
892
- * <p>The short lived session duration configuration for users logged in to Amazon Connect, in
893
- * minutes. This value determines the maximum possible time before an agent is authenticated. For
894
- * more information, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator
895
- * Guide</i>. </p>
896
- *
897
- * @deprecated PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead.
898
- * @public
899
- */
900
- PeriodicSessionDuration?: number | undefined;
901
- /**
902
- * <p>The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.</p>
903
- * @public
904
- */
905
- SessionInactivityDuration?: number | undefined;
906
- /**
907
- * <p>Determines if automatic logout on user inactivity is enabled.</p>
908
- * @public
909
- */
910
- SessionInactivityHandlingEnabled?: boolean | undefined;
911
- }
912
- /**
913
- * <p>Information about a queue.</p>
914
- * @public
915
- */
916
- export interface QueueInfoInput {
917
- /**
918
- * <p>The identifier of the queue.</p>
919
- * @public
920
- */
921
- Id?: string | undefined;
922
- }
923
- /**
924
- * @public
925
- */
926
- export interface UpdateContactResponse {
927
- }
928
- /**
929
- * @public
930
- */
931
- export interface UpdateContactAttributesRequest {
932
- /**
933
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
934
- * first interaction with the contact center.</p>
935
- * @public
936
- */
937
- InitialContactId: string | undefined;
938
- /**
939
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
940
- * @public
941
- */
942
- InstanceId: string | undefined;
943
- /**
944
- * <p>The Amazon Connect attributes. These attributes can be accessed in flows just like any
945
- * other contact attributes.</p>
946
- * <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys
947
- * can include only alphanumeric, dash, and underscore characters.</p>
948
- * <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact attributes</a>
949
- * block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error
950
- * branch of the flow. As a mitigation, consider the following options:</p>
951
- * <ul>
952
- * <li>
953
- * <p>Remove unnecessary attributes by setting their values to empty.</p>
954
- * </li>
955
- * <li>
956
- * <p>If the attributes are only used in one flow and don't need to be referred to outside of
957
- * that flow (for example, by a Lambda or another flow), then use flow attributes. This way you
958
- * aren't needlessly persisting the 32 KB of information from one flow to another. For more
959
- * information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact
960
- * attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
961
- * </li>
962
- * </ul>
963
- * @public
964
- */
965
- Attributes: Record<string, string> | undefined;
966
- }
967
- /**
968
- * @public
969
- */
970
- export interface UpdateContactAttributesResponse {
971
- }
972
- /**
973
- * @public
974
- */
975
- export interface UpdateContactEvaluationRequest {
976
- /**
977
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
978
- * @public
979
- */
980
- InstanceId: string | undefined;
981
- /**
982
- * <p>A unique identifier for the contact evaluation.</p>
983
- * @public
984
- */
985
- EvaluationId: string | undefined;
986
- /**
987
- * <p>A map of question identifiers to answer value.</p>
988
- * @public
989
- */
990
- Answers?: Record<string, EvaluationAnswerInput> | undefined;
991
- /**
992
- * <p>A map of question identifiers to note value.</p>
993
- * @public
994
- */
995
- Notes?: Record<string, EvaluationNote> | undefined;
996
- /**
997
- * <p>The ID of the user who updated the contact evaluation.</p>
998
- * @public
999
- */
1000
- UpdatedBy?: EvaluatorUserUnion | undefined;
1001
- }
1002
- /**
1003
- * @public
1004
- */
1005
- export interface UpdateContactEvaluationResponse {
1006
- /**
1007
- * <p>A unique identifier for the contact evaluation.</p>
1008
- * @public
1009
- */
1010
- EvaluationId: string | undefined;
1011
- /**
1012
- * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
1013
- * @public
1014
- */
1015
- EvaluationArn: string | undefined;
1016
- }
1017
- /**
1018
- * @public
1019
- */
1020
- export interface UpdateContactFlowContentRequest {
1021
- /**
1022
- * <p>The identifier of the Amazon Connect instance.</p>
1023
- * @public
1024
- */
1025
- InstanceId: string | undefined;
1026
- /**
1027
- * <p>The identifier of the flow.</p>
1028
- * @public
1029
- */
1030
- ContactFlowId: string | undefined;
1031
- /**
1032
- * <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
1033
- * flow in Amazon Connect Flow language</a>. </p>
1034
- * <p>Length Constraints: Minimum length of 1. Maximum length of 256000.</p>
1035
- * @public
1036
- */
1037
- Content: string | undefined;
1038
- }
1039
- /**
1040
- * @public
1041
- */
1042
- export interface UpdateContactFlowContentResponse {
1043
- }
1044
- /**
1045
- * @public
1046
- */
1047
- export interface UpdateContactFlowMetadataRequest {
1048
- /**
1049
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1050
- * @public
1051
- */
1052
- InstanceId: string | undefined;
1053
- /**
1054
- * <p>The identifier of the flow.</p>
1055
- * @public
1056
- */
1057
- ContactFlowId: string | undefined;
1058
- /**
1059
- * <p>The name of the flow.</p>
1060
- * @public
1061
- */
1062
- Name?: string | undefined;
1063
- /**
1064
- * <p>The description of the flow.</p>
1065
- * @public
1066
- */
1067
- Description?: string | undefined;
1068
- /**
1069
- * <p>The state of flow.</p>
1070
- * @public
1071
- */
1072
- ContactFlowState?: ContactFlowState | undefined;
1073
- }
1074
- /**
1075
- * @public
1076
- */
1077
- export interface UpdateContactFlowMetadataResponse {
1078
- }
1079
- /**
1080
- * @public
1081
- */
1082
- export interface UpdateContactFlowModuleContentRequest {
1083
- /**
1084
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1085
- * @public
1086
- */
1087
- InstanceId: string | undefined;
1088
- /**
1089
- * <p>The identifier of the flow module.</p>
1090
- * @public
1091
- */
1092
- ContactFlowModuleId: string | undefined;
1093
- /**
1094
- * <p>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
1095
- * flow in Amazon Connect Flow language</a>. </p>
1096
- * @public
1097
- */
1098
- Content: string | undefined;
1099
- }
1100
- /**
1101
- * @public
1102
- */
1103
- export interface UpdateContactFlowModuleContentResponse {
1104
- }
1105
- /**
1106
- * @public
1107
- */
1108
- export interface UpdateContactFlowModuleMetadataRequest {
1109
- /**
1110
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1111
- * @public
1112
- */
1113
- InstanceId: string | undefined;
1114
- /**
1115
- * <p>The identifier of the flow module.</p>
1116
- * @public
1117
- */
1118
- ContactFlowModuleId: string | undefined;
1119
- /**
1120
- * <p>The name of the flow module.</p>
1121
- * @public
1122
- */
1123
- Name?: string | undefined;
1124
- /**
1125
- * <p>The description of the flow module.</p>
1126
- * @public
1127
- */
1128
- Description?: string | undefined;
1129
- /**
1130
- * <p>The state of flow module.</p>
1131
- * @public
1132
- */
1133
- State?: ContactFlowModuleState | undefined;
1134
- }
1135
- /**
1136
- * @public
1137
- */
1138
- export interface UpdateContactFlowModuleMetadataResponse {
1139
- }
1140
- /**
1141
- * @public
1142
- */
1143
- export interface UpdateContactFlowNameRequest {
1144
- /**
1145
- * <p>The identifier of the Amazon Connect instance.</p>
1146
- * @public
1147
- */
1148
- InstanceId: string | undefined;
1149
- /**
1150
- * <p>The identifier of the flow.</p>
1151
- * @public
1152
- */
1153
- ContactFlowId: string | undefined;
1154
- /**
1155
- * <p>The name of the flow.</p>
1156
- * @public
1157
- */
1158
- Name?: string | undefined;
1159
- /**
1160
- * <p>The description of the flow.</p>
1161
- * @public
1162
- */
1163
- Description?: string | undefined;
1164
- }
1165
- /**
1166
- * @public
1167
- */
1168
- export interface UpdateContactFlowNameResponse {
1169
- }
1170
- /**
1171
- * <p>Specify whether this routing criteria step should apply for only a limited amount of time,
1172
- * or if it should never expire.</p>
1173
- * @public
1174
- */
1175
- export interface RoutingCriteriaInputStepExpiry {
1176
- /**
1177
- * <p>The number of seconds that the contact will be routed only to agents matching this routing
1178
- * step, if expiry was configured for this routing step.</p>
1179
- * @public
1180
- */
1181
- DurationInSeconds?: number | undefined;
1182
- }
1183
- /**
1184
- * @public
1185
- */
1186
- export interface UpdateContactRoutingDataResponse {
1187
- }
1188
- /**
1189
- * @public
1190
- */
1191
- export interface UpdateContactScheduleRequest {
1192
- /**
1193
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1194
- * @public
1195
- */
1196
- InstanceId: string | undefined;
1197
- /**
1198
- * <p>The identifier of the contact.</p>
1199
- * @public
1200
- */
1201
- ContactId: string | undefined;
1202
- /**
1203
- * <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
1204
- * @public
1205
- */
1206
- ScheduledTime: Date | undefined;
1207
- }
1208
- /**
1209
- * @public
1210
- */
1211
- export interface UpdateContactScheduleResponse {
1212
- }
1213
- /**
1214
- * @public
1215
- */
1216
- export interface UpdateEmailAddressMetadataRequest {
1217
- /**
1218
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1219
- * @public
1220
- */
1221
- InstanceId: string | undefined;
1222
- /**
1223
- * <p>The identifier of the email address.</p>
1224
- * @public
1225
- */
1226
- EmailAddressId: string | undefined;
1227
- /**
1228
- * <p>The description of the email address.</p>
1229
- * @public
1230
- */
1231
- Description?: string | undefined;
1232
- /**
1233
- * <p>The display name of email address.</p>
1234
- * @public
1235
- */
1236
- DisplayName?: string | undefined;
1237
- /**
1238
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1239
- * request. If not provided, the Amazon Web Services
1240
- * SDK populates this field. For more information about idempotency, see
1241
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1242
- * @public
1243
- */
1244
- ClientToken?: string | undefined;
1245
- }
1246
- /**
1247
- * @public
1248
- */
1249
- export interface UpdateEmailAddressMetadataResponse {
1250
- /**
1251
- * <p>The identifier of the email address.</p>
1252
- * @public
1253
- */
1254
- EmailAddressId?: string | undefined;
1255
- /**
1256
- * <p>The Amazon Resource Name (ARN) of the email address.</p>
1257
- * @public
1258
- */
1259
- EmailAddressArn?: string | undefined;
1260
- }
1261
- /**
1262
- * @public
1263
- */
1264
- export interface UpdateEvaluationFormResponse {
1265
- /**
1266
- * <p>The unique identifier for the evaluation form.</p>
1267
- * @public
1268
- */
1269
- EvaluationFormId: string | undefined;
1270
- /**
1271
- * <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
1272
- * @public
1273
- */
1274
- EvaluationFormArn: string | undefined;
1275
- /**
1276
- * <p>The version of the updated evaluation form resource.</p>
1277
- * @public
1278
- */
1279
- EvaluationFormVersion: number | undefined;
1280
- }
1281
- /**
1282
- * @public
1283
- */
1284
- export interface UpdateHoursOfOperationRequest {
1285
- /**
1286
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1287
- * @public
1288
- */
1289
- InstanceId: string | undefined;
1290
- /**
1291
- * <p>The identifier of the hours of operation.</p>
1292
- * @public
1293
- */
1294
- HoursOfOperationId: string | undefined;
1295
- /**
1296
- * <p>The name of the hours of operation.</p>
1297
- * @public
1298
- */
1299
- Name?: string | undefined;
1300
- /**
1301
- * <p>The description of the hours of operation.</p>
1302
- * @public
1303
- */
1304
- Description?: string | undefined;
1305
- /**
1306
- * <p>The time zone of the hours of operation.</p>
1307
- * @public
1308
- */
1309
- TimeZone?: string | undefined;
1310
- /**
1311
- * <p>Configuration information of the hours of operation.</p>
1312
- * @public
1313
- */
1314
- Config?: HoursOfOperationConfig[] | undefined;
1315
- }
1316
- /**
1317
- * <p>Request processing failed because dependent condition failed.</p>
1318
- * @public
1319
- */
1320
- export declare class ConditionalOperationFailedException extends __BaseException {
1321
- readonly name: "ConditionalOperationFailedException";
1322
- readonly $fault: "client";
1323
- Message?: string | undefined;
1324
- /**
1325
- * @internal
1326
- */
1327
- constructor(opts: __ExceptionOptionType<ConditionalOperationFailedException, __BaseException>);
1328
- }
1329
- /**
1330
- * @public
1331
- */
1332
- export interface UpdateHoursOfOperationOverrideRequest {
1333
- /**
1334
- * <p>The identifier of the Amazon Connect instance.</p>
1335
- * @public
1336
- */
1337
- InstanceId: string | undefined;
1338
- /**
1339
- * <p>The identifier for the hours of operation.</p>
1340
- * @public
1341
- */
1342
- HoursOfOperationId: string | undefined;
1343
- /**
1344
- * <p>The identifier for the hours of operation override.</p>
1345
- * @public
1346
- */
1347
- HoursOfOperationOverrideId: string | undefined;
1348
- /**
1349
- * <p>The name of the hours of operation override.</p>
1350
- * @public
1351
- */
1352
- Name?: string | undefined;
1353
- /**
1354
- * <p>The description of the hours of operation override.</p>
1355
- * @public
1356
- */
1357
- Description?: string | undefined;
1358
- /**
1359
- * <p>Configuration information for the hours of operation override: day, start time, and end
1360
- * time.</p>
1361
- * @public
1362
- */
1363
- Config?: HoursOfOperationOverrideConfig[] | undefined;
1364
- /**
1365
- * <p>The date from when the hours of operation override would be effective.</p>
1366
- * @public
1367
- */
1368
- EffectiveFrom?: string | undefined;
1369
- /**
1370
- * <p>The date until the hours of operation override is effective.</p>
1371
- * @public
1372
- */
1373
- EffectiveTill?: string | undefined;
1374
- }
1375
- /**
1376
- * @public
1377
- */
1378
- export interface UpdateInstanceAttributeRequest {
1379
- /**
1380
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1381
- * @public
1382
- */
1383
- InstanceId: string | undefined;
1384
- /**
1385
- * <p>The type of attribute.</p>
1386
- * <note>
1387
- * <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,
1388
- * contact Amazon Web Services Support for allowlisting.</p>
1389
- * </note>
1390
- * @public
1391
- */
1392
- AttributeType: InstanceAttributeType | undefined;
1393
- /**
1394
- * <p>The value for the attribute. Maximum character limit is 100. </p>
1395
- * @public
1396
- */
1397
- Value: string | undefined;
1398
- /**
1399
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1400
- * request. If not provided, the Amazon Web Services
1401
- * SDK populates this field. For more information about idempotency, see
1402
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1403
- * @public
1404
- */
1405
- ClientToken?: string | undefined;
1406
- }
1407
- /**
1408
- * @public
1409
- */
1410
- export interface UpdateInstanceStorageConfigRequest {
1411
- /**
1412
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1413
- * @public
1414
- */
1415
- InstanceId: string | undefined;
1416
- /**
1417
- * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
1418
- * @public
1419
- */
1420
- AssociationId: string | undefined;
1421
- /**
1422
- * <p>A valid resource type.</p>
1423
- * @public
1424
- */
1425
- ResourceType: InstanceStorageResourceType | undefined;
1426
- /**
1427
- * <p>The storage configuration for the instance.</p>
1428
- * @public
1429
- */
1430
- StorageConfig: InstanceStorageConfig | undefined;
1431
- /**
1432
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1433
- * request. If not provided, the Amazon Web Services
1434
- * SDK populates this field. For more information about idempotency, see
1435
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1436
- * @public
1437
- */
1438
- ClientToken?: string | undefined;
1439
- }
1440
- /**
1441
- * @public
1442
- */
1443
- export interface UpdateParticipantAuthenticationRequest {
1444
- /**
1445
- * <p>The <code>state</code> query parameter that was provided by Cognito in the
1446
- * <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the
1447
- * <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a>
1448
- * response.</p>
1449
- * @public
1450
- */
1451
- State: string | undefined;
1452
- /**
1453
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1454
- * @public
1455
- */
1456
- InstanceId: string | undefined;
1457
- /**
1458
- * <p>The <code>code</code> query parameter provided by Cognito in the
1459
- * <code>redirectUri</code>.</p>
1460
- * @public
1461
- */
1462
- Code?: string | undefined;
1463
- /**
1464
- * <p>The <code>error</code> query parameter provided by Cognito in the
1465
- * <code>redirectUri</code>.</p>
1466
- * @public
1467
- */
1468
- Error?: string | undefined;
1469
- /**
1470
- * <p>The <code>error_description</code> parameter provided by Cognito in the
1471
- * <code>redirectUri</code>.</p>
1472
- * @public
1473
- */
1474
- ErrorDescription?: string | undefined;
1475
- }
1476
- /**
1477
- * @public
1478
- */
1479
- export interface UpdateParticipantAuthenticationResponse {
1480
- }
1481
- /**
1482
- * @public
1483
- * @enum
1484
- */
1485
- export declare const TimerEligibleParticipantRoles: {
1486
- readonly AGENT: "AGENT";
1487
- readonly CUSTOMER: "CUSTOMER";
1488
- };
1489
- /**
1490
- * @public
1491
- */
1492
- export type TimerEligibleParticipantRoles = (typeof TimerEligibleParticipantRoles)[keyof typeof TimerEligibleParticipantRoles];
1493
- /**
1494
- * @public
1495
- * @enum
1496
- */
1497
- export declare const ParticipantTimerType: {
1498
- readonly DISCONNECT_NONCUSTOMER: "DISCONNECT_NONCUSTOMER";
1499
- readonly IDLE: "IDLE";
1500
- };
1501
- /**
1502
- * @public
1503
- */
1504
- export type ParticipantTimerType = (typeof ParticipantTimerType)[keyof typeof ParticipantTimerType];
1505
- /**
1506
- * @public
1507
- * @enum
1508
- */
1509
- export declare const ParticipantTimerAction: {
1510
- readonly Unset: "Unset";
1511
- };
1512
- /**
1513
- * @public
1514
- */
1515
- export type ParticipantTimerAction = (typeof ParticipantTimerAction)[keyof typeof ParticipantTimerAction];
1516
- /**
1517
- * <p>The value of the timer. Either the timer action (<code>Unset</code> to delete the timer), or
1518
- * the duration of the timer in minutes. Only one value can be set.</p>
1519
- * <p>For more information about how chat timeouts work, see
1520
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
1521
- * @public
1522
- */
1523
- export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember;
1524
- /**
1525
- * @public
1526
- */
1527
- export declare namespace ParticipantTimerValue {
1528
- /**
1529
- * <p>The timer action. Currently only one value is allowed: <code>Unset</code>. It deletes a
1530
- * timer.</p>
1531
- * @public
1532
- */
1533
- interface ParticipantTimerActionMember {
1534
- ParticipantTimerAction: ParticipantTimerAction;
1535
- ParticipantTimerDurationInMinutes?: never;
1536
- $unknown?: never;
1537
- }
1538
- /**
1539
- * <p>The duration of a timer, in minutes. </p>
1540
- * @public
1541
- */
1542
- interface ParticipantTimerDurationInMinutesMember {
1543
- ParticipantTimerAction?: never;
1544
- ParticipantTimerDurationInMinutes: number;
1545
- $unknown?: never;
1546
- }
1547
- /**
1548
- * @public
1549
- */
1550
- interface $UnknownMember {
1551
- ParticipantTimerAction?: never;
1552
- ParticipantTimerDurationInMinutes?: never;
1553
- $unknown: [string, any];
1554
- }
1555
- /**
1556
- * @deprecated unused in schema-serde mode.
1557
- *
1558
- */
1559
- interface Visitor<T> {
1560
- ParticipantTimerAction: (value: ParticipantTimerAction) => T;
1561
- ParticipantTimerDurationInMinutes: (value: number) => T;
1562
- _: (name: string, value: any) => T;
1563
- }
1564
- }
1565
- /**
1566
- * <p>Configuration information for the timer. After the timer configuration is set, it persists
1567
- * for the duration of the chat. It persists across new contacts in the chain, for example, transfer
1568
- * contacts.</p>
1569
- * <p>For more information about how chat timeouts work, see
1570
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </p>
1571
- * @public
1572
- */
1573
- export interface ParticipantTimerConfiguration {
1574
- /**
1575
- * <p>The role of the participant in the chat conversation.</p>
1576
- * @public
1577
- */
1578
- ParticipantRole: TimerEligibleParticipantRoles | undefined;
1579
- /**
1580
- * <p>The type of timer. <code>IDLE</code> indicates the timer applies for considering a human
1581
- * chat participant as idle. <code>DISCONNECT_NONCUSTOMER</code> indicates the timer applies to
1582
- * automatically disconnecting a chat participant due to idleness.</p>
1583
- * @public
1584
- */
1585
- TimerType: ParticipantTimerType | undefined;
1586
- /**
1587
- * <p>The value of the timer. Either the timer action (Unset to delete the timer), or the duration
1588
- * of the timer in minutes. Only one value can be set.</p>
1589
- * @public
1590
- */
1591
- TimerValue: ParticipantTimerValue | undefined;
1592
- }
1593
- /**
1594
- * <p>Configuration information for the chat participant role.</p>
1595
- * @public
1596
- */
1597
- export interface ChatParticipantRoleConfig {
1598
- /**
1599
- * <p>A list of participant timers. You can specify any unique combination of role and timer type.
1600
- * Duplicate entries error out the request with a 400.</p>
1601
- * @public
1602
- */
1603
- ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined;
1604
- }
1605
- /**
1606
- * <p>Configuration information for the chat participant role.</p>
1607
- * @public
1608
- */
1609
- export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember;
1610
- /**
1611
- * @public
1612
- */
1613
- export declare namespace UpdateParticipantRoleConfigChannelInfo {
1614
- /**
1615
- * <p>Configuration information for the chat participant role.</p>
1616
- * @public
1617
- */
1618
- interface ChatMember {
1619
- Chat: ChatParticipantRoleConfig;
1620
- $unknown?: never;
1621
- }
1622
- /**
1623
- * @public
1624
- */
1625
- interface $UnknownMember {
1626
- Chat?: never;
1627
- $unknown: [string, any];
1628
- }
1629
- /**
1630
- * @deprecated unused in schema-serde mode.
1631
- *
1632
- */
1633
- interface Visitor<T> {
1634
- Chat: (value: ChatParticipantRoleConfig) => T;
1635
- _: (name: string, value: any) => T;
1636
- }
1637
- }
1638
- /**
1639
- * @public
1640
- */
1641
- export interface UpdateParticipantRoleConfigRequest {
1642
- /**
1643
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1644
- * @public
1645
- */
1646
- InstanceId: string | undefined;
1647
- /**
1648
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
1649
- * @public
1650
- */
1651
- ContactId: string | undefined;
1652
- /**
1653
- * <p>The Amazon Connect channel you want to configure.</p>
1654
- * @public
1655
- */
1656
- ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
1657
- }
1658
- /**
1659
- * @public
1660
- */
1661
- export interface UpdateParticipantRoleConfigResponse {
1662
- }
1663
- /**
1664
- * @public
1665
- */
1666
- export interface UpdatePhoneNumberRequest {
1667
- /**
1668
- * <p>A unique identifier for the phone number.</p>
1669
- * @public
1670
- */
1671
- PhoneNumberId: string | undefined;
1672
- /**
1673
- * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
1674
- * @public
1675
- */
1676
- TargetArn?: string | undefined;
1677
- /**
1678
- * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
1679
- * can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
1680
- * instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
1681
- * @public
1682
- */
1683
- InstanceId?: string | undefined;
1684
- /**
1685
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1686
- * request. If not provided, the Amazon Web Services
1687
- * SDK populates this field. For more information about idempotency, see
1688
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1689
- * @public
1690
- */
1691
- ClientToken?: string | undefined;
1692
- }
1693
- /**
1694
- * @public
1695
- */
1696
- export interface UpdatePhoneNumberResponse {
1697
- /**
1698
- * <p>A unique identifier for the phone number.</p>
1699
- * @public
1700
- */
1701
- PhoneNumberId?: string | undefined;
1702
- /**
1703
- * <p>The Amazon Resource Name (ARN) of the phone number.</p>
1704
- * @public
1705
- */
1706
- PhoneNumberArn?: string | undefined;
1707
- }
1708
- /**
1709
- * @public
1710
- */
1711
- export interface UpdatePhoneNumberMetadataRequest {
1712
- /**
1713
- * <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
1714
- * @public
1715
- */
1716
- PhoneNumberId: string | undefined;
1717
- /**
1718
- * <p>The description of the phone number.</p>
1719
- * @public
1720
- */
1721
- PhoneNumberDescription?: string | undefined;
1722
- /**
1723
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1724
- * request. If not provided, the Amazon Web Services
1725
- * SDK populates this field. For more information about idempotency, see
1726
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1727
- * @public
1728
- */
1729
- ClientToken?: string | undefined;
1730
- }
1731
- /**
1732
- * @public
1733
- */
1734
- export interface UpdatePredefinedAttributeRequest {
1735
- /**
1736
- * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
1737
- * Name (ARN) of the instance.</p>
1738
- * @public
1739
- */
1740
- InstanceId: string | undefined;
1741
- /**
1742
- * <p>The name of the predefined attribute.</p>
1743
- * @public
1744
- */
1745
- Name: string | undefined;
1746
- /**
1747
- * <p>The values of the predefined attribute.</p>
1748
- * @public
1749
- */
1750
- Values?: PredefinedAttributeValues | undefined;
1751
- /**
1752
- * <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
1753
- * @public
1754
- */
1755
- Purposes?: string[] | undefined;
1756
- /**
1757
- * <p>Custom metadata that is associated to predefined attributes to control behavior
1758
- * in upstream services, such as controlling
1759
- * how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
1760
- * @public
1761
- */
1762
- AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
1763
- }
1764
- /**
1765
- * @public
1766
- */
1767
- export interface UpdatePromptRequest {
1768
- /**
1769
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1770
- * @public
1771
- */
1772
- InstanceId: string | undefined;
1773
- /**
1774
- * <p>A unique identifier for the prompt.</p>
1775
- * @public
1776
- */
1777
- PromptId: string | undefined;
1778
- /**
1779
- * <p>The name of the prompt.</p>
1780
- * @public
1781
- */
1782
- Name?: string | undefined;
1783
- /**
1784
- * <p>A description of the prompt.</p>
1785
- * @public
1786
- */
1787
- Description?: string | undefined;
1788
- /**
1789
- * <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
1790
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
1791
- * API instead of providing S3 URIs.</p>
1792
- * @public
1793
- */
1794
- S3Uri?: string | undefined;
1795
- }
1796
- /**
1797
- * @public
1798
- */
1799
- export interface UpdatePromptResponse {
1800
- /**
1801
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
1802
- * @public
1803
- */
1804
- PromptARN?: string | undefined;
1805
- /**
1806
- * <p>A unique identifier for the prompt.</p>
1807
- * @public
1808
- */
1809
- PromptId?: string | undefined;
1810
- }
1811
- /**
1812
- * @public
1813
- */
1814
- export interface UpdateQueueHoursOfOperationRequest {
1815
- /**
1816
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1817
- * @public
1818
- */
1819
- InstanceId: string | undefined;
1820
- /**
1821
- * <p>The identifier for the queue.</p>
1822
- * @public
1823
- */
1824
- QueueId: string | undefined;
1825
- /**
1826
- * <p>The identifier for the hours of operation.</p>
1827
- * @public
1828
- */
1829
- HoursOfOperationId: string | undefined;
1830
- }
1831
- /**
1832
- * @public
1833
- */
1834
- export interface UpdateQueueMaxContactsRequest {
1835
- /**
1836
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1837
- * @public
1838
- */
1839
- InstanceId: string | undefined;
1840
- /**
1841
- * <p>The identifier for the queue.</p>
1842
- * @public
1843
- */
1844
- QueueId: string | undefined;
1845
- /**
1846
- * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
1847
- * @public
1848
- */
1849
- MaxContacts?: number | undefined;
1850
- }
1851
- /**
1852
- * @public
1853
- */
1854
- export interface UpdateQueueNameRequest {
1855
- /**
1856
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1857
- * @public
1858
- */
1859
- InstanceId: string | undefined;
1860
- /**
1861
- * <p>The identifier for the queue.</p>
1862
- * @public
1863
- */
1864
- QueueId: string | undefined;
1865
- /**
1866
- * <p>The name of the queue.</p>
1867
- * @public
1868
- */
1869
- Name?: string | undefined;
1870
- /**
1871
- * <p>The description of the queue.</p>
1872
- * @public
1873
- */
1874
- Description?: string | undefined;
1875
- }
1876
- /**
1877
- * @public
1878
- */
1879
- export interface UpdateQueueOutboundCallerConfigRequest {
1880
- /**
1881
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1882
- * @public
1883
- */
1884
- InstanceId: string | undefined;
1885
- /**
1886
- * <p>The identifier for the queue.</p>
1887
- * @public
1888
- */
1889
- QueueId: string | undefined;
1890
- /**
1891
- * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
1892
- * @public
1893
- */
1894
- OutboundCallerConfig: OutboundCallerConfig | undefined;
1895
- }
1896
- /**
1897
- * @public
1898
- */
1899
- export interface UpdateQueueOutboundEmailConfigRequest {
1900
- /**
1901
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1902
- * @public
1903
- */
1904
- InstanceId: string | undefined;
1905
- /**
1906
- * <p>The identifier for the queue.</p>
1907
- * @public
1908
- */
1909
- QueueId: string | undefined;
1910
- /**
1911
- * <p>The outbound email address ID for a specified queue.</p>
1912
- * @public
1913
- */
1914
- OutboundEmailConfig: OutboundEmailConfig | undefined;
1915
- }
1916
- /**
1917
- * @public
1918
- */
1919
- export interface UpdateQueueStatusRequest {
1920
- /**
1921
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1922
- * @public
1923
- */
1924
- InstanceId: string | undefined;
1925
- /**
1926
- * <p>The identifier for the queue.</p>
1927
- * @public
1928
- */
1929
- QueueId: string | undefined;
1930
- /**
1931
- * <p>The status of the queue.</p>
1932
- * @public
1933
- */
1934
- Status: QueueStatus | undefined;
1935
- }
1936
- /**
1937
- * @public
1938
- */
1939
- export interface UpdateQuickConnectConfigRequest {
1940
- /**
1941
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1942
- * @public
1943
- */
1944
- InstanceId: string | undefined;
1945
- /**
1946
- * <p>The identifier for the quick connect.</p>
1947
- * @public
1948
- */
1949
- QuickConnectId: string | undefined;
1950
- /**
1951
- * <p>Information about the configuration settings for the quick connect.</p>
1952
- * @public
1953
- */
1954
- QuickConnectConfig: QuickConnectConfig | undefined;
1955
- }
1956
- /**
1957
- * @public
1958
- */
1959
- export interface UpdateQuickConnectNameRequest {
1960
- /**
1961
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1962
- * @public
1963
- */
1964
- InstanceId: string | undefined;
1965
- /**
1966
- * <p>The identifier for the quick connect.</p>
1967
- * @public
1968
- */
1969
- QuickConnectId: string | undefined;
1970
- /**
1971
- * <p>The name of the quick connect.</p>
1972
- * @public
1973
- */
1974
- Name?: string | undefined;
1975
- /**
1976
- * <p>The description of the quick connect.</p>
1977
- * @public
1978
- */
1979
- Description?: string | undefined;
1980
- }
1981
- /**
1982
- * @public
1983
- */
1984
- export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
1985
- /**
1986
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
1987
- * @public
1988
- */
1989
- InstanceId: string | undefined;
1990
- /**
1991
- * <p>The identifier of the routing profile.</p>
1992
- * @public
1993
- */
1994
- RoutingProfileId: string | undefined;
1995
- /**
1996
- * <p>Whether agents with this routing profile will have their routing order calculated based on
1997
- * <i>time since their last inbound contact</i> or <i>longest idle
1998
- * time</i>. </p>
1999
- * @public
2000
- */
2001
- AgentAvailabilityTimer: AgentAvailabilityTimer | undefined;
2002
- }
2003
- /**
2004
- * @public
2005
- */
2006
- export interface UpdateRoutingProfileConcurrencyRequest {
2007
- /**
2008
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2009
- * @public
2010
- */
2011
- InstanceId: string | undefined;
2012
- /**
2013
- * <p>The identifier of the routing profile.</p>
2014
- * @public
2015
- */
2016
- RoutingProfileId: string | undefined;
2017
- /**
2018
- * <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
2019
- * @public
2020
- */
2021
- MediaConcurrencies: MediaConcurrency[] | undefined;
2022
- }
2023
- /**
2024
- * @public
2025
- */
2026
- export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
2027
- /**
2028
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2029
- * @public
2030
- */
2031
- InstanceId: string | undefined;
2032
- /**
2033
- * <p>The identifier of the routing profile.</p>
2034
- * @public
2035
- */
2036
- RoutingProfileId: string | undefined;
2037
- /**
2038
- * <p>The identifier for the default outbound queue.</p>
2039
- * @public
2040
- */
2041
- DefaultOutboundQueueId: string | undefined;
2042
- }
2043
- /**
2044
- * @public
2045
- */
2046
- export interface UpdateRoutingProfileNameRequest {
2047
- /**
2048
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2049
- * @public
2050
- */
2051
- InstanceId: string | undefined;
2052
- /**
2053
- * <p>The identifier of the routing profile.</p>
2054
- * @public
2055
- */
2056
- RoutingProfileId: string | undefined;
2057
- /**
2058
- * <p>The name of the routing profile. Must not be more than 127 characters.</p>
2059
- * @public
2060
- */
2061
- Name?: string | undefined;
2062
- /**
2063
- * <p>The description of the routing profile. Must not be more than 250 characters.</p>
2064
- * @public
2065
- */
2066
- Description?: string | undefined;
2067
- }
2068
- /**
2069
- * @public
2070
- */
2071
- export interface UpdateRoutingProfileQueuesRequest {
2072
- /**
2073
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2074
- * @public
2075
- */
2076
- InstanceId: string | undefined;
2077
- /**
2078
- * <p>The identifier of the routing profile.</p>
2079
- * @public
2080
- */
2081
- RoutingProfileId: string | undefined;
2082
- /**
2083
- * <p>The queues to be updated for this routing profile.
2084
- * Queues must first be associated to the routing
2085
- * profile. You can do this using AssociateRoutingProfileQueues.</p>
2086
- * @public
2087
- */
2088
- QueueConfigs: RoutingProfileQueueConfig[] | undefined;
2089
- }
2090
- /**
2091
- * @public
2092
- */
2093
- export interface UpdateRuleRequest {
2094
- /**
2095
- * <p>A unique identifier for the rule.</p>
2096
- * @public
2097
- */
2098
- RuleId: string | undefined;
2099
- /**
2100
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2101
- * @public
2102
- */
2103
- InstanceId: string | undefined;
2104
- /**
2105
- * <p>The name of the rule. You can change the name only if <code>TriggerEventSource</code> is one
2106
- * of the following values: <code>OnZendeskTicketCreate</code> |
2107
- * <code>OnZendeskTicketStatusUpdate</code> | <code>OnSalesforceCaseCreate</code>
2108
- * </p>
2109
- * @public
2110
- */
2111
- Name: string | undefined;
2112
- /**
2113
- * <p>The conditions of the rule.</p>
2114
- * @public
2115
- */
2116
- Function: string | undefined;
2117
- /**
2118
- * <p>A list of actions to be run when the rule is triggered.</p>
2119
- * @public
2120
- */
2121
- Actions: RuleAction[] | undefined;
2122
- /**
2123
- * <p>The publish status of the rule.</p>
2124
- * @public
2125
- */
2126
- PublishStatus: RulePublishStatus | undefined;
2127
- }
2128
- /**
2129
- * @public
2130
- */
2131
- export interface UpdateSecurityProfileRequest {
2132
- /**
2133
- * <p>The description of the security profile.</p>
2134
- * @public
2135
- */
2136
- Description?: string | undefined;
2137
- /**
2138
- * <p>The permissions granted to a security profile. For a list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security
2139
- * profile permissions</a>.</p>
2140
- * @public
2141
- */
2142
- Permissions?: string[] | undefined;
2143
- /**
2144
- * <p>The identifier for the security profle.</p>
2145
- * @public
2146
- */
2147
- SecurityProfileId: string | undefined;
2148
- /**
2149
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2150
- * @public
2151
- */
2152
- InstanceId: string | undefined;
2153
- /**
2154
- * <p>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</p>
2155
- * @public
2156
- */
2157
- AllowedAccessControlTags?: Record<string, string> | undefined;
2158
- /**
2159
- * <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</p>
2160
- * @public
2161
- */
2162
- TagRestrictedResources?: string[] | undefined;
2163
- /**
2164
- * <p>A list of the third-party application's metadata.</p>
2165
- * @public
2166
- */
2167
- Applications?: Application[] | undefined;
2168
- /**
2169
- * <p>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code>.</p>
2170
- * @public
2171
- */
2172
- HierarchyRestrictedResources?: string[] | undefined;
2173
- /**
2174
- * <p>The identifier of the hierarchy group that a security profile uses to restrict access to
2175
- * resources in Amazon Connect.</p>
2176
- * @public
2177
- */
2178
- AllowedAccessControlHierarchyGroupId?: string | undefined;
2179
- }
2180
- /**
2181
- * @public
2182
- */
2183
- export interface UpdateTaskTemplateRequest {
2184
- /**
2185
- * <p>A unique identifier for the task template.</p>
2186
- * @public
2187
- */
2188
- TaskTemplateId: string | undefined;
2189
- /**
2190
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2191
- * @public
2192
- */
2193
- InstanceId: string | undefined;
2194
- /**
2195
- * <p>The name of the task template.</p>
2196
- * @public
2197
- */
2198
- Name?: string | undefined;
2199
- /**
2200
- * <p>The description of the task template.</p>
2201
- * @public
2202
- */
2203
- Description?: string | undefined;
2204
- /**
2205
- * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
2206
- * @public
2207
- */
2208
- ContactFlowId?: string | undefined;
2209
- /**
2210
- * <p>The ContactFlowId for the flow that will be run if this template is used to create a
2211
- * self-assigned task.</p>
2212
- * @public
2213
- */
2214
- SelfAssignFlowId?: string | undefined;
2215
- /**
2216
- * <p>Constraints that are applicable to the fields listed.</p>
2217
- * @public
2218
- */
2219
- Constraints?: TaskTemplateConstraints | undefined;
2220
- /**
2221
- * <p>The default values for fields when a task is created by referencing this template.</p>
2222
- * @public
2223
- */
2224
- Defaults?: TaskTemplateDefaults | undefined;
2225
- /**
2226
- * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
2227
- * Tasks can only be created from <code>ACTIVE</code> templates.
2228
- * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
2229
- * @public
2230
- */
2231
- Status?: TaskTemplateStatus | undefined;
2232
- /**
2233
- * <p>Fields that are part of the template.</p>
2234
- * @public
2235
- */
2236
- Fields?: TaskTemplateField[] | undefined;
2237
- }
2238
- /**
2239
- * @public
2240
- */
2241
- export interface UpdateTaskTemplateResponse {
2242
- /**
2243
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2244
- * @public
2245
- */
2246
- InstanceId?: string | undefined;
2247
- /**
2248
- * <p>The identifier of the task template resource.</p>
2249
- * @public
2250
- */
2251
- Id?: string | undefined;
2252
- /**
2253
- * <p>The Amazon Resource Name (ARN) for the task template resource.</p>
2254
- * @public
2255
- */
2256
- Arn?: string | undefined;
2257
- /**
2258
- * <p>The name of the task template.</p>
2259
- * @public
2260
- */
2261
- Name?: string | undefined;
2262
- /**
2263
- * <p>The description of the task template.</p>
2264
- * @public
2265
- */
2266
- Description?: string | undefined;
2267
- /**
2268
- * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
2269
- * @public
2270
- */
2271
- ContactFlowId?: string | undefined;
2272
- /**
2273
- * <p>The ContactFlowId for the flow that will be run if this template is used to create a
2274
- * self-assigned task.</p>
2275
- * @public
2276
- */
2277
- SelfAssignFlowId?: string | undefined;
2278
- /**
2279
- * <p>Constraints that are applicable to the fields listed.</p>
2280
- * @public
2281
- */
2282
- Constraints?: TaskTemplateConstraints | undefined;
2283
- /**
2284
- * <p>The default values for fields when a task is created by referencing this template.</p>
2285
- * @public
2286
- */
2287
- Defaults?: TaskTemplateDefaults | undefined;
2288
- /**
2289
- * <p>Fields that are part of the template.</p>
2290
- * @public
2291
- */
2292
- Fields?: TaskTemplateField[] | undefined;
2293
- /**
2294
- * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
2295
- * Tasks can only be created from <code>ACTIVE</code> templates.
2296
- * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
2297
- * @public
2298
- */
2299
- Status?: TaskTemplateStatus | undefined;
2300
- /**
2301
- * <p>The timestamp when the task template was last modified.</p>
2302
- * @public
2303
- */
2304
- LastModifiedTime?: Date | undefined;
2305
- /**
2306
- * <p>The timestamp when the task template was created.</p>
2307
- * @public
2308
- */
2309
- CreatedTime?: Date | undefined;
2310
- }
2311
- /**
2312
- * @public
2313
- */
2314
- export interface UpdateTrafficDistributionRequest {
2315
- /**
2316
- * <p>The identifier of the traffic distribution group.
2317
- * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
2318
- * The ARN must be provided if the call is from the replicated Region. </p>
2319
- * @public
2320
- */
2321
- Id: string | undefined;
2322
- /**
2323
- * <p>The distribution of traffic between the instance and its replica(s).</p>
2324
- * @public
2325
- */
2326
- TelephonyConfig?: TelephonyConfig | undefined;
2327
- /**
2328
- * <p>The distribution that determines which Amazon Web Services Regions should be used to sign in
2329
- * agents in to both the instance and its replica(s).</p>
2330
- * @public
2331
- */
2332
- SignInConfig?: SignInConfig | undefined;
2333
- /**
2334
- * <p>The distribution of agents between the instance and its replica(s).</p>
2335
- * @public
2336
- */
2337
- AgentConfig?: AgentConfig | undefined;
2338
- }
2339
- /**
2340
- * @public
2341
- */
2342
- export interface UpdateTrafficDistributionResponse {
2343
- }
2344
- /**
2345
- * @public
2346
- */
2347
- export interface UpdateUserHierarchyRequest {
2348
- /**
2349
- * <p>The identifier of the hierarchy group.</p>
2350
- * @public
2351
- */
2352
- HierarchyGroupId?: string | undefined;
2353
- /**
2354
- * <p>The identifier of the user account.</p>
2355
- * @public
2356
- */
2357
- UserId: string | undefined;
2358
- /**
2359
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2360
- * @public
2361
- */
2362
- InstanceId: string | undefined;
2363
- }
2364
- /**
2365
- * @public
2366
- */
2367
- export interface UpdateUserHierarchyGroupNameRequest {
2368
- /**
2369
- * <p>The name of the hierarchy group. Must not be more than 100 characters.</p>
2370
- * @public
2371
- */
2372
- Name: string | undefined;
2373
- /**
2374
- * <p>The identifier of the hierarchy group.</p>
2375
- * @public
2376
- */
2377
- HierarchyGroupId: string | undefined;
2378
- /**
2379
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2380
- * @public
2381
- */
2382
- InstanceId: string | undefined;
2383
- }
2384
- /**
2385
- * <p>Contains information about the hierarchy level to update.</p>
2386
- * @public
2387
- */
2388
- export interface HierarchyLevelUpdate {
2389
- /**
2390
- * <p>The name of the user hierarchy level. Must not be more than 50 characters.</p>
2391
- * @public
2392
- */
2393
- Name: string | undefined;
2394
- }
2395
- /**
2396
- * <p>Contains information about the level hierarchy to update.</p>
2397
- * @public
2398
- */
2399
- export interface HierarchyStructureUpdate {
2400
- /**
2401
- * <p>The
2402
- * update
2403
- * for level one.</p>
2404
- * @public
2405
- */
2406
- LevelOne?: HierarchyLevelUpdate | undefined;
2407
- /**
2408
- * <p>The update for level two.</p>
2409
- * @public
2410
- */
2411
- LevelTwo?: HierarchyLevelUpdate | undefined;
2412
- /**
2413
- * <p>The update for level three.</p>
2414
- * @public
2415
- */
2416
- LevelThree?: HierarchyLevelUpdate | undefined;
2417
- /**
2418
- * <p>The update for level four.</p>
2419
- * @public
2420
- */
2421
- LevelFour?: HierarchyLevelUpdate | undefined;
2422
- /**
2423
- * <p>The update for level five.</p>
2424
- * @public
2425
- */
2426
- LevelFive?: HierarchyLevelUpdate | undefined;
2427
- }
2428
- /**
2429
- * @public
2430
- */
2431
- export interface UpdateUserHierarchyStructureRequest {
2432
- /**
2433
- * <p>The hierarchy levels to update.</p>
2434
- * @public
2435
- */
2436
- HierarchyStructure: HierarchyStructureUpdate | undefined;
2437
- /**
2438
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2439
- * @public
2440
- */
2441
- InstanceId: string | undefined;
2442
- }
2443
- /**
2444
- * @public
2445
- */
2446
- export interface UpdateUserIdentityInfoRequest {
2447
- /**
2448
- * <p>The identity information for the user.</p>
2449
- * @public
2450
- */
2451
- IdentityInfo: UserIdentityInfo | undefined;
2452
- /**
2453
- * <p>The identifier of the user account.</p>
2454
- * @public
2455
- */
2456
- UserId: string | undefined;
2457
- /**
2458
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2459
- * @public
2460
- */
2461
- InstanceId: string | undefined;
2462
- }
2463
- /**
2464
- * @public
2465
- */
2466
- export interface UpdateUserPhoneConfigRequest {
2467
- /**
2468
- * <p>Information about phone configuration settings for the user.</p>
2469
- * @public
2470
- */
2471
- PhoneConfig: UserPhoneConfig | undefined;
2472
- /**
2473
- * <p>The identifier of the user account.</p>
2474
- * @public
2475
- */
2476
- UserId: string | undefined;
2477
- /**
2478
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2479
- * @public
2480
- */
2481
- InstanceId: string | undefined;
2482
- }
2483
- /**
2484
- * @public
2485
- */
2486
- export interface UpdateUserProficienciesRequest {
2487
- /**
2488
- * <p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
2489
- * Name (ARN) of the instance.</p>
2490
- * @public
2491
- */
2492
- InstanceId: string | undefined;
2493
- /**
2494
- * <p>The identifier of the user account.</p>
2495
- * @public
2496
- */
2497
- UserId: string | undefined;
2498
- /**
2499
- * <p>The proficiencies to be updated for the user. Proficiencies must first be associated to the
2500
- * user. You can do this using AssociateUserProficiencies API.</p>
2501
- * @public
2502
- */
2503
- UserProficiencies: UserProficiency[] | undefined;
2504
- }
2505
- /**
2506
- * @public
2507
- */
2508
- export interface UpdateUserRoutingProfileRequest {
2509
- /**
2510
- * <p>The identifier of the routing profile for the user.</p>
2511
- * @public
2512
- */
2513
- RoutingProfileId: string | undefined;
2514
- /**
2515
- * <p>The identifier of the user account.</p>
2516
- * @public
2517
- */
2518
- UserId: string | undefined;
2519
- /**
2520
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2521
- * @public
2522
- */
2523
- InstanceId: string | undefined;
2524
- }
2525
- /**
2526
- * @public
2527
- */
2528
- export interface UpdateUserSecurityProfilesRequest {
2529
- /**
2530
- * <p>The identifiers of the security profiles for the user.</p>
2531
- * @public
2532
- */
2533
- SecurityProfileIds: string[] | undefined;
2534
- /**
2535
- * <p>The identifier of the user account.</p>
2536
- * @public
2537
- */
2538
- UserId: string | undefined;
2539
- /**
2540
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
2541
- * @public
2542
- */
2543
- InstanceId: string | undefined;
2544
- }
2545
- /**
2546
- * @public
2547
- */
2548
- export interface UpdateViewContentRequest {
2549
- /**
2550
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
2551
- * the instance.</p>
2552
- * @public
2553
- */
2554
- InstanceId: string | undefined;
2555
- /**
2556
- * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
2557
- * used.</p>
2558
- * @public
2559
- */
2560
- ViewId: string | undefined;
2561
- /**
2562
- * <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
2563
- * <code>PUBLISHED</code> status will initiate validation on the content.</p>
2564
- * @public
2565
- */
2566
- Status: ViewStatus | undefined;
2567
- /**
2568
- * <p>View content containing all content necessary to render a view except for runtime input data
2569
- * and the runtime input schema, which is auto-generated by this operation.</p>
2570
- * <p>The total uncompressed content has a maximum file size of 400kB.</p>
2571
- * @public
2572
- */
2573
- Content: ViewInputContent | undefined;
2574
- }
2575
- /**
2576
- * @public
2577
- */
2578
- export interface UpdateViewContentResponse {
2579
- /**
2580
- * <p>A view resource object. Contains metadata and content necessary to render the view.</p>
2581
- * @public
2582
- */
2583
- View?: View | undefined;
2584
- }
2585
- /**
2586
- * @public
2587
- */
2588
- export interface UpdateViewMetadataRequest {
2589
- /**
2590
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
2591
- * the instance.</p>
2592
- * @public
2593
- */
2594
- InstanceId: string | undefined;
2595
- /**
2596
- * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
2597
- * used.</p>
2598
- * @public
2599
- */
2600
- ViewId: string | undefined;
2601
- /**
2602
- * <p>The name of the view.</p>
2603
- * @public
2604
- */
2605
- Name?: string | undefined;
2606
- /**
2607
- * <p>The description of the view.</p>
2608
- * @public
2609
- */
2610
- Description?: string | undefined;
2611
- }
2612
- /**
2613
- * @public
2614
- */
2615
- export interface UpdateViewMetadataResponse {
2616
- }
2617
- /**
2618
- * <p>A condition for item enablement.</p>
2619
- * @public
2620
- */
2621
- export interface EvaluationFormItemEnablementCondition {
2622
- /**
2623
- * <p>Operands of the enablement condition.</p>
2624
- * @public
2625
- */
2626
- Operands: EvaluationFormItemEnablementConditionOperand[] | undefined;
2627
- /**
2628
- * <p>The operator to be used to be applied to operands if more than one provided. </p>
2629
- * @public
2630
- */
2631
- Operator?: EvaluationFormItemEnablementOperator | undefined;
2632
- }
2633
- /**
2634
- * <p>An operand of the enablement condition.</p>
2635
- * @public
2636
- */
2637
- export type EvaluationFormItemEnablementConditionOperand = EvaluationFormItemEnablementConditionOperand.ConditionMember | EvaluationFormItemEnablementConditionOperand.ExpressionMember | EvaluationFormItemEnablementConditionOperand.$UnknownMember;
2638
- /**
2639
- * @public
2640
- */
2641
- export declare namespace EvaluationFormItemEnablementConditionOperand {
2642
- /**
2643
- * <p>An expression of the enablement condition.</p>
2644
- * @public
2645
- */
2646
- interface ExpressionMember {
2647
- Expression: EvaluationFormItemEnablementExpression;
2648
- Condition?: never;
2649
- $unknown?: never;
2650
- }
2651
- /**
2652
- * <p>A condition for item enablement.</p>
2653
- * @public
2654
- */
2655
- interface ConditionMember {
2656
- Expression?: never;
2657
- Condition: EvaluationFormItemEnablementCondition;
2658
- $unknown?: never;
2659
- }
2660
- /**
2661
- * @public
2662
- */
2663
- interface $UnknownMember {
2664
- Expression?: never;
2665
- Condition?: never;
2666
- $unknown: [string, any];
2667
- }
2668
- /**
2669
- * @deprecated unused in schema-serde mode.
2670
- *
2671
- */
2672
- interface Visitor<T> {
2673
- Expression: (value: EvaluationFormItemEnablementExpression) => T;
2674
- Condition: (value: EvaluationFormItemEnablementCondition) => T;
2675
- _: (name: string, value: any) => T;
2676
- }
2677
- }
2678
- /**
2679
- * <p>The search criteria to be used to return agent statuses.</p>
2680
- * @public
2681
- */
2682
- export interface AgentStatusSearchCriteria {
2683
- /**
2684
- * <p>A list of conditions which would be applied together with an <code>OR</code>
2685
- * condition.</p>
2686
- * @public
2687
- */
2688
- OrConditions?: AgentStatusSearchCriteria[] | undefined;
2689
- /**
2690
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2691
- * <note>
2692
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
2693
- * <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
2694
- * and <code>resourceID</code>.</p>
2695
- * </note>
2696
- * @public
2697
- */
2698
- AndConditions?: AgentStatusSearchCriteria[] | undefined;
2699
- /**
2700
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2701
- * <note>
2702
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
2703
- * <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
2704
- * and <code>resourceID</code>.</p>
2705
- * </note>
2706
- * @public
2707
- */
2708
- StringCondition?: StringCondition | undefined;
2709
- }
2710
- /**
2711
- * <p>The search criteria to be used to return flow modules.</p>
2712
- * @public
2713
- */
2714
- export interface ContactFlowModuleSearchCriteria {
2715
- /**
2716
- * <p>A list of conditions which would be applied together with an <code>OR</code>
2717
- * condition.</p>
2718
- * @public
2719
- */
2720
- OrConditions?: ContactFlowModuleSearchCriteria[] | undefined;
2721
- /**
2722
- * <p>A list of conditions which would be applied together with an <code>AND</code>
2723
- * condition.</p>
2724
- * @public
2725
- */
2726
- AndConditions?: ContactFlowModuleSearchCriteria[] | undefined;
2727
- /**
2728
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2729
- * @public
2730
- */
2731
- StringCondition?: StringCondition | undefined;
2732
- /**
2733
- * <p>The state of the flow.</p>
2734
- * @public
2735
- */
2736
- StateCondition?: ContactFlowModuleState | undefined;
2737
- /**
2738
- * <p>The status of the flow.</p>
2739
- * @public
2740
- */
2741
- StatusCondition?: ContactFlowModuleStatus | undefined;
2742
- }
2743
- /**
2744
- * <p>The search criteria to be used to return flows.</p>
2745
- * @public
2746
- */
2747
- export interface ContactFlowSearchCriteria {
2748
- /**
2749
- * <p>A list of conditions which would be applied together with an <code>OR</code>
2750
- * condition.</p>
2751
- * @public
2752
- */
2753
- OrConditions?: ContactFlowSearchCriteria[] | undefined;
2754
- /**
2755
- * <p>A list of conditions which would be applied together with an <code>AND</code>
2756
- * condition.</p>
2757
- * @public
2758
- */
2759
- AndConditions?: ContactFlowSearchCriteria[] | undefined;
2760
- /**
2761
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2762
- * @public
2763
- */
2764
- StringCondition?: StringCondition | undefined;
2765
- /**
2766
- * <p>The type of flow.</p>
2767
- * @public
2768
- */
2769
- TypeCondition?: ContactFlowType | undefined;
2770
- /**
2771
- * <p>The state of the flow.</p>
2772
- * @public
2773
- */
2774
- StateCondition?: ContactFlowState | undefined;
2775
- /**
2776
- * <p>The status of the flow.</p>
2777
- * @public
2778
- */
2779
- StatusCondition?: ContactFlowStatus | undefined;
2780
- }
2781
- /**
2782
- * <p>The search criteria to be used to return email addresses.</p>
2783
- * @public
2784
- */
2785
- export interface EmailAddressSearchCriteria {
2786
- /**
2787
- * <p>A list of conditions which would be applied together with an OR condition.</p>
2788
- * @public
2789
- */
2790
- OrConditions?: EmailAddressSearchCriteria[] | undefined;
2791
- /**
2792
- * <p>A list of conditions which would be applied together with an AND condition.</p>
2793
- * @public
2794
- */
2795
- AndConditions?: EmailAddressSearchCriteria[] | undefined;
2796
- /**
2797
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2798
- * @public
2799
- */
2800
- StringCondition?: StringCondition | undefined;
2801
- }
2802
- /**
2803
- * <p>An item enablement configuration.</p>
2804
- * @public
2805
- */
2806
- export interface EvaluationFormItemEnablementConfiguration {
2807
- /**
2808
- * <p>A condition for item enablement configuration.</p>
2809
- * @public
2810
- */
2811
- Condition: EvaluationFormItemEnablementCondition | undefined;
2812
- /**
2813
- * <p>An enablement action that if condition is satisfied. </p>
2814
- * @public
2815
- */
2816
- Action: EvaluationFormItemEnablementAction | undefined;
2817
- /**
2818
- * <p>An enablement action that if condition is not satisfied. </p>
2819
- * @public
2820
- */
2821
- DefaultAction?: EvaluationFormItemEnablementAction | undefined;
2822
- }
2823
- /**
2824
- * <p>The search criteria to be used to return evaluation forms.</p>
2825
- * @public
2826
- */
2827
- export interface EvaluationFormSearchCriteria {
2828
- /**
2829
- * <p>A list of conditions which would be applied together with an OR condition.</p>
2830
- * @public
2831
- */
2832
- OrConditions?: EvaluationFormSearchCriteria[] | undefined;
2833
- /**
2834
- * <p>A list of conditions which would be applied together with an AND condition.</p>
2835
- * @public
2836
- */
2837
- AndConditions?: EvaluationFormSearchCriteria[] | undefined;
2838
- /**
2839
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2840
- * @public
2841
- */
2842
- StringCondition?: StringCondition | undefined;
2843
- /**
2844
- * <p>A leaf node condition which can be used to specify a numeric condition.</p>
2845
- * <note>
2846
- * <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
2847
- * </note>
2848
- * @public
2849
- */
2850
- NumberCondition?: NumberCondition | undefined;
2851
- /**
2852
- * <p>Boolean search condition.</p>
2853
- * @public
2854
- */
2855
- BooleanCondition?: BooleanCondition | undefined;
2856
- /**
2857
- * <p>Datetime search condition.</p>
2858
- * @public
2859
- */
2860
- DateTimeCondition?: DateTimeCondition | undefined;
2861
- }
2862
- /**
2863
- * <p>The search criteria to be used to return evaluations.</p>
2864
- * @public
2865
- */
2866
- export interface EvaluationSearchCriteria {
2867
- /**
2868
- * <p>A list of conditions which would be applied together with an OR condition.</p>
2869
- * @public
2870
- */
2871
- OrConditions?: EvaluationSearchCriteria[] | undefined;
2872
- /**
2873
- * <p>A list of conditions which would be applied together with an AND condition.</p>
2874
- * @public
2875
- */
2876
- AndConditions?: EvaluationSearchCriteria[] | undefined;
2877
- /**
2878
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2879
- * @public
2880
- */
2881
- StringCondition?: StringCondition | undefined;
2882
- /**
2883
- * <p>A leaf node condition which can be used to specify a numeric condition.</p>
2884
- * <note>
2885
- * <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
2886
- * </note>
2887
- * @public
2888
- */
2889
- NumberCondition?: NumberCondition | undefined;
2890
- /**
2891
- * <p>The boolean condition search criteria for searching evaluations.</p>
2892
- * @public
2893
- */
2894
- BooleanCondition?: BooleanCondition | undefined;
2895
- /**
2896
- * <p>The datetime condition search criteria for searching evaluations.</p>
2897
- * @public
2898
- */
2899
- DateTimeCondition?: DateTimeCondition | undefined;
2900
- /**
2901
- * <p>The decimal condition search criteria for searching evaluations.</p>
2902
- * @public
2903
- */
2904
- DecimalCondition?: DecimalCondition | undefined;
2905
- }
2906
- /**
2907
- * <p>A tagged union to specify expression for a routing step.</p>
2908
- * @public
2909
- */
2910
- export interface Expression {
2911
- /**
2912
- * <p>An object to specify the predefined attribute condition.</p>
2913
- * @public
2914
- */
2915
- AttributeCondition?: AttributeCondition | undefined;
2916
- /**
2917
- * <p>List of routing expressions which will be AND-ed together.</p>
2918
- * @public
2919
- */
2920
- AndExpression?: Expression[] | undefined;
2921
- /**
2922
- * <p>List of routing expressions which will be OR-ed together.</p>
2923
- * @public
2924
- */
2925
- OrExpression?: Expression[] | undefined;
2926
- /**
2927
- * <p>An object to specify the predefined attribute condition.</p>
2928
- * @public
2929
- */
2930
- NotAttributeCondition?: AttributeCondition | undefined;
2931
- }
2932
- /**
2933
- * <p>The search criteria to be used to return hours of operations overrides.</p>
2934
- * @public
2935
- */
2936
- export interface HoursOfOperationOverrideSearchCriteria {
2937
- /**
2938
- * <p>A list of conditions which would be applied together with an OR condition.</p>
2939
- * @public
2940
- */
2941
- OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
2942
- /**
2943
- * <p>A list of conditions which would be applied together with an AND condition.</p>
2944
- * @public
2945
- */
2946
- AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
2947
- /**
2948
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2949
- * @public
2950
- */
2951
- StringCondition?: StringCondition | undefined;
2952
- /**
2953
- * <p>A leaf node condition which can be used to specify a date condition.</p>
2954
- * @public
2955
- */
2956
- DateCondition?: DateCondition | undefined;
2957
- }
2958
- /**
2959
- * <p>The search criteria to be used to return hours of operations.</p>
2960
- * @public
2961
- */
2962
- export interface HoursOfOperationSearchCriteria {
2963
- /**
2964
- * <p>A list of conditions which would be applied together with an OR condition.</p>
2965
- * @public
2966
- */
2967
- OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
2968
- /**
2969
- * <p>A list of conditions which would be applied together with an AND condition.</p>
2970
- * @public
2971
- */
2972
- AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
2973
- /**
2974
- * <p>A leaf node condition which can be used to specify a string condition.</p>
2975
- * <note>
2976
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
2977
- * <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
2978
- * </note>
2979
- * @public
2980
- */
2981
- StringCondition?: StringCondition | undefined;
2982
- }
2983
- /**
2984
- * <p>The search criteria to be used to return predefined attributes.</p>
2985
- * @public
2986
- */
2987
- export interface PredefinedAttributeSearchCriteria {
2988
- /**
2989
- * <p>A list of conditions which would be applied together with an <code>OR</code>
2990
- * condition.</p>
2991
- * @public
2992
- */
2993
- OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
2994
- /**
2995
- * <p>A list of conditions which would be applied together with an <code>AND</code>
2996
- * condition.</p>
2997
- * @public
2998
- */
2999
- AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
3000
- /**
3001
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3002
- * @public
3003
- */
3004
- StringCondition?: StringCondition | undefined;
3005
- }
3006
- /**
3007
- * <p>The search criteria to be used to return prompts.</p>
3008
- * @public
3009
- */
3010
- export interface PromptSearchCriteria {
3011
- /**
3012
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3013
- * @public
3014
- */
3015
- OrConditions?: PromptSearchCriteria[] | undefined;
3016
- /**
3017
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3018
- * @public
3019
- */
3020
- AndConditions?: PromptSearchCriteria[] | undefined;
3021
- /**
3022
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3023
- * <note>
3024
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
3025
- * <code>description</code>, and <code>resourceID</code>.</p>
3026
- * </note>
3027
- * @public
3028
- */
3029
- StringCondition?: StringCondition | undefined;
3030
- }
3031
- /**
3032
- * <p>The search criteria to be used to return queues.</p>
3033
- * <note>
3034
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3035
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3036
- * outside of this range will throw invalid results. </p>
3037
- * </note>
3038
- * @public
3039
- */
3040
- export interface QueueSearchCriteria {
3041
- /**
3042
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3043
- * @public
3044
- */
3045
- OrConditions?: QueueSearchCriteria[] | undefined;
3046
- /**
3047
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3048
- * @public
3049
- */
3050
- AndConditions?: QueueSearchCriteria[] | undefined;
3051
- /**
3052
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3053
- * <note>
3054
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
3055
- * <code>description</code>, and <code>resourceID</code>.</p>
3056
- * </note>
3057
- * @public
3058
- */
3059
- StringCondition?: StringCondition | undefined;
3060
- /**
3061
- * <p>The type of queue.</p>
3062
- * @public
3063
- */
3064
- QueueTypeCondition?: SearchableQueueType | undefined;
3065
- }
3066
- /**
3067
- * <p>The search criteria to be used to return quick connects.</p>
3068
- * @public
3069
- */
3070
- export interface QuickConnectSearchCriteria {
3071
- /**
3072
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3073
- * @public
3074
- */
3075
- OrConditions?: QuickConnectSearchCriteria[] | undefined;
3076
- /**
3077
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3078
- * @public
3079
- */
3080
- AndConditions?: QuickConnectSearchCriteria[] | undefined;
3081
- /**
3082
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3083
- * <note>
3084
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
3085
- * <code>description</code>, and <code>resourceID</code>.</p>
3086
- * </note>
3087
- * @public
3088
- */
3089
- StringCondition?: StringCondition | undefined;
3090
- }
3091
- /**
3092
- * <p>The search criteria to be used to return routing profiles.</p>
3093
- * <note>
3094
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3095
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3096
- * outside of this range will throw invalid results. </p>
3097
- * </note>
3098
- * @public
3099
- */
3100
- export interface RoutingProfileSearchCriteria {
3101
- /**
3102
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3103
- * @public
3104
- */
3105
- OrConditions?: RoutingProfileSearchCriteria[] | undefined;
3106
- /**
3107
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3108
- * @public
3109
- */
3110
- AndConditions?: RoutingProfileSearchCriteria[] | undefined;
3111
- /**
3112
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3113
- * <note>
3114
- * <p>The currently supported values for <code>FieldName</code> are
3115
- * <code>associatedQueueIds</code>, <code>name</code>, <code>description</code>, and
3116
- * <code>resourceID</code>.</p>
3117
- * </note>
3118
- * @public
3119
- */
3120
- StringCondition?: StringCondition | undefined;
3121
- }
3122
- /**
3123
- * <p>The search criteria to be used to return security profiles.</p>
3124
- * <note>
3125
- * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
3126
- * maximum of 25 characters. Any queries with character lengths outside of this range will throw
3127
- * invalid results.</p>
3128
- * </note>
3129
- * @public
3130
- */
3131
- export interface SecurityProfileSearchCriteria {
3132
- /**
3133
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3134
- * @public
3135
- */
3136
- OrConditions?: SecurityProfileSearchCriteria[] | undefined;
3137
- /**
3138
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3139
- * @public
3140
- */
3141
- AndConditions?: SecurityProfileSearchCriteria[] | undefined;
3142
- /**
3143
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3144
- * @public
3145
- */
3146
- StringCondition?: StringCondition | undefined;
3147
- }
3148
- /**
3149
- * <p>A value for a segment attribute. This is structured as a map where the key is
3150
- * <code>valueString</code> and the value is a string.</p>
3151
- * @public
3152
- */
3153
- export interface SegmentAttributeValue {
3154
- /**
3155
- * <p>The value of a segment attribute.</p>
3156
- * @public
3157
- */
3158
- ValueString?: string | undefined;
3159
- /**
3160
- * <p>The value of a segment attribute.</p>
3161
- * @public
3162
- */
3163
- ValueMap?: Record<string, SegmentAttributeValue> | undefined;
3164
- /**
3165
- * <p>The value of a segment attribute.</p>
3166
- * @public
3167
- */
3168
- ValueInteger?: number | undefined;
3169
- /**
3170
- * <p>The value of a segment attribute. This is only supported for system-defined attributes, not
3171
- * for user-defined attributes.</p>
3172
- * @public
3173
- */
3174
- ValueList?: SegmentAttributeValue[] | undefined;
3175
- /**
3176
- * <p>The value of a segment attribute that has to be a valid ARN. This is only supported for
3177
- * system-defined attributes, not for user-defined attributes.</p>
3178
- * @public
3179
- */
3180
- ValueArn?: string | undefined;
3181
- }
3182
- /**
3183
- * <p>The search criteria to be used to return userHierarchyGroup.</p>
3184
- * @public
3185
- */
3186
- export interface UserHierarchyGroupSearchCriteria {
3187
- /**
3188
- * <p>A list of conditions which would be applied together with an OR condition.</p>
3189
- * @public
3190
- */
3191
- OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
3192
- /**
3193
- * <p>A list of conditions which would be applied together with an AND condition.</p>
3194
- * @public
3195
- */
3196
- AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
3197
- /**
3198
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3199
- * <note>
3200
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
3201
- * <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
3202
- * </note>
3203
- * @public
3204
- */
3205
- StringCondition?: StringCondition | undefined;
3206
- }
3207
- /**
3208
- * <p>The search criteria to be used to return users.</p>
3209
- * <note>
3210
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3211
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3212
- * outside of this range will throw invalid results. </p>
3213
- * </note>
3214
- * @public
3215
- */
3216
- export interface UserSearchCriteria {
3217
- /**
3218
- * <p>A list of conditions which would be applied together with an <code>OR</code>
3219
- * condition.</p>
3220
- * @public
3221
- */
3222
- OrConditions?: UserSearchCriteria[] | undefined;
3223
- /**
3224
- * <p>A list of conditions which would be applied together with an <code>AND</code> condition.
3225
- * </p>
3226
- * @public
3227
- */
3228
- AndConditions?: UserSearchCriteria[] | undefined;
3229
- /**
3230
- * <p>A leaf node condition which can be used to specify a string condition.</p>
3231
- * <p>The currently supported values for <code>FieldName</code> are <code>Username</code>,
3232
- * <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>,
3233
- * <code>SecurityProfileId</code>, <code>resourceId</code>.</p>
3234
- * @public
3235
- */
3236
- StringCondition?: StringCondition | undefined;
3237
- /**
3238
- * <p>A leaf node condition which can be used to specify a List condition to search users with
3239
- * attributes included in Lists like Proficiencies.</p>
3240
- * @public
3241
- */
3242
- ListCondition?: ListCondition | undefined;
3243
- /**
3244
- * <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
3245
- * @public
3246
- */
3247
- HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
3248
- }
3249
- /**
3250
- * <p>Information about a question from an evaluation form.</p>
3251
- * @public
3252
- */
3253
- export interface EvaluationFormQuestion {
3254
- /**
3255
- * <p>The title of the question.</p>
3256
- * @public
3257
- */
3258
- Title: string | undefined;
3259
- /**
3260
- * <p>The instructions of the section.</p>
3261
- * @public
3262
- */
3263
- Instructions?: string | undefined;
3264
- /**
3265
- * <p>The identifier of the question. An identifier must be unique within the evaluation
3266
- * form.</p>
3267
- * @public
3268
- */
3269
- RefId: string | undefined;
3270
- /**
3271
- * <p>The flag to enable not applicable answers to the question.</p>
3272
- * @public
3273
- */
3274
- NotApplicableEnabled?: boolean | undefined;
3275
- /**
3276
- * <p>The type of the question.</p>
3277
- * @public
3278
- */
3279
- QuestionType: EvaluationFormQuestionType | undefined;
3280
- /**
3281
- * <p>The properties of the type of question. Text questions do not have to define question type
3282
- * properties.</p>
3283
- * @public
3284
- */
3285
- QuestionTypeProperties?: EvaluationFormQuestionTypeProperties | undefined;
3286
- /**
3287
- * <p>A question conditional enablement.</p>
3288
- * @public
3289
- */
3290
- Enablement?: EvaluationFormItemEnablementConfiguration | undefined;
3291
- /**
3292
- * <p>The scoring weight of the section.</p>
3293
- * @public
3294
- */
3295
- Weight?: number | undefined;
3296
- }
3297
- /**
3298
- * <p>Step defines the list of agents to be routed or route based on the agent requirements such
3299
- * as ProficiencyLevel, Name, or Value.</p>
3300
- * @public
3301
- */
3302
- export interface RoutingCriteriaInputStep {
3303
- /**
3304
- * <p>An object to specify the expiration of a routing step.</p>
3305
- * @public
3306
- */
3307
- Expiry?: RoutingCriteriaInputStepExpiry | undefined;
3308
- /**
3309
- * <p>A tagged union to specify expression for a routing step.</p>
3310
- * @public
3311
- */
3312
- Expression?: Expression | undefined;
3313
- }
3314
- /**
3315
- * @public
3316
- */
3317
- export interface SearchAgentStatusesRequest {
3318
- /**
3319
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
3320
- * the instance.</p>
3321
- * @public
3322
- */
3323
- InstanceId: string | undefined;
3324
- /**
3325
- * <p>The token for the next set of results. Use the value returned in the previous response in
3326
- * the next request to retrieve the next set of results.</p>
3327
- * @public
3328
- */
3329
- NextToken?: string | undefined;
3330
- /**
3331
- * <p>The maximum number of results to return per page.</p>
3332
- * @public
3333
- */
3334
- MaxResults?: number | undefined;
3335
- /**
3336
- * <p>Filters to be applied to search results.</p>
3337
- * @public
3338
- */
3339
- SearchFilter?: AgentStatusSearchFilter | undefined;
3340
- /**
3341
- * <p>The search criteria to be used to return agent statuses.</p>
3342
- * @public
3343
- */
3344
- SearchCriteria?: AgentStatusSearchCriteria | undefined;
3345
- }
3346
- /**
3347
- * @public
3348
- */
3349
- export interface SearchContactEvaluationsRequest {
3350
- /**
3351
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3352
- * @public
3353
- */
3354
- InstanceId: string | undefined;
3355
- /**
3356
- * <p>The token for the next set of results. Use the value returned in the previous
3357
- * response in the next request to retrieve the next set of results.</p>
3358
- * @public
3359
- */
3360
- NextToken?: string | undefined;
3361
- /**
3362
- * <p>The maximum number of results to return per page.</p>
3363
- * @public
3364
- */
3365
- MaxResults?: number | undefined;
3366
- /**
3367
- * <p>The search criteria to be used to return contact evaluations.</p>
3368
- * @public
3369
- */
3370
- SearchCriteria?: EvaluationSearchCriteria | undefined;
3371
- /**
3372
- * <p>Filters to be applied to search results.</p>
3373
- * @public
3374
- */
3375
- SearchFilter?: EvaluationSearchFilter | undefined;
3376
- }
3377
- /**
3378
- * @public
3379
- */
3380
- export interface SearchContactFlowModulesRequest {
3381
- /**
3382
- * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
3383
- * Amazon Resource Name (ARN) of the instance.</p>
3384
- * @public
3385
- */
3386
- InstanceId: string | undefined;
3387
- /**
3388
- * <p>The token for the next set of results. Use the value returned in the previous response in
3389
- * the next request to retrieve the next set of results.</p>
3390
- * @public
3391
- */
3392
- NextToken?: string | undefined;
3393
- /**
3394
- * <p>The maximum number of results to return per page.</p>
3395
- * @public
3396
- */
3397
- MaxResults?: number | undefined;
3398
- /**
3399
- * <p>Filters to be applied to search results.</p>
3400
- * @public
3401
- */
3402
- SearchFilter?: ContactFlowModuleSearchFilter | undefined;
3403
- /**
3404
- * <p>The search criteria to be used to return flow modules.</p>
3405
- * <note>
3406
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
3407
- * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3408
- * outside of this range will result in invalid results.</p>
3409
- * </note>
3410
- * @public
3411
- */
3412
- SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
3413
- }
3414
- /**
3415
- * @public
3416
- */
3417
- export interface SearchContactFlowsRequest {
3418
- /**
3419
- * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
3420
- * Amazon Resource Name (ARN) of the instance.</p>
3421
- * @public
3422
- */
3423
- InstanceId: string | undefined;
3424
- /**
3425
- * <p>The token for the next set of results. Use the value returned in the previous response in
3426
- * the next request to retrieve the next set of results.</p>
3427
- * @public
3428
- */
3429
- NextToken?: string | undefined;
3430
- /**
3431
- * <p>The maximum number of results to return per page.</p>
3432
- * @public
3433
- */
3434
- MaxResults?: number | undefined;
3435
- /**
3436
- * <p>Filters to be applied to search results.</p>
3437
- * @public
3438
- */
3439
- SearchFilter?: ContactFlowSearchFilter | undefined;
3440
- /**
3441
- * <p>The search criteria to be used to return flows.</p>
3442
- * <note>
3443
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
3444
- * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3445
- * outside of this range will result in invalid results.</p>
3446
- * </note>
3447
- * @public
3448
- */
3449
- SearchCriteria?: ContactFlowSearchCriteria | undefined;
3450
- }
3451
- /**
3452
- * @public
3453
- */
3454
- export interface SearchEmailAddressesRequest {
3455
- /**
3456
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3457
- * @public
3458
- */
3459
- InstanceId: string | undefined;
3460
- /**
3461
- * <p>The maximum number of results to return per page.</p>
3462
- * @public
3463
- */
3464
- MaxResults?: number | undefined;
3465
- /**
3466
- * <p>The token for the next set of results. Use the value returned in the previous
3467
- * response in the next request to retrieve the next set of results.</p>
3468
- * @public
3469
- */
3470
- NextToken?: string | undefined;
3471
- /**
3472
- * <p>The search criteria to be used to return email addresses.</p>
3473
- * @public
3474
- */
3475
- SearchCriteria?: EmailAddressSearchCriteria | undefined;
3476
- /**
3477
- * <p>Filters to be applied to search results.</p>
3478
- * @public
3479
- */
3480
- SearchFilter?: EmailAddressSearchFilter | undefined;
3481
- }
3482
- /**
3483
- * @public
3484
- */
3485
- export interface SearchEvaluationFormsRequest {
3486
- /**
3487
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3488
- * @public
3489
- */
3490
- InstanceId: string | undefined;
3491
- /**
3492
- * <p>The token for the next set of results. Use the value returned in the previous
3493
- * response in the next request to retrieve the next set of results.</p>
3494
- * @public
3495
- */
3496
- NextToken?: string | undefined;
3497
- /**
3498
- * <p>The maximum number of results to return per page.</p>
3499
- * @public
3500
- */
3501
- MaxResults?: number | undefined;
3502
- /**
3503
- * <p>The search criteria to be used to return evaluation forms.</p>
3504
- * @public
3505
- */
3506
- SearchCriteria?: EvaluationFormSearchCriteria | undefined;
3507
- /**
3508
- * <p>Filters to be applied to search results.</p>
3509
- * @public
3510
- */
3511
- SearchFilter?: EvaluationFormSearchFilter | undefined;
3512
- }
3513
- /**
3514
- * @public
3515
- */
3516
- export interface SearchHoursOfOperationOverridesRequest {
3517
- /**
3518
- * <p>The identifier of the Amazon Connect instance.</p>
3519
- * @public
3520
- */
3521
- InstanceId: string | undefined;
3522
- /**
3523
- * <p>The token for the next set of results. Use the value returned in the previous response in
3524
- * the next request to retrieve the next set of results. </p>
3525
- * @public
3526
- */
3527
- NextToken?: string | undefined;
3528
- /**
3529
- * <p>The maximum number of results to return per page.</p>
3530
- * @public
3531
- */
3532
- MaxResults?: number | undefined;
3533
- /**
3534
- * <p>Filters to be applied to search results.</p>
3535
- * @public
3536
- */
3537
- SearchFilter?: HoursOfOperationSearchFilter | undefined;
3538
- /**
3539
- * <p>The search criteria to be used to return hours of operations overrides.</p>
3540
- * @public
3541
- */
3542
- SearchCriteria?: HoursOfOperationOverrideSearchCriteria | undefined;
3543
- }
3544
- /**
3545
- * @public
3546
- */
3547
- export interface SearchHoursOfOperationsRequest {
3548
- /**
3549
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3550
- * @public
3551
- */
3552
- InstanceId: string | undefined;
3553
- /**
3554
- * <p>The token for the next set of results. Use the value returned in the previous
3555
- * response in the next request to retrieve the next set of results.</p>
3556
- * @public
3557
- */
3558
- NextToken?: string | undefined;
3559
- /**
3560
- * <p>The maximum number of results to return per page.</p>
3561
- * @public
3562
- */
3563
- MaxResults?: number | undefined;
3564
- /**
3565
- * <p>Filters to be applied to search results.</p>
3566
- * @public
3567
- */
3568
- SearchFilter?: HoursOfOperationSearchFilter | undefined;
3569
- /**
3570
- * <p>The search criteria to be used to return hours of operations.</p>
3571
- * @public
3572
- */
3573
- SearchCriteria?: HoursOfOperationSearchCriteria | undefined;
3574
- }
3575
- /**
3576
- * @public
3577
- */
3578
- export interface SearchPredefinedAttributesRequest {
3579
- /**
3580
- * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
3581
- * Name (ARN) of the instance.</p>
3582
- * @public
3583
- */
3584
- InstanceId: string | undefined;
3585
- /**
3586
- * <p>The token for the next set of results. Use the value returned in the previous response in
3587
- * the next request to retrieve the next set of results.</p>
3588
- * @public
3589
- */
3590
- NextToken?: string | undefined;
3591
- /**
3592
- * <p>The maximum number of results to return per page.</p>
3593
- * @public
3594
- */
3595
- MaxResults?: number | undefined;
3596
- /**
3597
- * <p>The search criteria to be used to return predefined attributes.</p>
3598
- * @public
3599
- */
3600
- SearchCriteria?: PredefinedAttributeSearchCriteria | undefined;
3601
- }
3602
- /**
3603
- * @public
3604
- */
3605
- export interface SearchPromptsRequest {
3606
- /**
3607
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3608
- * @public
3609
- */
3610
- InstanceId: string | undefined;
3611
- /**
3612
- * <p>The token for the next set of results. Use the value returned in the previous
3613
- * response in the next request to retrieve the next set of results.</p>
3614
- * @public
3615
- */
3616
- NextToken?: string | undefined;
3617
- /**
3618
- * <p>The maximum number of results to return per page.</p>
3619
- * @public
3620
- */
3621
- MaxResults?: number | undefined;
3622
- /**
3623
- * <p>Filters to be applied to search results.</p>
3624
- * @public
3625
- */
3626
- SearchFilter?: PromptSearchFilter | undefined;
3627
- /**
3628
- * <p>The search criteria to be used to return prompts.</p>
3629
- * @public
3630
- */
3631
- SearchCriteria?: PromptSearchCriteria | undefined;
3632
- }
3633
- /**
3634
- * @public
3635
- */
3636
- export interface SearchQueuesRequest {
3637
- /**
3638
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3639
- * @public
3640
- */
3641
- InstanceId: string | undefined;
3642
- /**
3643
- * <p>The token for the next set of results. Use the value returned in the previous
3644
- * response in the next request to retrieve the next set of results.</p>
3645
- * @public
3646
- */
3647
- NextToken?: string | undefined;
3648
- /**
3649
- * <p>The maximum number of results to return per page.</p>
3650
- * @public
3651
- */
3652
- MaxResults?: number | undefined;
3653
- /**
3654
- * <p>Filters to be applied to search results.</p>
3655
- * @public
3656
- */
3657
- SearchFilter?: QueueSearchFilter | undefined;
3658
- /**
3659
- * <p>The search criteria to be used to return queues.</p>
3660
- * <note>
3661
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3662
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3663
- * outside of this range will throw invalid results. </p>
3664
- * </note>
3665
- * @public
3666
- */
3667
- SearchCriteria?: QueueSearchCriteria | undefined;
3668
- }
3669
- /**
3670
- * @public
3671
- */
3672
- export interface SearchQuickConnectsRequest {
3673
- /**
3674
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3675
- * @public
3676
- */
3677
- InstanceId: string | undefined;
3678
- /**
3679
- * <p>The token for the next set of results. Use the value returned in the previous
3680
- * response in the next request to retrieve the next set of results.</p>
3681
- * @public
3682
- */
3683
- NextToken?: string | undefined;
3684
- /**
3685
- * <p>The maximum number of results to return per page.</p>
3686
- * @public
3687
- */
3688
- MaxResults?: number | undefined;
3689
- /**
3690
- * <p>Filters to be applied to search results.</p>
3691
- * @public
3692
- */
3693
- SearchFilter?: QuickConnectSearchFilter | undefined;
3694
- /**
3695
- * <p>The search criteria to be used to return quick connects.</p>
3696
- * @public
3697
- */
3698
- SearchCriteria?: QuickConnectSearchCriteria | undefined;
3699
- }
3700
- /**
3701
- * @public
3702
- */
3703
- export interface SearchRoutingProfilesRequest {
3704
- /**
3705
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3706
- * @public
3707
- */
3708
- InstanceId: string | undefined;
3709
- /**
3710
- * <p>The token for the next set of results. Use the value returned in the previous
3711
- * response in the next request to retrieve the next set of results.</p>
3712
- * @public
3713
- */
3714
- NextToken?: string | undefined;
3715
- /**
3716
- * <p>The maximum number of results to return per page.</p>
3717
- * @public
3718
- */
3719
- MaxResults?: number | undefined;
3720
- /**
3721
- * <p>Filters to be applied to search results.</p>
3722
- * @public
3723
- */
3724
- SearchFilter?: RoutingProfileSearchFilter | undefined;
3725
- /**
3726
- * <p>The search criteria to be used to return routing profiles.</p>
3727
- * <note>
3728
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3729
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3730
- * outside of this range will throw invalid results. </p>
3731
- * </note>
3732
- * @public
3733
- */
3734
- SearchCriteria?: RoutingProfileSearchCriteria | undefined;
3735
- }
3736
- /**
3737
- * @public
3738
- */
3739
- export interface SearchSecurityProfilesRequest {
3740
- /**
3741
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3742
- * @public
3743
- */
3744
- InstanceId: string | undefined;
3745
- /**
3746
- * <p>The token for the next set of results. Use the value returned in the previous
3747
- * response in the next request to retrieve the next set of results.</p>
3748
- * @public
3749
- */
3750
- NextToken?: string | undefined;
3751
- /**
3752
- * <p>The maximum number of results to return per page.</p>
3753
- * @public
3754
- */
3755
- MaxResults?: number | undefined;
3756
- /**
3757
- * <p>The search criteria to be used to return security profiles. </p>
3758
- * <note>
3759
- * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
3760
- * maximum of 25 characters. Any queries with character lengths outside of this range will throw
3761
- * invalid results.</p>
3762
- * </note>
3763
- * <note>
3764
- * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
3765
- * </p>
3766
- * </note>
3767
- * @public
3768
- */
3769
- SearchCriteria?: SecurityProfileSearchCriteria | undefined;
3770
- /**
3771
- * <p>Filters to be applied to search results.</p>
3772
- * @public
3773
- */
3774
- SearchFilter?: SecurityProfilesSearchFilter | undefined;
3775
- }
3776
- /**
3777
- * @public
3778
- */
3779
- export interface SearchUserHierarchyGroupsRequest {
3780
- /**
3781
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
3782
- * the instance.</p>
3783
- * @public
3784
- */
3785
- InstanceId: string | undefined;
3786
- /**
3787
- * <p>The token for the next set of results. Use the value returned in the previous response in
3788
- * the next request to retrieve the next set of results.</p>
3789
- * @public
3790
- */
3791
- NextToken?: string | undefined;
3792
- /**
3793
- * <p>The maximum number of results to return per page.</p>
3794
- * @public
3795
- */
3796
- MaxResults?: number | undefined;
3797
- /**
3798
- * <p>Filters to be applied to search results.</p>
3799
- * @public
3800
- */
3801
- SearchFilter?: UserHierarchyGroupSearchFilter | undefined;
3802
- /**
3803
- * <p>The search criteria to be used to return UserHierarchyGroups.</p>
3804
- * @public
3805
- */
3806
- SearchCriteria?: UserHierarchyGroupSearchCriteria | undefined;
3807
- }
3808
- /**
3809
- * @public
3810
- */
3811
- export interface SearchUsersRequest {
3812
- /**
3813
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3814
- * @public
3815
- */
3816
- InstanceId: string | undefined;
3817
- /**
3818
- * <p>The token for the next set of results. Use the value returned in the previous
3819
- * response in the next request to retrieve the next set of results.</p>
3820
- * @public
3821
- */
3822
- NextToken?: string | undefined;
3823
- /**
3824
- * <p>The maximum number of results to return per page.</p>
3825
- * @public
3826
- */
3827
- MaxResults?: number | undefined;
3828
- /**
3829
- * <p>Filters to be applied to search results.</p>
3830
- * @public
3831
- */
3832
- SearchFilter?: UserSearchFilter | undefined;
3833
- /**
3834
- * <p>The search criteria to be used to return users.</p>
3835
- * <note>
3836
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
3837
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
3838
- * outside of this range will throw invalid results. </p>
3839
- * </note>
3840
- * @public
3841
- */
3842
- SearchCriteria?: UserSearchCriteria | undefined;
3843
- }
3844
- /**
3845
- * <p>Step signifies the criteria to be used for routing to an agent</p>
3846
- * @public
3847
- */
3848
- export interface Step {
3849
- /**
3850
- * <p>An object to specify the expiration of a routing step.</p>
3851
- * @public
3852
- */
3853
- Expiry?: Expiry | undefined;
3854
- /**
3855
- * <p>A tagged union to specify expression for a routing step.</p>
3856
- * @public
3857
- */
3858
- Expression?: Expression | undefined;
3859
- /**
3860
- * <p>Represents status of the Routing step.</p>
3861
- * @public
3862
- */
3863
- Status?: RoutingCriteriaStepStatus | undefined;
3864
- }
3865
- /**
3866
- * <p>The value of a segment attribute. This is structured as a map with a single key-value pair.
3867
- * The key 'valueString' indicates that the attribute type is a string, and its corresponding value
3868
- * is the actual string value of the segment attribute.</p>
3869
- * @public
3870
- */
3871
- export interface ContactSearchSummarySegmentAttributeValue {
3872
- /**
3873
- * <p>The value of a segment attribute represented as a string.</p>
3874
- * @public
3875
- */
3876
- ValueString?: string | undefined;
3877
- /**
3878
- * <p>The key and value of a segment attribute.</p>
3879
- * @public
3880
- */
3881
- ValueMap?: Record<string, SegmentAttributeValue> | undefined;
3882
- }
3883
- /**
3884
- * @public
3885
- */
3886
- export interface CreateContactRequest {
3887
- /**
3888
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
3889
- * @public
3890
- */
3891
- InstanceId: string | undefined;
3892
- /**
3893
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
3894
- * request. If not provided, the Amazon Web Services
3895
- * SDK populates this field. For more information about idempotency, see
3896
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
3897
- * @public
3898
- */
3899
- ClientToken?: string | undefined;
3900
- /**
3901
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
3902
- * @public
3903
- */
3904
- RelatedContactId?: string | undefined;
3905
- /**
3906
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
3907
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
3908
- * can include only alphanumeric, dash, and underscore characters.</p>
3909
- * @public
3910
- */
3911
- Attributes?: Record<string, string> | undefined;
3912
- /**
3913
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
3914
- * the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
3915
- * <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>
3916
- * @public
3917
- */
3918
- References?: Record<string, Reference> | undefined;
3919
- /**
3920
- * <p>The channel for the contact.</p>
3921
- * <important>
3922
- * <p>The CHAT channel is not supported. The following information is incorrect. We're working to
3923
- * correct it.</p>
3924
- * </important>
3925
- * @public
3926
- */
3927
- Channel: Channel | undefined;
3928
- /**
3929
- * <p>Indicates how the contact was initiated. </p>
3930
- * <important>
3931
- * <p>CreateContact only supports the following initiation methods. Valid values by channel are: </p>
3932
- * <ul>
3933
- * <li>
3934
- * <p>For VOICE: <code>TRANSFER</code> and the subtype <code>connect:ExternalAudio</code>
3935
- * </p>
3936
- * </li>
3937
- * <li>
3938
- * <p>For EMAIL: <code>OUTBOUND</code> | <code>AGENT_REPLY</code> | <code>FLOW</code>
3939
- * </p>
3940
- * </li>
3941
- * <li>
3942
- * <p>For TASK: <code>API</code>
3943
- * </p>
3944
- * </li>
3945
- * </ul>
3946
- * <p>The other channels listed below are incorrect. We're working to correct this
3947
- * information.</p>
3948
- * </important>
3949
- * @public
3950
- */
3951
- InitiationMethod: ContactInitiationMethod | undefined;
3952
- /**
3953
- * <p>Number of minutes the contact will be active for before expiring</p>
3954
- * @public
3955
- */
3956
- ExpiryDurationInMinutes?: number | undefined;
3957
- /**
3958
- * <p>User details for the contact</p>
3959
- * <important>
3960
- * <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and
3961
- * <code>AGENT_REPLY</code> contact initiation methods.</p>
3962
- * </important>
3963
- * @public
3964
- */
3965
- UserInfo?: UserInfo | undefined;
3966
- /**
3967
- * <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated
3968
- * with <code>COMPLETED</code> state.</p>
3969
- * @public
3970
- */
3971
- InitiateAs?: InitiateAs | undefined;
3972
- /**
3973
- * <p>The name of a the contact.</p>
3974
- * @public
3975
- */
3976
- Name?: string | undefined;
3977
- /**
3978
- * <p>A description of the contact.</p>
3979
- * @public
3980
- */
3981
- Description?: string | undefined;
3982
- /**
3983
- * <p>A set of system defined key-value pairs stored on individual contact segments (unique
3984
- * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
3985
- * They can be accessed in flows.</p>
3986
- * <p>Attribute keys can include only alphanumeric, -, and _.</p>
3987
- * <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
3988
- * <note>
3989
- * <p>To set contact expiry, a ValueMap must be specified containing the integer number of
3990
- * minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
3991
- * \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
3992
- * 135\}\}\}\}</code>. </p>
3993
- * </note>
3994
- * @public
3995
- */
3996
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
3997
- /**
3998
- * <p>The ID of the previous contact when creating a transfer contact. This value can be provided
3999
- * only for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Integrate Amazon Connect Contact Lens
4000
- * with external voice systems</a> in the <i>Amazon Connect Administrator
4001
- * Guide</i>.</p>
4002
- * @public
4003
- */
4004
- PreviousContactId?: string | undefined;
4005
- }
4006
- /**
4007
- * @public
4008
- */
4009
- export interface StartChatContactRequest {
4010
- /**
4011
- * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
4012
- * @public
4013
- */
4014
- InstanceId: string | undefined;
4015
- /**
4016
- * <p>The identifier of the flow for initiating the chat.
4017
- * To
4018
- * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
4019
- * under the name of the flow, choose <b>Show additional flow
4020
- * information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
4021
- * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
4022
- * </p>
4023
- * @public
4024
- */
4025
- ContactFlowId: string | undefined;
4026
- /**
4027
- * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
4028
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
4029
- * can include only alphanumeric, dash, and underscore characters.</p>
4030
- * @public
4031
- */
4032
- Attributes?: Record<string, string> | undefined;
4033
- /**
4034
- * <p>Information identifying the participant.</p>
4035
- * @public
4036
- */
4037
- ParticipantDetails: ParticipantDetails | undefined;
4038
- /**
4039
- * <p>The initial message to be sent to the newly created chat.</p>
4040
- * @public
4041
- */
4042
- InitialMessage?: ChatMessage | undefined;
4043
- /**
4044
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
4045
- * request. If not provided, the Amazon Web Services
4046
- * SDK populates this field. For more information about idempotency, see
4047
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
4048
- * @public
4049
- */
4050
- ClientToken?: string | undefined;
4051
- /**
4052
- * <p>The total duration of the newly started chat session. If not specified, the chat session
4053
- * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
4054
- * configurable time is 10,080 minutes (7 days).</p>
4055
- * @public
4056
- */
4057
- ChatDurationInMinutes?: number | undefined;
4058
- /**
4059
- * <p>The supported chat message content types. Supported types are <code>text/plain</code>,
4060
- * <code>text/markdown</code>, <code>application/json</code>,
4061
- * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
4062
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
4063
- * <p>Content types must always contain <code>text/plain</code>. You can then put any other
4064
- * supported type in the list. For example, all the following lists are valid because they contain
4065
- * <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
4066
- * <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
4067
- * application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
4068
- * <note>
4069
- * <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
4070
- * use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
4071
- * view</a> flow block.</p>
4072
- * </note>
4073
- * @public
4074
- */
4075
- SupportedMessagingContentTypes?: string[] | undefined;
4076
- /**
4077
- * <p>Enable persistent chats. For more information about enabling persistent chat, and for
4078
- * example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
4079
- * @public
4080
- */
4081
- PersistentChat?: PersistentChat | undefined;
4082
- /**
4083
- * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
4084
- * chat starting.</p>
4085
- * <note>
4086
- * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
4087
- * </note>
4088
- * @public
4089
- */
4090
- RelatedContactId?: string | undefined;
4091
- /**
4092
- * <p>A set of system defined key-value pairs stored on individual contact segments using an
4093
- * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
4094
- * flows.</p>
4095
- * <p>Attribute keys can include only alphanumeric, -, and _.</p>
4096
- * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
4097
- * <note>
4098
- * <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
4099
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
4100
- * the SupportedMessagingContentTypes field of this API in order to set
4101
- * <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
4102
- * \}\}</code>.</p>
4103
- * </note>
4104
- * @public
4105
- */
4106
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
4107
- /**
4108
- * <p>The customer's identification number. For example, the <code>CustomerId</code> may be a
4109
- * customer number from your CRM.</p>
4110
- * @public
4111
- */
4112
- CustomerId?: string | undefined;
4113
- }
1
+ import { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, EvaluationFormVersionStatus } from "./enums";
2
+ import { AdditionalEmailRecipients, AgentInfo, Campaign, ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, Endpoint, EndpointInfo, EvaluationFormAutoEvaluationConfiguration, EvaluationFormScoringStrategy, OutboundStrategy, QualityMetrics, QueueInfo, RecordingInfo, Reference, TaskTemplateInfoV2, UserInfo, WisdomInfo } from "./models_0";
3
+ import { Evaluation } from "./models_1";
4
+ import { ChatMessage, ContactSearchSummaryAgentInfo, ContactSearchSummaryQueueInfo, ContactSearchSummarySegmentAttributeValue, EmailAddressInfo, EmailAttachment, EvaluationFormQuestion, InboundAdditionalRecipients, InboundEmailContent, ParticipantDetails, QueueInfoInput, RoutingCriteriaInputStep, SegmentAttributeValue, Step } from "./models_2";
4114
5
  /**
4115
6
  * @public
4116
7
  */