@aws-sdk/client-connect 3.696.0 → 3.701.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 (169) hide show
  1. package/README.md +88 -0
  2. package/dist-cjs/index.js +1021 -119
  3. package/dist-es/Connect.js +22 -0
  4. package/dist-es/commands/CreateContactCommand.js +23 -0
  5. package/dist-es/commands/CreateEmailAddressCommand.js +23 -0
  6. package/dist-es/commands/DeleteEmailAddressCommand.js +22 -0
  7. package/dist-es/commands/DescribeContactCommand.js +1 -1
  8. package/dist-es/commands/DescribeEmailAddressCommand.js +23 -0
  9. package/dist-es/commands/ListAssociatedContactsCommand.js +22 -0
  10. package/dist-es/commands/SearchEmailAddressesCommand.js +23 -0
  11. package/dist-es/commands/SendOutboundEmailCommand.js +23 -0
  12. package/dist-es/commands/StartEmailContactCommand.js +23 -0
  13. package/dist-es/commands/StartOutboundEmailContactCommand.js +23 -0
  14. package/dist-es/commands/StartTaskContactCommand.js +1 -1
  15. package/dist-es/commands/UpdateContactCommand.js +1 -1
  16. package/dist-es/commands/UpdateEmailAddressMetadataCommand.js +23 -0
  17. package/dist-es/commands/UpdateQueueOutboundEmailConfigCommand.js +22 -0
  18. package/dist-es/commands/index.js +11 -0
  19. package/dist-es/models/index.js +1 -0
  20. package/dist-es/models/models_0.js +67 -24
  21. package/dist-es/models/models_1.js +24 -40
  22. package/dist-es/models/models_2.js +142 -19
  23. package/dist-es/models/models_3.js +33 -0
  24. package/dist-es/protocols/Aws_restJson1.js +470 -10
  25. package/dist-types/Connect.d.ts +77 -0
  26. package/dist-types/ConnectClient.d.ts +13 -2
  27. package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
  28. package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +1 -1
  29. package/dist-types/commands/AssociateRoutingProfileQueuesCommand.d.ts +1 -1
  30. package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +1 -1
  31. package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
  32. package/dist-types/commands/BatchPutContactCommand.d.ts +2 -2
  33. package/dist-types/commands/CreateContactCommand.d.ts +139 -0
  34. package/dist-types/commands/CreateEmailAddressCommand.d.ts +111 -0
  35. package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateQueueCommand.d.ts +3 -0
  37. package/dist-types/commands/CreateRoutingProfileCommand.d.ts +2 -2
  38. package/dist-types/commands/CreateRuleCommand.d.ts +5 -2
  39. package/dist-types/commands/CreateTaskTemplateCommand.d.ts +2 -1
  40. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +91 -0
  41. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -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 +39 -4
  45. package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  46. package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
  47. package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeEmailAddressCommand.d.ts +99 -0
  49. package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeInstanceStorageConfigCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeQueueCommand.d.ts +3 -0
  52. package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +1 -1
  53. package/dist-types/commands/DescribeRuleCommand.d.ts +5 -2
  54. package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
  55. package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +1 -1
  56. package/dist-types/commands/DisassociateRoutingProfileQueuesCommand.d.ts +1 -1
  57. package/dist-types/commands/GetAttachedFileCommand.d.ts +1 -1
  58. package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -2
  59. package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -2
  60. package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
  61. package/dist-types/commands/GetMetricDataCommand.d.ts +2 -2
  62. package/dist-types/commands/GetTaskTemplateCommand.d.ts +2 -1
  63. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +103 -0
  64. package/dist-types/commands/ListContactReferencesCommand.d.ts +7 -2
  65. package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
  66. package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +1 -1
  67. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
  68. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +3 -2
  69. package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +2 -2
  70. package/dist-types/commands/ListRoutingProfilesCommand.d.ts +1 -1
  71. package/dist-types/commands/ListRulesCommand.d.ts +1 -1
  72. package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -1
  73. package/dist-types/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
  74. package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -2
  75. package/dist-types/commands/SearchAgentStatusesCommand.d.ts +2 -1
  76. package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +2 -1
  77. package/dist-types/commands/SearchContactFlowsCommand.d.ts +3 -4
  78. package/dist-types/commands/SearchContactsCommand.d.ts +20 -4
  79. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +146 -0
  80. package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -1
  81. package/dist-types/commands/SearchPredefinedAttributesCommand.d.ts +2 -1
  82. package/dist-types/commands/SearchPromptsCommand.d.ts +2 -1
  83. package/dist-types/commands/SearchQueuesCommand.d.ts +5 -1
  84. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -1
  85. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +3 -2
  86. package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
  87. package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -1
  88. package/dist-types/commands/SearchUsersCommand.d.ts +2 -1
  89. package/dist-types/commands/SendOutboundEmailCommand.d.ts +135 -0
  90. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +4 -2
  91. package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
  92. package/dist-types/commands/StartEmailContactCommand.d.ts +162 -0
  93. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +14 -3
  94. package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +129 -0
  95. package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +5 -2
  96. package/dist-types/commands/StartTaskContactCommand.d.ts +22 -3
  97. package/dist-types/commands/StartWebRTCContactCommand.d.ts +5 -2
  98. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  99. package/dist-types/commands/UpdateContactCommand.d.ts +22 -3
  100. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  101. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  102. package/dist-types/commands/UpdateContactRoutingDataCommand.d.ts +2 -1
  103. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +98 -0
  104. package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +2 -1
  105. package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -1
  106. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +94 -0
  107. package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
  108. package/dist-types/commands/UpdateRoutingProfileQueuesCommand.d.ts +1 -1
  109. package/dist-types/commands/UpdateRuleCommand.d.ts +5 -2
  110. package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +4 -2
  111. package/dist-types/commands/index.d.ts +11 -0
  112. package/dist-types/models/index.d.ts +1 -0
  113. package/dist-types/models/models_0.d.ts +317 -321
  114. package/dist-types/models/models_1.d.ts +567 -624
  115. package/dist-types/models/models_2.d.ts +3704 -3854
  116. package/dist-types/models/models_3.d.ts +1650 -0
  117. package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
  118. package/dist-types/ts3.4/Connect.d.ts +187 -0
  119. package/dist-types/ts3.4/ConnectClient.d.ts +66 -0
  120. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +48 -0
  121. package/dist-types/ts3.4/commands/CreateEmailAddressCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/DeleteEmailAddressCommand.d.ts +51 -0
  123. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
  124. package/dist-types/ts3.4/commands/DescribeAgentStatusCommand.d.ts +1 -1
  125. package/dist-types/ts3.4/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
  126. package/dist-types/ts3.4/commands/DescribeContactCommand.d.ts +2 -2
  127. package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/DescribeEmailAddressCommand.d.ts +51 -0
  129. package/dist-types/ts3.4/commands/DescribeEvaluationFormCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/ListAssociatedContactsCommand.d.ts +51 -0
  131. package/dist-types/ts3.4/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +2 -4
  132. package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +1 -1
  134. package/dist-types/ts3.4/commands/ListRulesCommand.d.ts +1 -1
  135. package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +1 -1
  136. package/dist-types/ts3.4/commands/ListSecurityProfileApplicationsCommand.d.ts +1 -1
  137. package/dist-types/ts3.4/commands/ListSecurityProfilePermissionsCommand.d.ts +4 -2
  138. package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +2 -4
  139. package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +2 -4
  140. package/dist-types/ts3.4/commands/SearchContactFlowsCommand.d.ts +2 -4
  141. package/dist-types/ts3.4/commands/SearchEmailAddressesCommand.d.ts +49 -0
  142. package/dist-types/ts3.4/commands/SearchHoursOfOperationsCommand.d.ts +2 -4
  143. package/dist-types/ts3.4/commands/SearchPredefinedAttributesCommand.d.ts +2 -4
  144. package/dist-types/ts3.4/commands/SearchPromptsCommand.d.ts +2 -4
  145. package/dist-types/ts3.4/commands/SearchQueuesCommand.d.ts +2 -1
  146. package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +2 -4
  147. package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +2 -4
  148. package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +2 -4
  149. package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -4
  150. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +2 -1
  151. package/dist-types/ts3.4/commands/SendOutboundEmailCommand.d.ts +51 -0
  152. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  153. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +49 -0
  154. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  155. package/dist-types/ts3.4/commands/StartOutboundEmailContactCommand.d.ts +51 -0
  156. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  157. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  158. package/dist-types/ts3.4/commands/UpdateContactRoutingDataCommand.d.ts +2 -4
  159. package/dist-types/ts3.4/commands/UpdateEmailAddressMetadataCommand.d.ts +51 -0
  160. package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +2 -4
  161. package/dist-types/ts3.4/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +47 -0
  162. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  163. package/dist-types/ts3.4/models/index.d.ts +1 -0
  164. package/dist-types/ts3.4/models/models_0.d.ts +122 -90
  165. package/dist-types/ts3.4/models/models_1.d.ts +155 -213
  166. package/dist-types/ts3.4/models/models_2.d.ts +436 -296
  167. package/dist-types/ts3.4/models/models_3.d.ts +363 -0
  168. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
  169. package/package.json +4 -4
