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