@aws-sdk/client-connect 3.699.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 (55) hide show
  1. package/dist-cjs/index.js +96 -47
  2. package/dist-es/commands/CreateContactCommand.js +1 -1
  3. package/dist-es/commands/StartEmailContactCommand.js +1 -1
  4. package/dist-es/commands/StartTaskContactCommand.js +1 -1
  5. package/dist-es/commands/UpdateContactCommand.js +1 -1
  6. package/dist-es/models/models_0.js +0 -5
  7. package/dist-es/models/models_1.js +5 -0
  8. package/dist-es/models/models_2.js +5 -27
  9. package/dist-es/models/models_3.js +23 -0
  10. package/dist-es/protocols/Aws_restJson1.js +57 -8
  11. package/dist-types/commands/CreateContactCommand.d.ts +13 -2
  12. package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
  13. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  14. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
  15. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
  16. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  17. package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
  18. package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
  19. package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
  20. package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
  21. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
  22. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  23. package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
  24. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
  25. package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
  26. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
  27. package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
  28. package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
  29. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +12 -1
  30. package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
  31. package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
  32. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  33. package/dist-types/commands/UpdateContactCommand.d.ts +12 -1
  34. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  35. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  36. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
  37. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
  38. package/dist-types/models/models_0.d.ts +60 -118
  39. package/dist-types/models/models_1.d.ts +117 -71
  40. package/dist-types/models/models_2.d.ts +544 -718
  41. package/dist-types/models/models_3.d.ts +545 -246
  42. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
  45. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
  46. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  47. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
  48. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  50. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  51. package/dist-types/ts3.4/models/models_0.d.ts +5 -21
  52. package/dist-types/ts3.4/models/models_1.d.ts +18 -6
  53. package/dist-types/ts3.4/models/models_2.d.ts +76 -97
  54. package/dist-types/ts3.4/models/models_3.d.ts +96 -58
  55. package/package.json +1 -1