@@ -0,0 +1,1650 @@
1
+ import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Channel, ContactInitiationMethod, Endpoint, EvaluationFormScoringStrategy, Reference, StringCondition } from "./models_0";
2
+ import { AnsweringMachineDetectionStatus, AttributeCondition, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, Expiry, QualityMetrics, QueueInfo, RoutingCriteriaStepStatus, WisdomInfo } from "./models_1";
3
+ import { AgentStatusSearchCriteria, ChatMessage, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, ContactFlowSearchCriteria, ContactFlowSearchFilter, EmailAddressInfo, EmailAddressSearchCriteria, EmailAddressSearchFilter, EmailAttachment, EvaluationForm, EvaluationFormContent, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, SegmentAttributeValue, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
4
+ /**
5
+ * <p>A tagged union to specify expression for a routing step.</p>
6
+ * @public
7
+ */
8
+ export interface Expression {
9
+ /**
10
+ * <p>An object to specify the predefined attribute condition.</p>
11
+ * @public
12
+ */
13
+ AttributeCondition?: AttributeCondition | undefined;
14
+ /**
15
+ * <p>List of routing expressions which will be AND-ed together.</p>
16
+ * @public
17
+ */
18
+ AndExpression?: Expression[] | undefined;
19
+ /**
20
+ * <p>List of routing expressions which will be OR-ed together.</p>
21
+ * @public
22
+ */
23
+ OrExpression?: Expression[] | undefined;
24
+ }
25
+ /**
26
+ * <p>The search criteria to be used to return hours of operations.</p>
27
+ * @public
28
+ */
29
+ export interface HoursOfOperationSearchCriteria {
30
+ /**
31
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
32
+ * @public
33
+ */
34
+ OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
35
+ /**
36
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
37
+ * @public
38
+ */
39
+ AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
40
+ /**
41
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
42
+ * <note>
43
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
44
+ * <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
45
+ * </note>
46
+ * @public
47
+ */
48
+ StringCondition?: StringCondition | undefined;
49
+ }
50
+ /**
51
+ * <p>The search criteria to be used to return predefined attributes.</p>
52
+ * @public
53
+ */
54
+ export interface PredefinedAttributeSearchCriteria {
55
+ /**
56
+ * <p>A list of conditions which would be applied together with an <code>OR</code>
57
+ * condition.</p>
58
+ * @public
59
+ */
60
+ OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
61
+ /**
62
+ * <p>A list of conditions which would be applied together with an <code>AND</code>
63
+ * condition.</p>
64
+ * @public
65
+ */
66
+ AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
67
+ /**
68
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
69
+ * @public
70
+ */
71
+ StringCondition?: StringCondition | undefined;
72
+ }
73
+ /**
74
+ * <p>The search criteria to be used to return prompts.</p>
75
+ * @public
76
+ */
77
+ export interface PromptSearchCriteria {
78
+ /**
79
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
80
+ * @public
81
+ */
82
+ OrConditions?: PromptSearchCriteria[] | undefined;
83
+ /**
84
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
85
+ * @public
86
+ */
87
+ AndConditions?: PromptSearchCriteria[] | undefined;
88
+ /**
89
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
90
+ * <note>
91
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
92
+ * <code>description</code>, and <code>resourceID</code>.</p>
93
+ * </note>
94
+ * @public
95
+ */
96
+ StringCondition?: StringCondition | undefined;
97
+ }
98
+ /**
99
+ * <p>The search criteria to be used to return queues.</p>
100
+ * <note>
101
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
102
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
103
+ * outside of this range will throw invalid results. </p>
104
+ * </note>
105
+ * @public
106
+ */
107
+ export interface QueueSearchCriteria {
108
+ /**
109
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
110
+ * @public
111
+ */
112
+ OrConditions?: QueueSearchCriteria[] | undefined;
113
+ /**
114
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
115
+ * @public
116
+ */
117
+ AndConditions?: QueueSearchCriteria[] | undefined;
118
+ /**
119
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
120
+ * <note>
121
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
122
+ * <code>description</code>, and <code>resourceID</code>.</p>
123
+ * </note>
124
+ * @public
125
+ */
126
+ StringCondition?: StringCondition | undefined;
127
+ /**
128
+ * <p>The type of queue.</p>
129
+ * @public
130
+ */
131
+ QueueTypeCondition?: SearchableQueueType | undefined;
132
+ }
133
+ /**
134
+ * <p>The search criteria to be used to return quick connects.</p>
135
+ * @public
136
+ */
137
+ export interface QuickConnectSearchCriteria {
138
+ /**
139
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
140
+ * @public
141
+ */
142
+ OrConditions?: QuickConnectSearchCriteria[] | undefined;
143
+ /**
144
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
145
+ * @public
146
+ */
147
+ AndConditions?: QuickConnectSearchCriteria[] | undefined;
148
+ /**
149
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
150
+ * <note>
151
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
152
+ * <code>description</code>, and <code>resourceID</code>.</p>
153
+ * </note>
154
+ * @public
155
+ */
156
+ StringCondition?: StringCondition | undefined;
157
+ }
158
+ /**
159
+ * <p>The search criteria to be used to return routing profiles.</p>
160
+ * <note>
161
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
162
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
163
+ * outside of this range will throw invalid results. </p>
164
+ * </note>
165
+ * @public
166
+ */
167
+ export interface RoutingProfileSearchCriteria {
168
+ /**
169
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
170
+ * @public
171
+ */
172
+ OrConditions?: RoutingProfileSearchCriteria[] | undefined;
173
+ /**
174
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
175
+ * @public
176
+ */
177
+ AndConditions?: RoutingProfileSearchCriteria[] | undefined;
178
+ /**
179
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
180
+ * <note>
181
+ * <p>The currently supported values for <code>FieldName</code> are
182
+ * <code>associatedQueueIds</code>, <code>name</code>, <code>description</code>, and
183
+ * <code>resourceID</code>.</p>
184
+ * </note>
185
+ * @public
186
+ */
187
+ StringCondition?: StringCondition | undefined;
188
+ }
189
+ /**
190
+ * <p>The search criteria to be used to return security profiles.</p>
191
+ * <note>
192
+ * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
193
+ * maximum of 25 characters. Any queries with character lengths outside of this range will throw
194
+ * invalid results.</p>
195
+ * </note>
196
+ * @public
197
+ */
198
+ export interface SecurityProfileSearchCriteria {
199
+ /**
200
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
201
+ * @public
202
+ */
203
+ OrConditions?: SecurityProfileSearchCriteria[] | undefined;
204
+ /**
205
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
206
+ * @public
207
+ */
208
+ AndConditions?: SecurityProfileSearchCriteria[] | undefined;
209
+ /**
210
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
211
+ * @public
212
+ */
213
+ StringCondition?: StringCondition | undefined;
214
+ }
215
+ /**
216
+ * @public
217
+ */
218
+ export interface StartChatContactRequest {
219
+ /**
220
+ * <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>
221
+ * @public
222
+ */
223
+ InstanceId: string | undefined;
224
+ /**
225
+ * <p>The identifier of the flow for initiating the chat.
226
+ * To
227
+ * 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,
228
+ * under the name of the flow, choose <b>Show additional flow
229
+ * information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
230
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
231
+ * </p>
232
+ * @public
233
+ */
234
+ ContactFlowId: string | undefined;
235
+ /**
236
+ * <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>
237
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
238
+ * can include only alphanumeric, dash, and underscore characters.</p>
239
+ * @public
240
+ */
241
+ Attributes?: Record<string, string> | undefined;
242
+ /**
243
+ * <p>Information identifying the participant.</p>
244
+ * @public
245
+ */
246
+ ParticipantDetails: ParticipantDetails | undefined;
247
+ /**
248
+ * <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
249
+ * flow, the initial message is not delivered to the Lex bot.</p>
250
+ * @public
251
+ */
252
+ InitialMessage?: ChatMessage | undefined;
253
+ /**
254
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
255
+ * request. If not provided, the Amazon Web Services
256
+ * SDK populates this field. For more information about idempotency, see
257
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
258
+ * @public
259
+ */
260
+ ClientToken?: string | undefined;
261
+ /**
262
+ * <p>The total duration of the newly started chat session. If not specified, the chat session
263
+ * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
264
+ * configurable time is 10,080 minutes (7 days).</p>
265
+ * @public
266
+ */
267
+ ChatDurationInMinutes?: number | undefined;
268
+ /**
269
+ * <p>The supported chat message content types. Supported types are <code>text/plain</code>,
270
+ * <code>text/markdown</code>, <code>application/json</code>,
271
+ * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
272
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
273
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other
274
+ * supported type in the list. For example, all the following lists are valid because they contain
275
+ * <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
276
+ * <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
277
+ * application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
278
+ * <note>
279
+ * <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
280
+ * use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
281
+ * view</a> flow block.</p>
282
+ * </note>
283
+ * @public
284
+ */
285
+ SupportedMessagingContentTypes?: string[] | undefined;
286
+ /**
287
+ * <p>Enable persistent chats. For more information about enabling persistent chat, and for
288
+ * 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>
289
+ * @public
290
+ */
291
+ PersistentChat?: PersistentChat | undefined;
292
+ /**
293
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
294
+ * chat starting.</p>
295
+ * <note>
296
+ * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
297
+ * </note>
298
+ * @public
299
+ */
300
+ RelatedContactId?: string | undefined;
301
+ /**
302
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
303
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
304
+ * flows.</p>
305
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
306
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
307
+ * <note>
308
+ * <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
309
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
310
+ * the SupportedMessagingContentTypes field of this API in order to set
311
+ * <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
312
+ * \}\}</code>.</p>
313
+ * </note>
314
+ * @public
315
+ */
316
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
317
+ }
318
+ /**
319
+ * @public
320
+ */
321
+ export interface StartEmailContactRequest {
322
+ /**
323
+ * <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>
324
+ * @public
325
+ */
326
+ InstanceId: string | undefined;
327
+ /**
328
+ * <p>The email address of the customer.</p>
329
+ * @public
330
+ */
331
+ FromEmailAddress: EmailAddressInfo | undefined;
332
+ /**
333
+ * <p>The email address associated with the instance.</p>
334
+ * @public
335
+ */
336
+ DestinationEmailAddress: string | undefined;
337
+ /**
338
+ * <p>A description of the email contact.</p>
339
+ * @public
340
+ */
341
+ Description?: string | undefined;
342
+ /**
343
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can
344
+ * have the following reference types at the time of creation: <code>URL</code> |
345
+ * <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> |
346
+ * <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during
347
+ * email creation.</p>
348
+ * @public
349
+ */
350
+ References?: Record<string, Reference> | undefined;
351
+ /**
352
+ * <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
353
+ * @public
354
+ */
355
+ Name?: string | undefined;
356
+ /**
357
+ * <p>The email message body to be sent to the newly created email.</p>
358
+ * @public
359
+ */
360
+ EmailMessage: InboundEmailContent | undefined;
361
+ /**
362
+ * <p>The addtional recipients address of the email.</p>
363
+ * @public
364
+ */
365
+ AdditionalRecipients?: InboundAdditionalRecipients | undefined;
366
+ /**
367
+ * <p>List of S3 presigned URLs of email attachments and their file name. </p>
368
+ * @public
369
+ */
370
+ Attachments?: EmailAttachment[] | undefined;
371
+ /**
372
+ * <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website,
373
+ * on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
374
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
375
+ * part of the ARN, shown here in bold: </p>
376
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
377
+ * </p>
378
+ * @public
379
+ */
380
+ ContactFlowId?: string | undefined;
381
+ /**
382
+ * <p>The contactId that is related to this contact. Linking emails together by using
383
+ * <code>RelatedContactID</code> copies over contact attributes from the related email contact to
384
+ * the new email contact. All updates to user-defined attributes in the new email contact are
385
+ * limited to the individual contact ID. There are no limits to the number of contacts that can be
386
+ * linked by using <code>RelatedContactId</code>. </p>
387
+ * @public
388
+ */
389
+ RelatedContactId?: string | undefined;
390
+ /**
391
+ * <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>
392
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
393
+ * can include only alphanumeric, dash, and underscore characters.</p>
394
+ * @public
395
+ */
396
+ Attributes?: Record<string, string> | undefined;
397
+ /**
398
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
399
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
400
+ * flows.</p>
401
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
402
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
403
+ * <note>
404
+ * <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer
405
+ * number of minutes the contact will be active for before expiring, with
406
+ * <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{
407
+ * "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
408
+ * </note>
409
+ * @public
410
+ */
411
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
412
+ /**
413
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
414
+ * request. If not provided, the Amazon Web Services
415
+ * SDK populates this field. For more information about idempotency, see
416
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
417
+ * @public
418
+ */
419
+ ClientToken?: string | undefined;
420
+ }
421
+ /**
422
+ * @public
423
+ */
424
+ export interface StartOutboundChatContactRequest {
425
+ /**
426
+ * <p>Information about the endpoint.</p>
427
+ * @public
428
+ */
429
+ SourceEndpoint: Endpoint | undefined;
430
+ /**
431
+ * <p>Information about the endpoint.</p>
432
+ * @public
433
+ */
434
+ DestinationEndpoint: Endpoint | undefined;
435
+ /**
436
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
437
+ * Amazon Resource Name (ARN) of the instance.</p>
438
+ * @public
439
+ */
440
+ InstanceId: string | undefined;
441
+ /**
442
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
443
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
444
+ * flows.</p>
445
+ * <ul>
446
+ * <li>
447
+ * <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
448
+ * </li>
449
+ * <li>
450
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and
451
+ * <code>connect:SMS</code>.</p>
452
+ * </li>
453
+ * </ul>
454
+ * @public
455
+ */
456
+ SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
457
+ /**
458
+ * <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>
459
+ * @public
460
+ */
461
+ Attributes?: Record<string, string> | undefined;
462
+ /**
463
+ * <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect
464
+ * console user interface, on the navigation menu go to <b>Routing, Contact
465
+ * Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
466
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
467
+ * part of the ARN, shown here in bold:</p>
468
+ * <ul>
469
+ * <li>
470
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
471
+ * </p>
472
+ * </li>
473
+ * </ul>
474
+ * @public
475
+ */
476
+ ContactFlowId: string | undefined;
477
+ /**
478
+ * <p>The total duration of the newly started chat session. If not specified, the chat session
479
+ * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
480
+ * configurable time is 10,080 minutes (7 days).</p>
481
+ * @public
482
+ */
483
+ ChatDurationInMinutes?: number | undefined;
484
+ /**
485
+ * <p>The customer's details.</p>
486
+ * @public
487
+ */
488
+ ParticipantDetails?: ParticipantDetails | undefined;
489
+ /**
490
+ * <p>A chat message.</p>
491
+ * @public
492
+ */
493
+ InitialSystemMessage?: ChatMessage | undefined;
494
+ /**
495
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
496
+ * contact starting.</p>
497
+ * @public
498
+ */
499
+ RelatedContactId?: string | undefined;
500
+ /**
501
+ * <p>The supported chat message content types. Supported types are:</p>
502
+ * <ul>
503
+ * <li>
504
+ * <p>
505
+ * <code>text/plain</code>
506
+ * </p>
507
+ * </li>
508
+ * <li>
509
+ * <p>
510
+ * <code>text/markdown</code>
511
+ * </p>
512
+ * </li>
513
+ * <li>
514
+ * <p>
515
+ * <code>application/json,
516
+ * application/vnd.amazonaws.connect.message.interactive</code>
517
+ * </p>
518
+ * </li>
519
+ * <li>
520
+ * <p>
521
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>
522
+ * </p>
523
+ * </li>
524
+ * </ul>
525
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other
526
+ * supported type in the list. For example, all the following lists are valid because they contain
527
+ * <code>text/plain</code>:</p>
528
+ * <ul>
529
+ * <li>
530
+ * <p>
531
+ * <code>[text/plain, text/markdown, application/json]</code>
532
+ * </p>
533
+ * </li>
534
+ * <li>
535
+ * <p>
536
+ * <code>[text/markdown, text/plain]</code>
537
+ * </p>
538
+ * </li>
539
+ * <li>
540
+ * <p>
541
+ * <code>[text/plain, application/json,
542
+ * application/vnd.amazonaws.connect.message.interactive.response]</code>
543
+ * </p>
544
+ * </li>
545
+ * </ul>
546
+ * @public
547
+ */
548
+ SupportedMessagingContentTypes?: string[] | undefined;
549
+ /**
550
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
551
+ * request. If not provided, the AWS SDK populates this field. For more information about
552
+ * idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making
553
+ * retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a
554
+ * contact is already started, the contact ID is returned.</p>
555
+ * @public
556
+ */
557
+ ClientToken?: string | undefined;
558
+ }
559
+ /**
560
+ * @public
561
+ */
562
+ export interface StartTaskContactRequest {
563
+ /**
564
+ * <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>
565
+ * @public
566
+ */
567
+ InstanceId: string | undefined;
568
+ /**
569
+ * <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
570
+ * attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
571
+ * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
572
+ * @public
573
+ */
574
+ PreviousContactId?: string | undefined;
575
+ /**
576
+ * <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
577
+ * on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
578
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
579
+ * part of the ARN, shown here in bold: </p>
580
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
581
+ * </p>
582
+ * @public
583
+ */
584
+ ContactFlowId?: string | undefined;
585
+ /**
586
+ * <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>
587
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
588
+ * can include only alphanumeric, dash, and underscore characters.</p>
589
+ * @public
590
+ */
591
+ Attributes?: Record<string, string> | undefined;
592
+ /**
593
+ * <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
594
+ * @public
595
+ */
596
+ Name: string | undefined;
597
+ /**
598
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
599
+ * the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
600
+ * <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
601
+ * supported reference type during task creation.</p>
602
+ * @public
603
+ */
604
+ References?: Record<string, Reference> | undefined;
605
+ /**
606
+ * <p>A description of the task that is shown to an agent in the Contact Control Panel
607
+ * (CCP).</p>
608
+ * @public
609
+ */
610
+ Description?: string | undefined;
611
+ /**
612
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
613
+ * request. If not provided, the Amazon Web Services
614
+ * SDK populates this field. For more information about idempotency, see
615
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
616
+ * @public
617
+ */
618
+ ClientToken?: string | undefined;
619
+ /**
620
+ * <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>
621
+ * @public
622
+ */
623
+ ScheduledTime?: Date | undefined;
624
+ /**
625
+ * <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the
626
+ * <i>Amazon Connect Administrator Guide</i>. </p>
627
+ * @public
628
+ */
629
+ TaskTemplateId?: string | undefined;
630
+ /**
631
+ * <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
632
+ * flow that is defined on agent or queue quick connect. For more information about quick connects,
633
+ * see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
634
+ * connects</a>.</p>
635
+ * @public
636
+ */
637
+ QuickConnectId?: string | undefined;
638
+ /**
639
+ * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking
640
+ * tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
641
+ * related task contact to the new task contact. All updates to user-defined attributes in the new
642
+ * task contact are limited to the individual contact ID, unlike what happens when tasks are linked
643
+ * by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
644
+ * be linked by using <code>RelatedContactId</code>. </p>
645
+ * @public
646
+ */
647
+ RelatedContactId?: string | undefined;
648
+ /**
649
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique
650
+ * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
651
+ * They can be accessed in flows.</p>
652
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
653
+ * <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for
654
+ * the User who created a task.</p>
655
+ * <note>
656
+ * <p>To set contact expiry, a ValueMap must be specified containing the integer number of
657
+ * minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
658
+ * \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
659
+ * 135\}\}\}\}</code>. </p>
660
+ * <p>To set the created by user, a valid AgentResourceId must be supplied, with
661
+ * <code>SegmentAttributes</code> like \{ <code>"connect:CreatedByUser" \{ "ValueString":
662
+ * "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
663
+ * </p>
664
+ * </note>
665
+ * @public
666
+ */
667
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
668
+ }
669
+ /**
670
+ * @public
671
+ */
672
+ export interface UpdateContactRequest {
673
+ /**
674
+ * <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>
675
+ * @public
676
+ */
677
+ InstanceId: string | undefined;
678
+ /**
679
+ * <p>The identifier of the contact. This is the identifier of the contact associated with the
680
+ * first interaction with your contact center.</p>
681
+ * @public
682
+ */
683
+ ContactId: string | undefined;
684
+ /**
685
+ * <p>The name of the contact.</p>
686
+ * @public
687
+ */
688
+ Name?: string | undefined;
689
+ /**
690
+ * <p>The description of the contact.</p>
691
+ * @public
692
+ */
693
+ Description?: string | undefined;
694
+ /**
695
+ * <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
696
+ * @public
697
+ */
698
+ References?: Record<string, Reference> | undefined;
699
+ /**
700
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique
701
+ * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
702
+ * They can be accessed in flows.</p>
703
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
704
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
705
+ * <p>Currently Contact Expiry is the only segment attribute which can be updated by using the
706
+ * UpdateContact API.</p>
707
+ * @public
708
+ */
709
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
710
+ }
711
+ /**
712
+ * @public
713
+ */
714
+ export interface UpdateEvaluationFormRequest {
715
+ /**
716
+ * <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>
717
+ * @public
718
+ */
719
+ InstanceId: string | undefined;
720
+ /**
721
+ * <p>The unique identifier for the evaluation form.</p>
722
+ * @public
723
+ */
724
+ EvaluationFormId: string | undefined;
725
+ /**
726
+ * <p>A version of the evaluation form to update.</p>
727
+ * @public
728
+ */
729
+ EvaluationFormVersion: number | undefined;
730
+ /**
731
+ * <p>A flag indicating whether the operation must create a new version.</p>
732
+ * @public
733
+ */
734
+ CreateNewVersion?: boolean | undefined;
735
+ /**
736
+ * <p>A title of the evaluation form.</p>
737
+ * @public
738
+ */
739
+ Title: string | undefined;
740
+ /**
741
+ * <p>The description of the evaluation form.</p>
742
+ * @public
743
+ */
744
+ Description?: string | undefined;
745
+ /**
746
+ * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
747
+ * @public
748
+ */
749
+ Items: EvaluationFormItem[] | undefined;
750
+ /**
751
+ * <p>A scoring strategy of the evaluation form.</p>
752
+ * @public
753
+ */
754
+ ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
755
+ /**
756
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
757
+ * request. If not provided, the Amazon Web Services
758
+ * SDK populates this field. For more information about idempotency, see
759
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
760
+ * @public
761
+ */
762
+ ClientToken?: string | undefined;
763
+ }
764
+ /**
765
+ * <p>The search criteria to be used to return userHierarchyGroup.</p>
766
+ * @public
767
+ */
768
+ export interface UserHierarchyGroupSearchCriteria {
769
+ /**
770
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
771
+ * @public
772
+ */
773
+ OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
774
+ /**
775
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
776
+ * @public
777
+ */
778
+ AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
779
+ /**
780
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
781
+ * <note>
782
+ * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
783
+ * <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
784
+ * </note>
785
+ * @public
786
+ */
787
+ StringCondition?: StringCondition | undefined;
788
+ }
789
+ /**
790
+ * <p>The search criteria to be used to return users.</p>
791
+ * <note>
792
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
793
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
794
+ * outside of this range will throw invalid results. </p>
795
+ * </note>
796
+ * @public
797
+ */
798
+ export interface UserSearchCriteria {
799
+ /**
800
+ * <p>A list of conditions which would be applied together with an <code>OR</code>
801
+ * condition.</p>
802
+ * @public
803
+ */
804
+ OrConditions?: UserSearchCriteria[] | undefined;
805
+ /**
806
+ * <p>A list of conditions which would be applied together with an <code>AND</code> condition.
807
+ * </p>
808
+ * @public
809
+ */
810
+ AndConditions?: UserSearchCriteria[] | undefined;
811
+ /**
812
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
813
+ * <p>The currently supported values for <code>FieldName</code> are <code>Username</code>,
814
+ * <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>,
815
+ * <code>SecurityProfileId</code>, <code>ResourceId</code>.</p>
816
+ * @public
817
+ */
818
+ StringCondition?: StringCondition | undefined;
819
+ /**
820
+ * <p>A leaf node condition which can be used to specify a List condition to search users with
821
+ * attributes included in Lists like Proficiencies.</p>
822
+ * @public
823
+ */
824
+ ListCondition?: ListCondition | undefined;
825
+ /**
826
+ * <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
827
+ * @public
828
+ */
829
+ HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
830
+ }
831
+ /**
832
+ * @public
833
+ */
834
+ export interface DescribeContactEvaluationResponse {
835
+ /**
836
+ * <p>Information about the evaluation form completed for a specific contact.</p>
837
+ * @public
838
+ */
839
+ Evaluation: Evaluation | undefined;
840
+ /**
841
+ * <p>Information about the evaluation form.</p>
842
+ * @public
843
+ */
844
+ EvaluationForm: EvaluationFormContent | undefined;
845
+ }
846
+ /**
847
+ * @public
848
+ */
849
+ export interface DescribeEvaluationFormResponse {
850
+ /**
851
+ * <p>Information about the evaluation form.</p>
852
+ * @public
853
+ */
854
+ EvaluationForm: EvaluationForm | undefined;
855
+ }
856
+ /**
857
+ * <p>Step defines the list of agents to be routed or route based on the agent requirements such
858
+ * as ProficiencyLevel, Name, or Value.</p>
859
+ * @public
860
+ */
861
+ export interface RoutingCriteriaInputStep {
862
+ /**
863
+ * <p>An object to specify the expiration of a routing step.</p>
864
+ * @public
865
+ */
866
+ Expiry?: RoutingCriteriaInputStepExpiry | undefined;
867
+ /**
868
+ * <p>A tagged union to specify expression for a routing step.</p>
869
+ * @public
870
+ */
871
+ Expression?: Expression | undefined;
872
+ }
873
+ /**
874
+ * @public
875
+ */
876
+ export interface SearchAgentStatusesRequest {
877
+ /**
878
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
879
+ * the instance.</p>
880
+ * @public
881
+ */
882
+ InstanceId: string | undefined;
883
+ /**
884
+ * <p>The token for the next set of results. Use the value returned in the previous response in
885
+ * the next request to retrieve the next set of results.</p>
886
+ * @public
887
+ */
888
+ NextToken?: string | undefined;
889
+ /**
890
+ * <p>The maximum number of results to return per page.</p>
891
+ * @public
892
+ */
893
+ MaxResults?: number | undefined;
894
+ /**
895
+ * <p>Filters to be applied to search results.</p>
896
+ * @public
897
+ */
898
+ SearchFilter?: AgentStatusSearchFilter | undefined;
899
+ /**
900
+ * <p>The search criteria to be used to return agent statuses.</p>
901
+ * @public
902
+ */
903
+ SearchCriteria?: AgentStatusSearchCriteria | undefined;
904
+ }
905
+ /**
906
+ * @public
907
+ */
908
+ export interface SearchContactFlowModulesRequest {
909
+ /**
910
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
911
+ * Amazon Resource Name (ARN) of the instance.</p>
912
+ * @public
913
+ */
914
+ InstanceId: string | undefined;
915
+ /**
916
+ * <p>The token for the next set of results. Use the value returned in the previous response in
917
+ * the next request to retrieve the next set of results.</p>
918
+ * @public
919
+ */
920
+ NextToken?: string | undefined;
921
+ /**
922
+ * <p>The maximum number of results to return per page.</p>
923
+ * @public
924
+ */
925
+ MaxResults?: number | undefined;
926
+ /**
927
+ * <p>Filters to be applied to search results.</p>
928
+ * @public
929
+ */
930
+ SearchFilter?: ContactFlowModuleSearchFilter | undefined;
931
+ /**
932
+ * <p>The search criteria to be used to return flow modules.</p>
933
+ * <note>
934
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
935
+ * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
936
+ * outside of this range will result in invalid results.</p>
937
+ * </note>
938
+ * @public
939
+ */
940
+ SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
941
+ }
942
+ /**
943
+ * @public
944
+ */
945
+ export interface SearchContactFlowsRequest {
946
+ /**
947
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
948
+ * Amazon Resource Name (ARN) of the instance.</p>
949
+ * @public
950
+ */
951
+ InstanceId: string | undefined;
952
+ /**
953
+ * <p>The token for the next set of results. Use the value returned in the previous response in
954
+ * the next request to retrieve the next set of results.</p>
955
+ * @public
956
+ */
957
+ NextToken?: string | undefined;
958
+ /**
959
+ * <p>The maximum number of results to return per page.</p>
960
+ * @public
961
+ */
962
+ MaxResults?: number | undefined;
963
+ /**
964
+ * <p>Filters to be applied to search results.</p>
965
+ * @public
966
+ */
967
+ SearchFilter?: ContactFlowSearchFilter | undefined;
968
+ /**
969
+ * <p>The search criteria to be used to return flows.</p>
970
+ * <note>
971
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
972
+ * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
973
+ * outside of this range will result in invalid results.</p>
974
+ * </note>
975
+ * @public
976
+ */
977
+ SearchCriteria?: ContactFlowSearchCriteria | undefined;
978
+ }
979
+ /**
980
+ * @public
981
+ */
982
+ export interface SearchEmailAddressesRequest {
983
+ /**
984
+ * <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>
985
+ * @public
986
+ */
987
+ InstanceId: string | undefined;
988
+ /**
989
+ * <p>The maximum number of results to return per page.</p>
990
+ * @public
991
+ */
992
+ MaxResults?: number | undefined;
993
+ /**
994
+ * <p>The token for the next set of results. Use the value returned in the previous
995
+ * response in the next request to retrieve the next set of results.</p>
996
+ * @public
997
+ */
998
+ NextToken?: string | undefined;
999
+ /**
1000
+ * <p>The search criteria to be used to return email addresses.</p>
1001
+ * @public
1002
+ */
1003
+ SearchCriteria?: EmailAddressSearchCriteria | undefined;
1004
+ /**
1005
+ * <p>Filters to be applied to search results.</p>
1006
+ * @public
1007
+ */
1008
+ SearchFilter?: EmailAddressSearchFilter | undefined;
1009
+ }
1010
+ /**
1011
+ * @public
1012
+ */
1013
+ export interface SearchHoursOfOperationsRequest {
1014
+ /**
1015
+ * <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>
1016
+ * @public
1017
+ */
1018
+ InstanceId: string | undefined;
1019
+ /**
1020
+ * <p>The token for the next set of results. Use the value returned in the previous
1021
+ * response in the next request to retrieve the next set of results.</p>
1022
+ * @public
1023
+ */
1024
+ NextToken?: string | undefined;
1025
+ /**
1026
+ * <p>The maximum number of results to return per page.</p>
1027
+ * @public
1028
+ */
1029
+ MaxResults?: number | undefined;
1030
+ /**
1031
+ * <p>Filters to be applied to search results.</p>
1032
+ * @public
1033
+ */
1034
+ SearchFilter?: HoursOfOperationSearchFilter | undefined;
1035
+ /**
1036
+ * <p>The search criteria to be used to return hours of operations.</p>
1037
+ * @public
1038
+ */
1039
+ SearchCriteria?: HoursOfOperationSearchCriteria | undefined;
1040
+ }
1041
+ /**
1042
+ * @public
1043
+ */
1044
+ export interface SearchPredefinedAttributesRequest {
1045
+ /**
1046
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
1047
+ * Name (ARN) of the instance.</p>
1048
+ * @public
1049
+ */
1050
+ InstanceId: string | undefined;
1051
+ /**
1052
+ * <p>The token for the next set of results. Use the value returned in the previous response in
1053
+ * the next request to retrieve the next set of results.</p>
1054
+ * @public
1055
+ */
1056
+ NextToken?: string | undefined;
1057
+ /**
1058
+ * <p>The maximum number of results to return per page.</p>
1059
+ * @public
1060
+ */
1061
+ MaxResults?: number | undefined;
1062
+ /**
1063
+ * <p>The search criteria to be used to return predefined attributes.</p>
1064
+ * @public
1065
+ */
1066
+ SearchCriteria?: PredefinedAttributeSearchCriteria | undefined;
1067
+ }
1068
+ /**
1069
+ * @public
1070
+ */
1071
+ export interface SearchPromptsRequest {
1072
+ /**
1073
+ * <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>
1074
+ * @public
1075
+ */
1076
+ InstanceId: string | undefined;
1077
+ /**
1078
+ * <p>The token for the next set of results. Use the value returned in the previous
1079
+ * response in the next request to retrieve the next set of results.</p>
1080
+ * @public
1081
+ */
1082
+ NextToken?: string | undefined;
1083
+ /**
1084
+ * <p>The maximum number of results to return per page.</p>
1085
+ * @public
1086
+ */
1087
+ MaxResults?: number | undefined;
1088
+ /**
1089
+ * <p>Filters to be applied to search results.</p>
1090
+ * @public
1091
+ */
1092
+ SearchFilter?: PromptSearchFilter | undefined;
1093
+ /**
1094
+ * <p>The search criteria to be used to return prompts.</p>
1095
+ * @public
1096
+ */
1097
+ SearchCriteria?: PromptSearchCriteria | undefined;
1098
+ }
1099
+ /**
1100
+ * @public
1101
+ */
1102
+ export interface SearchQueuesRequest {
1103
+ /**
1104
+ * <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>
1105
+ * @public
1106
+ */
1107
+ InstanceId: string | undefined;
1108
+ /**
1109
+ * <p>The token for the next set of results. Use the value returned in the previous
1110
+ * response in the next request to retrieve the next set of results.</p>
1111
+ * @public
1112
+ */
1113
+ NextToken?: string | undefined;
1114
+ /**
1115
+ * <p>The maximum number of results to return per page.</p>
1116
+ * @public
1117
+ */
1118
+ MaxResults?: number | undefined;
1119
+ /**
1120
+ * <p>Filters to be applied to search results.</p>
1121
+ * @public
1122
+ */
1123
+ SearchFilter?: QueueSearchFilter | undefined;
1124
+ /**
1125
+ * <p>The search criteria to be used to return queues.</p>
1126
+ * <note>
1127
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
1128
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
1129
+ * outside of this range will throw invalid results. </p>
1130
+ * </note>
1131
+ * @public
1132
+ */
1133
+ SearchCriteria?: QueueSearchCriteria | undefined;
1134
+ }
1135
+ /**
1136
+ * @public
1137
+ */
1138
+ export interface SearchQuickConnectsRequest {
1139
+ /**
1140
+ * <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>
1141
+ * @public
1142
+ */
1143
+ InstanceId: string | undefined;
1144
+ /**
1145
+ * <p>The token for the next set of results. Use the value returned in the previous
1146
+ * response in the next request to retrieve the next set of results.</p>
1147
+ * @public
1148
+ */
1149
+ NextToken?: string | undefined;
1150
+ /**
1151
+ * <p>The maximum number of results to return per page.</p>
1152
+ * @public
1153
+ */
1154
+ MaxResults?: number | undefined;
1155
+ /**
1156
+ * <p>Filters to be applied to search results.</p>
1157
+ * @public
1158
+ */
1159
+ SearchFilter?: QuickConnectSearchFilter | undefined;
1160
+ /**
1161
+ * <p>The search criteria to be used to return quick connects.</p>
1162
+ * @public
1163
+ */
1164
+ SearchCriteria?: QuickConnectSearchCriteria | undefined;
1165
+ }
1166
+ /**
1167
+ * @public
1168
+ */
1169
+ export interface SearchRoutingProfilesRequest {
1170
+ /**
1171
+ * <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>
1172
+ * @public
1173
+ */
1174
+ InstanceId: string | undefined;
1175
+ /**
1176
+ * <p>The token for the next set of results. Use the value returned in the previous
1177
+ * response in the next request to retrieve the next set of results.</p>
1178
+ * @public
1179
+ */
1180
+ NextToken?: string | undefined;
1181
+ /**
1182
+ * <p>The maximum number of results to return per page.</p>
1183
+ * @public
1184
+ */
1185
+ MaxResults?: number | undefined;
1186
+ /**
1187
+ * <p>Filters to be applied to search results.</p>
1188
+ * @public
1189
+ */
1190
+ SearchFilter?: RoutingProfileSearchFilter | undefined;
1191
+ /**
1192
+ * <p>The search criteria to be used to return routing profiles.</p>
1193
+ * <note>
1194
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
1195
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
1196
+ * outside of this range will throw invalid results. </p>
1197
+ * </note>
1198
+ * @public
1199
+ */
1200
+ SearchCriteria?: RoutingProfileSearchCriteria | undefined;
1201
+ }
1202
+ /**
1203
+ * @public
1204
+ */
1205
+ export interface SearchSecurityProfilesRequest {
1206
+ /**
1207
+ * <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>
1208
+ * @public
1209
+ */
1210
+ InstanceId: string | undefined;
1211
+ /**
1212
+ * <p>The token for the next set of results. Use the value returned in the previous
1213
+ * response in the next request to retrieve the next set of results.</p>
1214
+ * @public
1215
+ */
1216
+ NextToken?: string | undefined;
1217
+ /**
1218
+ * <p>The maximum number of results to return per page.</p>
1219
+ * @public
1220
+ */
1221
+ MaxResults?: number | undefined;
1222
+ /**
1223
+ * <p>The search criteria to be used to return security profiles. </p>
1224
+ * <note>
1225
+ * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
1226
+ * maximum of 25 characters. Any queries with character lengths outside of this range will throw
1227
+ * invalid results.</p>
1228
+ * </note>
1229
+ * <note>
1230
+ * <p>The currently supported value for <code>FieldName</code>: <code>name</code>
1231
+ * </p>
1232
+ * </note>
1233
+ * @public
1234
+ */
1235
+ SearchCriteria?: SecurityProfileSearchCriteria | undefined;
1236
+ /**
1237
+ * <p>Filters to be applied to search results.</p>
1238
+ * @public
1239
+ */
1240
+ SearchFilter?: SecurityProfilesSearchFilter | undefined;
1241
+ }
1242
+ /**
1243
+ * @public
1244
+ */
1245
+ export interface SearchUserHierarchyGroupsRequest {
1246
+ /**
1247
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
1248
+ * the instance.</p>
1249
+ * @public
1250
+ */
1251
+ InstanceId: string | undefined;
1252
+ /**
1253
+ * <p>The token for the next set of results. Use the value returned in the previous response in
1254
+ * the next request to retrieve the next set of results.</p>
1255
+ * @public
1256
+ */
1257
+ NextToken?: string | undefined;
1258
+ /**
1259
+ * <p>The maximum number of results to return per page.</p>
1260
+ * @public
1261
+ */
1262
+ MaxResults?: number | undefined;
1263
+ /**
1264
+ * <p>Filters to be applied to search results.</p>
1265
+ * @public
1266
+ */
1267
+ SearchFilter?: UserHierarchyGroupSearchFilter | undefined;
1268
+ /**
1269
+ * <p>The search criteria to be used to return UserHierarchyGroups.</p>
1270
+ * @public
1271
+ */
1272
+ SearchCriteria?: UserHierarchyGroupSearchCriteria | undefined;
1273
+ }
1274
+ /**
1275
+ * @public
1276
+ */
1277
+ export interface SearchUsersRequest {
1278
+ /**
1279
+ * <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>
1280
+ * <note>
1281
+ * <p>InstanceID is a required field. The "Required: No" below is incorrect.</p>
1282
+ * </note>
1283
+ * @public
1284
+ */
1285
+ InstanceId: string | undefined;
1286
+ /**
1287
+ * <p>The token for the next set of results. Use the value returned in the previous
1288
+ * response in the next request to retrieve the next set of results.</p>
1289
+ * @public
1290
+ */
1291
+ NextToken?: string | undefined;
1292
+ /**
1293
+ * <p>The maximum number of results to return per page.</p>
1294
+ * @public
1295
+ */
1296
+ MaxResults?: number | undefined;
1297
+ /**
1298
+ * <p>Filters to be applied to search results.</p>
1299
+ * @public
1300
+ */
1301
+ SearchFilter?: UserSearchFilter | undefined;
1302
+ /**
1303
+ * <p>The search criteria to be used to return users.</p>
1304
+ * <note>
1305
+ * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
1306
+ * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
1307
+ * outside of this range will throw invalid results. </p>
1308
+ * </note>
1309
+ * @public
1310
+ */
1311
+ SearchCriteria?: UserSearchCriteria | undefined;
1312
+ }
1313
+ /**
1314
+ * <p>Step signifies the criteria to be used for routing to an agent</p>
1315
+ * @public
1316
+ */
1317
+ export interface Step {
1318
+ /**
1319
+ * <p>An object to specify the expiration of a routing step.</p>
1320
+ * @public
1321
+ */
1322
+ Expiry?: Expiry | undefined;
1323
+ /**
1324
+ * <p>A tagged union to specify expression for a routing step.</p>
1325
+ * @public
1326
+ */
1327
+ Expression?: Expression | undefined;
1328
+ /**
1329
+ * <p>Represents status of the Routing step.</p>
1330
+ * @public
1331
+ */
1332
+ Status?: RoutingCriteriaStepStatus | undefined;
1333
+ }
1334
+ /**
1335
+ * <p>Latest routing criteria on the contact.</p>
1336
+ * @public
1337
+ */
1338
+ export interface RoutingCriteria {
1339
+ /**
1340
+ * <p>List of routing steps. When Amazon Connect does not find an available agent meeting the
1341
+ * requirements in a step for a given step duration, the routing criteria will move on to the next
1342
+ * step sequentially until a join is completed with an agent. When all steps are exhausted, the
1343
+ * contact will be offered to any agent in the queue.</p>
1344
+ * @public
1345
+ */
1346
+ Steps?: Step[] | undefined;
1347
+ /**
1348
+ * <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is
1349
+ * activated when contact is transferred to a queue. ActivationTimestamp will be set on routing
1350
+ * criteria for contacts in agent queue even though Routing criteria is never activated for contacts
1351
+ * in agent queue.</p>
1352
+ * @public
1353
+ */
1354
+ ActivationTimestamp?: Date | undefined;
1355
+ /**
1356
+ * <p>Information about the index of the routing criteria.</p>
1357
+ * @public
1358
+ */
1359
+ Index?: number | undefined;
1360
+ }
1361
+ /**
1362
+ * <p>An object to define the RoutingCriteria.</p>
1363
+ * @public
1364
+ */
1365
+ export interface RoutingCriteriaInput {
1366
+ /**
1367
+ * <p>When Amazon Connect does not find an available agent meeting the requirements in a step
1368
+ * for
1369
+ a given step duration, the routing criteria will move on to the next step sequentially until
1370
+ * a
1371
+ join is completed with an agent. When all steps are exhausted, the contact will be offered to
1372
+ * any agent in the queue.</p>
1373
+ * @public
1374
+ */
1375
+ Steps?: RoutingCriteriaInputStep[] | undefined;
1376
+ }
1377
+ /**
1378
+ * @public
1379
+ */
1380
+ export interface UpdateContactRoutingDataRequest {
1381
+ /**
1382
+ * <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>
1383
+ * @public
1384
+ */
1385
+ InstanceId: string | undefined;
1386
+ /**
1387
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
1388
+ * @public
1389
+ */
1390
+ ContactId: string | undefined;
1391
+ /**
1392
+ * <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
1393
+ * to agents on a first-come, first-serve basis. This means that changing their amount of time in
1394
+ * queue compared to others also changes their position in queue.</p>
1395
+ * @public
1396
+ */
1397
+ QueueTimeAdjustmentSeconds?: number | undefined;
1398
+ /**
1399
+ * <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
1400
+ * raise the priority of a contact compared to other contacts in the queue by assigning them a
1401
+ * higher priority, such as 1 or 2.</p>
1402
+ * @public
1403
+ */
1404
+ QueuePriority?: number | undefined;
1405
+ /**
1406
+ * <p>Updates the routing criteria on the contact. These properties can be used to change how a
1407
+ * contact is routed within the queue.</p>
1408
+ * @public
1409
+ */
1410
+ RoutingCriteria?: RoutingCriteriaInput | undefined;
1411
+ }
1412
+ /**
1413
+ * <p>Contains information about a contact.</p>
1414
+ * @public
1415
+ */
1416
+ export interface Contact {
1417
+ /**
1418
+ * <p>The Amazon Resource Name (ARN) for the contact.</p>
1419
+ * @public
1420
+ */
1421
+ Arn?: string | undefined;
1422
+ /**
1423
+ * <p>The identifier for the contact.</p>
1424
+ * @public
1425
+ */
1426
+ Id?: string | undefined;
1427
+ /**
1428
+ * <p>If this contact is related to other contacts, this is the ID of the initial contact.</p>
1429
+ * @public
1430
+ */
1431
+ InitialContactId?: string | undefined;
1432
+ /**
1433
+ * <p>If this contact is not the first contact, this is the ID of the previous contact.</p>
1434
+ * @public
1435
+ */
1436
+ PreviousContactId?: string | undefined;
1437
+ /**
1438
+ * <p>This is the root contactId which is used as a unique identifier for all subsequent contacts
1439
+ * in a contact tree.</p>
1440
+ * @public
1441
+ */
1442
+ ContactAssociationId?: string | undefined;
1443
+ /**
1444
+ * <p>Indicates how the contact was initiated.</p>
1445
+ * @public
1446
+ */
1447
+ InitiationMethod?: ContactInitiationMethod | undefined;
1448
+ /**
1449
+ * <p>The name of the contact.</p>
1450
+ * @public
1451
+ */
1452
+ Name?: string | undefined;
1453
+ /**
1454
+ * <p>The description of the contact.</p>
1455
+ * @public
1456
+ */
1457
+ Description?: string | undefined;
1458
+ /**
1459
+ * <p>How the contact reached your contact center.</p>
1460
+ * @public
1461
+ */
1462
+ Channel?: Channel | undefined;
1463
+ /**
1464
+ * <p>If this contact was queued, this contains information about the queue. </p>
1465
+ * @public
1466
+ */
1467
+ QueueInfo?: QueueInfo | undefined;
1468
+ /**
1469
+ * <p>Information about the agent who accepted the contact.</p>
1470
+ * @public
1471
+ */
1472
+ AgentInfo?: AgentInfo | undefined;
1473
+ /**
1474
+ * <p>The date and time this contact was initiated, in UTC time. For <code>INBOUND</code>, this is
1475
+ * when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
1476
+ * <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
1477
+ * and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>,
1478
+ * this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent
1479
+ * started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
1480
+ * started listening to a contact.</p>
1481
+ * @public
1482
+ */
1483
+ InitiationTimestamp?: Date | undefined;
1484
+ /**
1485
+ * <p>The timestamp when the customer endpoint disconnected from Amazon Connect.</p>
1486
+ * @public
1487
+ */
1488
+ DisconnectTimestamp?: Date | undefined;
1489
+ /**
1490
+ * <p>The timestamp when contact was last updated.</p>
1491
+ * @public
1492
+ */
1493
+ LastUpdateTimestamp?: Date | undefined;
1494
+ /**
1495
+ * <p>The timestamp when the contact was last paused.</p>
1496
+ * @public
1497
+ */
1498
+ LastPausedTimestamp?: Date | undefined;
1499
+ /**
1500
+ * <p>The timestamp when the contact was last resumed.</p>
1501
+ * @public
1502
+ */
1503
+ LastResumedTimestamp?: Date | undefined;
1504
+ /**
1505
+ * <p>Total pause count for a contact.</p>
1506
+ * @public
1507
+ */
1508
+ TotalPauseCount?: number | undefined;
1509
+ /**
1510
+ * <p>Total pause duration for a contact in seconds.</p>
1511
+ * @public
1512
+ */
1513
+ TotalPauseDurationInSeconds?: number | undefined;
1514
+ /**
1515
+ * <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
1516
+ * </p>
1517
+ * @public
1518
+ */
1519
+ ScheduledTimestamp?: Date | undefined;
1520
+ /**
1521
+ * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid">related</a> to this
1522
+ * contact.</p>
1523
+ * @public
1524
+ */
1525
+ RelatedContactId?: string | undefined;
1526
+ /**
1527
+ * <p>Information about Amazon Connect Wisdom.</p>
1528
+ * @public
1529
+ */
1530
+ WisdomInfo?: WisdomInfo | undefined;
1531
+ /**
1532
+ * <p>The customer or external third party participant endpoint.</p>
1533
+ * @public
1534
+ */
1535
+ CustomerEndpoint?: EndpointInfo | undefined;
1536
+ /**
1537
+ * <p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address
1538
+ * that the customer dialed. For <code>OUTBOUND</code> and <code>EXTERNAL_OUTBOUND</code>, this is
1539
+ * the outbound caller ID number assigned to the outbound queue that is used to dial the customer.
1540
+ * For callback, this shows up as Softphone for calls handled by agents with softphone.</p>
1541
+ * @public
1542
+ */
1543
+ SystemEndpoint?: EndpointInfo | undefined;
1544
+ /**
1545
+ * <p>An integer that represents the queue time adjust to be applied to the contact, in seconds
1546
+ * (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority
1547
+ * is specified. Must be statically defined and a valid integer value.</p>
1548
+ * @public
1549
+ */
1550
+ QueueTimeAdjustmentSeconds?: number | undefined;
1551
+ /**
1552
+ * <p>An integer that represents the queue priority to be applied to the contact (lower priorities
1553
+ * are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified.
1554
+ * Must be statically defined, must be larger than zero, and a valid integer value. Default Value is
1555
+ * 5.</p>
1556
+ * @public
1557
+ */
1558
+ QueuePriority?: number | undefined;
1559
+ /**
1560
+ * <p>Tags associated with the contact. This contains both Amazon Web Services generated and
1561
+ * user-defined tags.</p>
1562
+ * @public
1563
+ */
1564
+ Tags?: Record<string, string> | undefined;
1565
+ /**
1566
+ * <p>The timestamp when customer endpoint connected to Amazon Connect.</p>
1567
+ * @public
1568
+ */
1569
+ ConnectedToSystemTimestamp?: Date | undefined;
1570
+ /**
1571
+ * <p>Latest routing criteria on the contact.</p>
1572
+ * @public
1573
+ */
1574
+ RoutingCriteria?: RoutingCriteria | undefined;
1575
+ /**
1576
+ * <p>Information about the Customer on the contact.</p>
1577
+ * @public
1578
+ */
1579
+ Customer?: Customer | undefined;
1580
+ /**
1581
+ * <p>Information associated with a campaign.</p>
1582
+ * @public
1583
+ */
1584
+ Campaign?: Campaign | undefined;
1585
+ /**
1586
+ * <p>Indicates how an <a href="https://docs.aws.amazon.com/connect/latest/adminguide/how-to-create-campaigns.html">outbound campaign</a> call is
1587
+ * actually disposed if the contact is connected to Amazon Connect.</p>
1588
+ * @public
1589
+ */
1590
+ AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus | undefined;
1591
+ /**
1592
+ * <p>Information about customer’s voice activity.</p>
1593
+ * @public
1594
+ */
1595
+ CustomerVoiceActivity?: CustomerVoiceActivity | undefined;
1596
+ /**
1597
+ * <p>Information about the quality of the participant's media connection.</p>
1598
+ * @public
1599
+ */
1600
+ QualityMetrics?: QualityMetrics | undefined;
1601
+ /**
1602
+ * <p>Information about the call disconnect experience.</p>
1603
+ * @public
1604
+ */
1605
+ DisconnectDetails?: DisconnectDetails | undefined;
1606
+ /**
1607
+ * <p>List of additional email addresses for an email contact.</p>
1608
+ * @public
1609
+ */
1610
+ AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
1611
+ /**
1612
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
1613
+ * attribute map. The attributes are standard Amazon Connect attributes and can be accessed in
1614
+ * flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used
1615
+ * to show channel subtype. For example, <code>connect:Guide</code> or
1616
+ * <code>connect:SMS</code>.</p>
1617
+ * @public
1618
+ */
1619
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
1620
+ }
1621
+ /**
1622
+ * @public
1623
+ */
1624
+ export interface DescribeContactResponse {
1625
+ /**
1626
+ * <p>Information about the contact.</p>
1627
+ * @public
1628
+ */
1629
+ Contact?: Contact | undefined;
1630
+ }
1631
+ /**
1632
+ * @internal
1633
+ */
1634
+ export declare const StartEmailContactRequestFilterSensitiveLog: (obj: StartEmailContactRequest) => any;
1635
+ /**
1636
+ * @internal
1637
+ */
1638
+ export declare const StartTaskContactRequestFilterSensitiveLog: (obj: StartTaskContactRequest) => any;
1639
+ /**
1640
+ * @internal
1641
+ */
1642
+ export declare const UpdateContactRequestFilterSensitiveLog: (obj: UpdateContactRequest) => any;
1643
+ /**
1644
+ * @internal
1645
+ */
1646
+ export declare const ContactFilterSensitiveLog: (obj: Contact) => any;
1647
+ /**
1648
+ * @internal
1649
+ */
1650
+ export declare const DescribeContactResponseFilterSensitiveLog: (obj: DescribeContactResponse) => any;