@@ -1,430 +1,712 @@
1
- import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, EvaluationFormScoringStrategy, SegmentAttributeValue, StringCondition } from "./models_0";
2
- import { AnsweringMachineDetectionStatus, AttributeCondition, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, RoutingCriteriaStepStatus, WisdomInfo } from "./models_1";
3
- import { AgentStatusSearchCriteria, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, EmailAddressSearchFilter, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, ListCondition, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
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
4
  /**
5
- * <p>The search criteria to be used to return contact flows.</p>
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>
6
27
  * @public
7
28
  */
8
- export interface ContactFlowSearchCriteria {
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 {
9
55
  /**
10
56
  * <p>A list of conditions which would be applied together with an <code>OR</code>
11
57
  * condition.</p>
12
58
  * @public
13
59
  */
14
- OrConditions?: ContactFlowSearchCriteria[] | undefined;
60
+ OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
15
61
  /**
16
62
  * <p>A list of conditions which would be applied together with an <code>AND</code>
17
63
  * condition.</p>
18
64
  * @public
19
65
  */
20
- AndConditions?: ContactFlowSearchCriteria[] | undefined;
66
+ AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
21
67
  /**
22
68
  * <p>A leaf node condition which can be used to specify a string condition.</p>
23
69
  * @public
24
70
  */
25
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 {
26
78
  /**
27
- * <p>The type of flow.</p>
79
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
28
80
  * @public
29
81
  */
30
- TypeCondition?: ContactFlowType | undefined;
82
+ OrConditions?: PromptSearchCriteria[] | undefined;
31
83
  /**
32
- * <p>The state of the flow.</p>
84
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
33
85
  * @public
34
86
  */
35
- StateCondition?: ContactFlowState | undefined;
87
+ AndConditions?: PromptSearchCriteria[] | undefined;
36
88
  /**
37
- * <p>The status of the flow.</p>
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>
38
94
  * @public
39
95
  */
40
- StatusCondition?: ContactFlowStatus | undefined;
96
+ StringCondition?: StringCondition | undefined;
41
97
  }
42
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>
43
105
  * @public
44
106
  */
45
- export interface CreateEvaluationFormRequest {
107
+ export interface QueueSearchCriteria {
46
108
  /**
47
- * <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>
109
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
48
110
  * @public
49
111
  */
50
- InstanceId: string | undefined;
112
+ OrConditions?: QueueSearchCriteria[] | undefined;
51
113
  /**
52
- * <p>A title of the evaluation form.</p>
114
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
53
115
  * @public
54
116
  */
55
- Title: string | undefined;
117
+ AndConditions?: QueueSearchCriteria[] | undefined;
56
118
  /**
57
- * <p>The description of the evaluation form.</p>
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>
58
124
  * @public
59
125
  */
60
- Description?: string | undefined;
126
+ StringCondition?: StringCondition | undefined;
61
127
  /**
62
- * <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>
128
+ * <p>The type of queue.</p>
63
129
  * @public
64
130
  */
65
- Items: EvaluationFormItem[] | undefined;
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 {
66
138
  /**
67
- * <p>A scoring strategy of the evaluation form.</p>
139
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
68
140
  * @public
69
141
  */
70
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
142
+ OrConditions?: QuickConnectSearchCriteria[] | undefined;
71
143
  /**
72
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
73
- * request. If not provided, the Amazon Web Services
74
- * SDK populates this field. For more information about idempotency, see
75
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
144
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
76
145
  * @public
77
146
  */
78
- ClientToken?: string | undefined;
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;
79
157
  }
80
158
  /**
81
- * <p></p>
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>
82
165
  * @public
83
166
  */
84
- export interface EmailAddressSearchCriteria {
167
+ export interface RoutingProfileSearchCriteria {
85
168
  /**
86
- * <p></p>
169
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
87
170
  * @public
88
171
  */
89
- OrConditions?: EmailAddressSearchCriteria[] | undefined;
172
+ OrConditions?: RoutingProfileSearchCriteria[] | undefined;
90
173
  /**
91
- * <p></p>
174
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
92
175
  * @public
93
176
  */
94
- AndConditions?: EmailAddressSearchCriteria[] | undefined;
177
+ AndConditions?: RoutingProfileSearchCriteria[] | undefined;
95
178
  /**
96
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>
97
185
  * @public
98
186
  */
99
187
  StringCondition?: StringCondition | undefined;
100
188
  }
101
189
  /**
102
- * <p>Information about the evaluation form.</p>
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>
103
196
  * @public
104
197
  */
105
- export interface EvaluationForm {
198
+ export interface SecurityProfileSearchCriteria {
106
199
  /**
107
- * <p>The unique identifier for the evaluation form.</p>
200
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
108
201
  * @public
109
202
  */
110
- EvaluationFormId: string | undefined;
203
+ OrConditions?: SecurityProfileSearchCriteria[] | undefined;
111
204
  /**
112
- * <p>A version of the evaluation form.</p>
205
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
113
206
  * @public
114
207
  */
115
- EvaluationFormVersion: number | undefined;
208
+ AndConditions?: SecurityProfileSearchCriteria[] | undefined;
116
209
  /**
117
- * <p>The flag indicating whether the evaluation form is locked for changes.</p>
210
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
118
211
  * @public
119
212
  */
120
- Locked: boolean | undefined;
213
+ StringCondition?: StringCondition | undefined;
214
+ }
215
+ /**
216
+ * @public
217
+ */
218
+ export interface StartChatContactRequest {
121
219
  /**
122
- * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
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>
123
221
  * @public
124
222
  */
125
- EvaluationFormArn: string | undefined;
223
+ InstanceId: string | undefined;
126
224
  /**
127
- * <p>A title of the evaluation form.</p>
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>
128
232
  * @public
129
233
  */
130
- Title: string | undefined;
234
+ ContactFlowId: string | undefined;
131
235
  /**
132
- * <p>The description of the evaluation form.</p>
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>
133
239
  * @public
134
240
  */
135
- Description?: string | undefined;
241
+ Attributes?: Record<string, string> | undefined;
136
242
  /**
137
- * <p>The status of the evaluation form.</p>
243
+ * <p>Information identifying the participant.</p>
138
244
  * @public
139
245
  */
140
- Status: EvaluationFormVersionStatus | undefined;
246
+ ParticipantDetails: ParticipantDetails | undefined;
141
247
  /**
142
- * <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>
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>
143
250
  * @public
144
251
  */
145
- Items: EvaluationFormItem[] | undefined;
252
+ InitialMessage?: ChatMessage | undefined;
146
253
  /**
147
- * <p>A scoring strategy of the evaluation form.</p>
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>
148
258
  * @public
149
259
  */
150
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
260
+ ClientToken?: string | undefined;
151
261
  /**
152
- * <p>The timestamp for when the evaluation form was created.</p>
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>
153
265
  * @public
154
266
  */
155
- CreatedTime: Date | undefined;
267
+ ChatDurationInMinutes?: number | undefined;
156
268
  /**
157
- * <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
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>
158
283
  * @public
159
284
  */
160
- CreatedBy: string | undefined;
285
+ SupportedMessagingContentTypes?: string[] | undefined;
161
286
  /**
162
- * <p>The timestamp for when the evaluation form was last updated.</p>
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>
163
289
  * @public
164
290
  */
165
- LastModifiedTime: Date | undefined;
291
+ PersistentChat?: PersistentChat | undefined;
166
292
  /**
167
- * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
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>
168
298
  * @public
169
299
  */
170
- LastModifiedBy: string | undefined;
300
+ RelatedContactId?: string | undefined;
171
301
  /**
172
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
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>
173
314
  * @public
174
315
  */
175
- Tags?: Record<string, string> | undefined;
316
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
176
317
  }
177
318
  /**
178
- * <p>Information about an evaluation form used in a contact evaluation.</p>
179
319
  * @public
180
320
  */
181
- export interface EvaluationFormContent {
321
+ export interface StartEmailContactRequest {
182
322
  /**
183
- * <p>A version of the evaluation form.</p>
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>
184
324
  * @public
185
325
  */
186
- EvaluationFormVersion: number | undefined;
326
+ InstanceId: string | undefined;
187
327
  /**
188
- * <p>The unique identifier for the evaluation form.</p>
328
+ * <p>The email address of the customer.</p>
189
329
  * @public
190
330
  */
191
- EvaluationFormId: string | undefined;
331
+ FromEmailAddress: EmailAddressInfo | undefined;
192
332
  /**
193
- * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
333
+ * <p>The email address associated with the instance.</p>
194
334
  * @public
195
335
  */
196
- EvaluationFormArn: string | undefined;
336
+ DestinationEmailAddress: string | undefined;
197
337
  /**
198
- * <p>A title of the evaluation form.</p>
338
+ * <p>A description of the email contact.</p>
199
339
  * @public
200
340
  */
201
- Title: string | undefined;
341
+ Description?: string | undefined;
202
342
  /**
203
- * <p>The description of the evaluation form.</p>
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>
204
348
  * @public
205
349
  */
206
- Description?: string | undefined;
350
+ References?: Record<string, Reference> | undefined;
207
351
  /**
208
- * <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>
352
+ * <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
209
353
  * @public
210
354
  */
211
- Items: EvaluationFormItem[] | undefined;
355
+ Name?: string | undefined;
212
356
  /**
213
- * <p>A scoring strategy of the evaluation form.</p>
357
+ * <p>The email message body to be sent to the newly created email.</p>
214
358
  * @public
215
359
  */
216
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
217
- }
218
- /**
219
- * <p>A tagged union to specify expression for a routing step.</p>
220
- * @public
221
- */
222
- export interface Expression {
360
+ EmailMessage: InboundEmailContent | undefined;
223
361
  /**
224
- * <p>An object to specify the predefined attribute condition.</p>
362
+ * <p>The addtional recipients address of the email.</p>
225
363
  * @public
226
364
  */
227
- AttributeCondition?: AttributeCondition | undefined;
365
+ AdditionalRecipients?: InboundAdditionalRecipients | undefined;
228
366
  /**
229
- * <p>List of routing expressions which will be AND-ed together.</p>
367
+ * <p>List of S3 presigned URLs of email attachments and their file name. </p>
230
368
  * @public
231
369
  */
232
- AndExpression?: Expression[] | undefined;
370
+ Attachments?: EmailAttachment[] | undefined;
233
371
  /**
234
- * <p>List of routing expressions which will be OR-ed together.</p>
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>
235
378
  * @public
236
379
  */
237
- OrExpression?: Expression[] | undefined;
238
- }
239
- /**
240
- * <p>The search criteria to be used to return hours of operations.</p>
241
- * @public
242
- */
243
- export interface HoursOfOperationSearchCriteria {
380
+ ContactFlowId?: string | undefined;
244
381
  /**
245
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
246
387
  * @public
247
388
  */
248
- OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
389
+ RelatedContactId?: string | undefined;
249
390
  /**
250
- * <p>A list of conditions which would be applied together with an AND condition.</p>
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>
251
394
  * @public
252
395
  */
253
- AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
396
+ Attributes?: Record<string, string> | undefined;
254
397
  /**
255
- * <p>A leaf node condition which can be used to specify a string condition.</p>
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>
256
403
  * <note>
257
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
258
- * <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
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>
259
408
  * </note>
260
409
  * @public
261
410
  */
262
- StringCondition?: StringCondition | undefined;
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;
263
420
  }
264
421
  /**
265
- * <p>The search criteria to be used to return predefined attributes.</p>
266
422
  * @public
267
423
  */
268
- export interface PredefinedAttributeSearchCriteria {
424
+ export interface StartOutboundChatContactRequest {
269
425
  /**
270
- * <p>A list of conditions which would be applied together with an <code>OR</code>
271
- * condition.</p>
426
+ * <p>Information about the endpoint.</p>
272
427
  * @public
273
428
  */
274
- OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
429
+ SourceEndpoint: Endpoint | undefined;
275
430
  /**
276
- * <p>A list of conditions which would be applied together with an <code>AND</code>
277
- * condition.</p>
431
+ * <p>Information about the endpoint.</p>
278
432
  * @public
279
433
  */
280
- AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
434
+ DestinationEndpoint: Endpoint | undefined;
281
435
  /**
282
- * <p>A leaf node condition which can be used to specify a string condition.</p>
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>
283
438
  * @public
284
439
  */
285
- StringCondition?: StringCondition | undefined;
286
- }
287
- /**
288
- * <p>The search criteria to be used to return prompts.</p>
289
- * @public
290
- */
291
- export interface PromptSearchCriteria {
440
+ InstanceId: string | undefined;
292
441
  /**
293
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
294
454
  * @public
295
455
  */
296
- OrConditions?: PromptSearchCriteria[] | undefined;
456
+ SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
297
457
  /**
298
- * <p>A list of conditions which would be applied together with an AND condition.</p>
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>
299
459
  * @public
300
460
  */
301
- AndConditions?: PromptSearchCriteria[] | undefined;
461
+ Attributes?: Record<string, string> | undefined;
302
462
  /**
303
- * <p>A leaf node condition which can be used to specify a string condition.</p>
304
- * <note>
305
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
306
- * <code>description</code>, and <code>resourceID</code>.</p>
307
- * </note>
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>
308
474
  * @public
309
475
  */
310
- StringCondition?: StringCondition | undefined;
311
- }
312
- /**
313
- * <p>The search criteria to be used to return queues.</p>
314
- * <note>
315
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
316
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
317
- * outside of this range will throw invalid results. </p>
318
- * </note>
319
- * @public
320
- */
321
- export interface QueueSearchCriteria {
476
+ ContactFlowId: string | undefined;
322
477
  /**
323
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
324
481
  * @public
325
482
  */
326
- OrConditions?: QueueSearchCriteria[] | undefined;
483
+ ChatDurationInMinutes?: number | undefined;
327
484
  /**
328
- * <p>A list of conditions which would be applied together with an AND condition.</p>
485
+ * <p>The customer's details.</p>
329
486
  * @public
330
487
  */
331
- AndConditions?: QueueSearchCriteria[] | undefined;
488
+ ParticipantDetails?: ParticipantDetails | undefined;
332
489
  /**
333
- * <p>A leaf node condition which can be used to specify a string condition.</p>
334
- * <note>
335
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
336
- * <code>description</code>, and <code>resourceID</code>.</p>
337
- * </note>
490
+ * <p>A chat message.</p>
338
491
  * @public
339
492
  */
340
- StringCondition?: StringCondition | undefined;
493
+ InitialSystemMessage?: ChatMessage | undefined;
341
494
  /**
342
- * <p>The type of queue.</p>
495
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
496
+ * contact starting.</p>
343
497
  * @public
344
498
  */
345
- QueueTypeCondition?: SearchableQueueType | undefined;
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;
346
558
  }
347
559
  /**
348
- * <p>The search criteria to be used to return quick connects.</p>
349
560
  * @public
350
561
  */
351
- export interface QuickConnectSearchCriteria {
562
+ export interface StartTaskContactRequest {
352
563
  /**
353
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
354
565
  * @public
355
566
  */
356
- OrConditions?: QuickConnectSearchCriteria[] | undefined;
567
+ InstanceId: string | undefined;
357
568
  /**
358
- * <p>A list of conditions which would be applied together with an AND condition.</p>
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>
359
572
  * @public
360
573
  */
361
- AndConditions?: QuickConnectSearchCriteria[] | undefined;
574
+ PreviousContactId?: string | undefined;
362
575
  /**
363
- * <p>A leaf node condition which can be used to specify a string condition.</p>
364
- * <note>
365
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
366
- * <code>description</code>, and <code>resourceID</code>.</p>
367
- * </note>
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>
368
582
  * @public
369
583
  */
370
- StringCondition?: StringCondition | undefined;
371
- }
372
- /**
373
- * <p>The search criteria to be used to return routing profiles.</p>
374
- * <note>
375
- * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
376
- * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
377
- * outside of this range will throw invalid results. </p>
378
- * </note>
379
- * @public
380
- */
381
- export interface RoutingProfileSearchCriteria {
584
+ ContactFlowId?: string | undefined;
382
585
  /**
383
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
384
589
  * @public
385
590
  */
386
- OrConditions?: RoutingProfileSearchCriteria[] | undefined;
591
+ Attributes?: Record<string, string> | undefined;
387
592
  /**
388
- * <p>A list of conditions which would be applied together with an AND condition.</p>
593
+ * <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
389
594
  * @public
390
595
  */
391
- AndConditions?: RoutingProfileSearchCriteria[] | undefined;
596
+ Name: string | undefined;
392
597
  /**
393
- * <p>A leaf node condition which can be used to specify a string condition.</p>
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>
394
655
  * <note>
395
- * <p>The currently supported values for <code>FieldName</code> are
396
- * <code>associatedQueueIds</code>, <code>name</code>, <code>description</code>, and
397
- * <code>resourceID</code>.</p>
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>
398
664
  * </note>
399
665
  * @public
400
666
  */
401
- StringCondition?: StringCondition | undefined;
667
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
402
668
  }
403
669
  /**
404
- * <p>The search criteria to be used to return security profiles.</p>
405
- * <note>
406
- * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
407
- * maximum of 25 characters. Any queries with character lengths outside of this range will throw
408
- * invalid results.</p>
409
- * </note>
410
670
  * @public
411
671
  */
412
- export interface SecurityProfileSearchCriteria {
672
+ export interface UpdateContactRequest {
413
673
  /**
414
- * <p>A list of conditions which would be applied together with an OR condition.</p>
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>
415
675
  * @public
416
676
  */
417
- OrConditions?: SecurityProfileSearchCriteria[] | undefined;
677
+ InstanceId: string | undefined;
418
678
  /**
419
- * <p>A list of conditions which would be applied together with an AND condition.</p>
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>
420
681
  * @public
421
682
  */
422
- AndConditions?: SecurityProfileSearchCriteria[] | undefined;
683
+ ContactId: string | undefined;
423
684
  /**
424
- * <p>A leaf node condition which can be used to specify a string condition.</p>
685
+ * <p>The name of the contact.</p>
425
686
  * @public
426
687
  */
427
- StringCondition?: StringCondition | undefined;
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;
428
710
  }
429
711
  /**
430
712
  * @public
@@ -647,7 +929,7 @@ export interface SearchContactFlowModulesRequest {
647
929
  */
648
930
  SearchFilter?: ContactFlowModuleSearchFilter | undefined;
649
931
  /**
650
- * <p>The search criteria to be used to return contact flow modules.</p>
932
+ * <p>The search criteria to be used to return flow modules.</p>
651
933
  * <note>
652
934
  * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
653
935
  * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
@@ -699,27 +981,28 @@ export interface SearchContactFlowsRequest {
699
981
  */
700
982
  export interface SearchEmailAddressesRequest {
701
983
  /**
702
- * <p></p>
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>
703
985
  * @public
704
986
  */
705
987
  InstanceId: string | undefined;
706
988
  /**
707
- * <p></p>
989
+ * <p>The maximum number of results to return per page.</p>
708
990
  * @public
709
991
  */
710
992
  MaxResults?: number | undefined;
711
993
  /**
712
- * <p></p>
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>
713
996
  * @public
714
997
  */
715
998
  NextToken?: string | undefined;
716
999
  /**
717
- * <p></p>
1000
+ * <p>The search criteria to be used to return email addresses.</p>
718
1001
  * @public
719
1002
  */
720
1003
  SearchCriteria?: EmailAddressSearchCriteria | undefined;
721
1004
  /**
722
- * <p></p>
1005
+ * <p>Filters to be applied to search results.</p>
723
1006
  * @public
724
1007
  */
725
1008
  SearchFilter?: EmailAddressSearchFilter | undefined;
@@ -1091,6 +1374,41 @@ export interface RoutingCriteriaInput {
1091
1374
  */
1092
1375
  Steps?: RoutingCriteriaInputStep[] | undefined;
1093
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
+ }
1094
1412
  /**
1095
1413
  * <p>Contains information about a contact.</p>
1096
1414
  * @public
@@ -1117,7 +1435,8 @@ export interface Contact {
1117
1435
  */
1118
1436
  PreviousContactId?: string | undefined;
1119
1437
  /**
1120
- * <p></p>
1438
+ * <p>This is the root contactId which is used as a unique identifier for all subsequent contacts
1439
+ * in a contact tree.</p>
1121
1440
  * @public
1122
1441
  */
1123
1442
  ContactAssociationId?: string | undefined;
@@ -1210,12 +1529,15 @@ export interface Contact {
1210
1529
  */
1211
1530
  WisdomInfo?: WisdomInfo | undefined;
1212
1531
  /**
1213
- * <p></p>
1532
+ * <p>The customer or external third party participant endpoint.</p>
1214
1533
  * @public
1215
1534
  */
1216
1535
  CustomerEndpoint?: EndpointInfo | undefined;
1217
1536
  /**
1218
- * <p></p>
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>
1219
1541
  * @public
1220
1542
  */
1221
1543
  SystemEndpoint?: EndpointInfo | undefined;
@@ -1282,7 +1604,7 @@ export interface Contact {
1282
1604
  */
1283
1605
  DisconnectDetails?: DisconnectDetails | undefined;
1284
1606
  /**
1285
- * <p></p>
1607
+ * <p>List of additional email addresses for an email contact.</p>
1286
1608
  * @public
1287
1609
  */
1288
1610
  AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
@@ -1296,41 +1618,6 @@ export interface Contact {
1296
1618
  */
1297
1619
  SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
1298
1620
  }
1299
- /**
1300
- * @public
1301
- */
1302
- export interface UpdateContactRoutingDataRequest {
1303
- /**
1304
- * <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>
1305
- * @public
1306
- */
1307
- InstanceId: string | undefined;
1308
- /**
1309
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
1310
- * @public
1311
- */
1312
- ContactId: string | undefined;
1313
- /**
1314
- * <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
1315
- * to agents on a first-come, first-serve basis. This means that changing their amount of time in
1316
- * queue compared to others also changes their position in queue.</p>
1317
- * @public
1318
- */
1319
- QueueTimeAdjustmentSeconds?: number | undefined;
1320
- /**
1321
- * <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
1322
- * raise the priority of a contact compared to other contacts in the queue by assigning them a
1323
- * higher priority, such as 1 or 2.</p>
1324
- * @public
1325
- */
1326
- QueuePriority?: number | undefined;
1327
- /**
1328
- * <p>Updates the routing criteria on the contact. These properties can be used to change how a
1329
- * contact is routed within the queue.</p>
1330
- * @public
1331
- */
1332
- RoutingCriteria?: RoutingCriteriaInput | undefined;
1333
- }
1334
1621
  /**
1335
1622
  * @public
1336
1623
  */
@@ -1341,6 +1628,18 @@ export interface DescribeContactResponse {
1341
1628
  */
1342
1629
  Contact?: Contact | undefined;
1343
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;
1344
1643
  /**
1345
1644
  * @internal
1346
1645
  */