@aws-sdk/client-connect 3.1080.0 → 3.1082.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 (52) hide show
  1. package/README.md +14 -0
  2. package/dist-cjs/index.js +119 -54
  3. package/dist-es/Connect.js +4 -0
  4. package/dist-es/commands/CreateAuthCodeCommand.js +4 -0
  5. package/dist-es/commands/DeleteSessionCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +3 -0
  8. package/dist-es/schemas/schemas_0.js +97 -53
  9. package/dist-types/Connect.d.ts +14 -0
  10. package/dist-types/ConnectClient.d.ts +4 -2
  11. package/dist-types/commands/CreateAuthCodeCommand.d.ts +103 -0
  12. package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +2 -1
  13. package/dist-types/commands/CreateViewCommand.d.ts +1 -2
  14. package/dist-types/commands/DeleteSessionCommand.d.ts +88 -0
  15. package/dist-types/commands/GetFederationTokenCommand.d.ts +5 -2
  16. package/dist-types/commands/GetMetricDataCommand.d.ts +1 -2
  17. package/dist-types/commands/SearchDataTablesCommand.d.ts +1 -2
  18. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -1
  19. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +2 -1
  20. package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
  21. package/dist-types/commands/SearchTestCasesCommand.d.ts +2 -1
  22. package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -1
  23. package/dist-types/commands/index.d.ts +2 -0
  24. package/dist-types/models/enums.d.ts +11 -0
  25. package/dist-types/models/models_0.d.ts +80 -78
  26. package/dist-types/models/models_1.d.ts +106 -542
  27. package/dist-types/models/models_2.d.ts +535 -103
  28. package/dist-types/models/models_3.d.ts +105 -173
  29. package/dist-types/models/models_4.d.ts +171 -2
  30. package/dist-types/schemas/schemas_0.d.ts +7 -0
  31. package/dist-types/ts3.4/Connect.d.ts +34 -0
  32. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  33. package/dist-types/ts3.4/commands/CreateAuthCodeCommand.d.ts +43 -0
  34. package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +2 -4
  35. package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +1 -2
  36. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +43 -0
  37. package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +4 -2
  38. package/dist-types/ts3.4/commands/SearchDataTablesCommand.d.ts +4 -2
  39. package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +2 -4
  40. package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +2 -4
  41. package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +2 -4
  42. package/dist-types/ts3.4/commands/SearchTestCasesCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -4
  44. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  45. package/dist-types/ts3.4/models/enums.d.ts +5 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +19 -18
  47. package/dist-types/ts3.4/models/models_1.d.ts +24 -33
  48. package/dist-types/ts3.4/models/models_2.d.ts +35 -23
  49. package/dist-types/ts3.4/models/models_3.d.ts +23 -38
  50. package/dist-types/ts3.4/models/models_4.d.ts +47 -4
  51. package/dist-types/ts3.4/schemas/schemas_0.d.ts +7 -0
  52. package/package.json +8 -8
@@ -1,6 +1,539 @@
1
- import type { AgentStatusType, AiUseCase, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, NumberComparisonType, ParticipantRole, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
1
+ import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, Comparison, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, Grouping, HistoricalMetricName, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, NumberComparisonType, ParticipantRole, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
2
2
  import type { ActionSummary, AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusSummary, AiAgentsCriteria, AnalyticsDataAssociationResult, Application, ControlPlaneAttributeFilter, DataTableLockVersion, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, LexV2Bot, PrimaryValueResponse, SecurityProfileItem, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserProficiency } from "./models_0";
3
- import type { Attribute, ContactFlow, ContactFlowModule, DataTable, DataTableAttribute, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, HierarchyGroupSummary, HistoricalMetricResult, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
3
+ import type { Attribute, ContactFlow, ContactFlowModule, DataTableAttribute, Dimensions, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, Filters, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
4
+ /**
5
+ * <p>Contains information about the threshold for service level metrics.</p>
6
+ * @public
7
+ */
8
+ export interface Threshold {
9
+ /**
10
+ * <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
11
+ * @public
12
+ */
13
+ Comparison?: Comparison | undefined;
14
+ /**
15
+ * <p>The threshold value to compare.</p>
16
+ * @public
17
+ */
18
+ ThresholdValue?: number | undefined;
19
+ }
20
+ /**
21
+ * <p>Contains information about a historical metric. </p>
22
+ * @public
23
+ */
24
+ export interface HistoricalMetric {
25
+ /**
26
+ * <p>The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed
27
+ * description in the <i>Connect Customer Administrator Guide</i>. </p>
28
+ * <dl>
29
+ * <dt>ABANDON_TIME</dt>
30
+ * <dd>
31
+ * <p>Unit: SECONDS</p>
32
+ * <p>Statistic: AVG</p>
33
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
34
+ * time</a>
35
+ * </p>
36
+ * </dd>
37
+ * <dt>AFTER_CONTACT_WORK_TIME</dt>
38
+ * <dd>
39
+ * <p>Unit: SECONDS</p>
40
+ * <p>Statistic: AVG</p>
41
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a>
42
+ * </p>
43
+ * </dd>
44
+ * <dt>API_CONTACTS_HANDLED</dt>
45
+ * <dd>
46
+ * <p>Unit: COUNT</p>
47
+ * <p>Statistic: SUM</p>
48
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a>
49
+ * </p>
50
+ * </dd>
51
+ * <dt>AVG_HOLD_TIME</dt>
52
+ * <dd>
53
+ * <p>Unit: SECONDS</p>
54
+ * <p>Statistic: AVG</p>
55
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold
56
+ * time</a>
57
+ * </p>
58
+ * </dd>
59
+ * <dt>CALLBACK_CONTACTS_HANDLED</dt>
60
+ * <dd>
61
+ * <p>Unit: COUNT</p>
62
+ * <p>Statistic: SUM</p>
63
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts
64
+ * handled</a>
65
+ * </p>
66
+ * </dd>
67
+ * <dt>CONTACTS_ABANDONED</dt>
68
+ * <dd>
69
+ * <p>Unit: COUNT</p>
70
+ * <p>Statistic: SUM</p>
71
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a>
72
+ * </p>
73
+ * </dd>
74
+ * <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
75
+ * <dd>
76
+ * <p>Unit: COUNT</p>
77
+ * <p>Statistic: SUM</p>
78
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up
79
+ * first</a>
80
+ * </p>
81
+ * </dd>
82
+ * <dt>CONTACTS_CONSULTED</dt>
83
+ * <dd>
84
+ * <p>Unit: COUNT</p>
85
+ * <p>Statistic: SUM</p>
86
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a>
87
+ * </p>
88
+ * </dd>
89
+ * <dt>CONTACTS_HANDLED</dt>
90
+ * <dd>
91
+ * <p>Unit: COUNT</p>
92
+ * <p>Statistic: SUM</p>
93
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a>
94
+ * </p>
95
+ * </dd>
96
+ * <dt>CONTACTS_HANDLED_INCOMING</dt>
97
+ * <dd>
98
+ * <p>Unit: COUNT</p>
99
+ * <p>Statistic: SUM</p>
100
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled
101
+ * incoming</a>
102
+ * </p>
103
+ * </dd>
104
+ * <dt>CONTACTS_HANDLED_OUTBOUND</dt>
105
+ * <dd>
106
+ * <p>Unit: COUNT</p>
107
+ * <p>Statistic: SUM</p>
108
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled
109
+ * outbound</a>
110
+ * </p>
111
+ * </dd>
112
+ * <dt>CONTACTS_HOLD_ABANDONS</dt>
113
+ * <dd>
114
+ * <p>Unit: COUNT</p>
115
+ * <p>Statistic: SUM</p>
116
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold
117
+ * disconnect</a>
118
+ * </p>
119
+ * </dd>
120
+ * <dt>CONTACTS_MISSED</dt>
121
+ * <dd>
122
+ * <p>Unit: COUNT</p>
123
+ * <p>Statistic: SUM</p>
124
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
125
+ * </p>
126
+ * </dd>
127
+ * <dt>CONTACTS_QUEUED</dt>
128
+ * <dd>
129
+ * <p>Unit: COUNT</p>
130
+ * <p>Statistic: SUM</p>
131
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a>
132
+ * </p>
133
+ * </dd>
134
+ * <dt>CONTACTS_TRANSFERRED_IN</dt>
135
+ * <dd>
136
+ * <p>Unit: COUNT</p>
137
+ * <p>Statistic: SUM</p>
138
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a>
139
+ * </p>
140
+ * </dd>
141
+ * <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
142
+ * <dd>
143
+ * <p>Unit: COUNT</p>
144
+ * <p>Statistic: SUM</p>
145
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
146
+ * queue</a>
147
+ * </p>
148
+ * </dd>
149
+ * <dt>CONTACTS_TRANSFERRED_OUT</dt>
150
+ * <dd>
151
+ * <p>Unit: COUNT</p>
152
+ * <p>Statistic: SUM</p>
153
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred
154
+ * out</a>
155
+ * </p>
156
+ * </dd>
157
+ * <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
158
+ * <dd>
159
+ * <p>Unit: COUNT</p>
160
+ * <p>Statistic: SUM</p>
161
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
162
+ * queue</a>
163
+ * </p>
164
+ * </dd>
165
+ * <dt>HANDLE_TIME</dt>
166
+ * <dd>
167
+ * <p>Unit: SECONDS</p>
168
+ * <p>Statistic: AVG</p>
169
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a>
170
+ * </p>
171
+ * </dd>
172
+ * <dt>INTERACTION_AND_HOLD_TIME</dt>
173
+ * <dd>
174
+ * <p>Unit: SECONDS</p>
175
+ * <p>Statistic: AVG</p>
176
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average
177
+ * agent interaction and customer hold time</a>
178
+ * </p>
179
+ * </dd>
180
+ * <dt>INTERACTION_TIME</dt>
181
+ * <dd>
182
+ * <p>Unit: SECONDS</p>
183
+ * <p>Statistic: AVG</p>
184
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent
185
+ * interaction time</a>
186
+ * </p>
187
+ * </dd>
188
+ * <dt>OCCUPANCY</dt>
189
+ * <dd>
190
+ * <p>Unit: PERCENT</p>
191
+ * <p>Statistic: AVG</p>
192
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
193
+ * </p>
194
+ * </dd>
195
+ * <dt>QUEUE_ANSWER_TIME</dt>
196
+ * <dd>
197
+ * <p>Unit: SECONDS</p>
198
+ * <p>Statistic: AVG</p>
199
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer
200
+ * time</a>
201
+ * </p>
202
+ * </dd>
203
+ * <dt>QUEUED_TIME</dt>
204
+ * <dd>
205
+ * <p>Unit: SECONDS</p>
206
+ * <p>Statistic: MAX</p>
207
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a>
208
+ * </p>
209
+ * </dd>
210
+ * <dt>SERVICE_LEVEL</dt>
211
+ * <dd>
212
+ * <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
213
+ * <p>Unit: PERCENT</p>
214
+ * <p>Statistic: AVG</p>
215
+ * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds.
216
+ * For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than"). </p>
217
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level">Service level X</a>
218
+ * </p>
219
+ * </dd>
220
+ * </dl>
221
+ * @public
222
+ */
223
+ Name?: HistoricalMetricName | undefined;
224
+ /**
225
+ * <p>The threshold for the metric, used with service level metrics.</p>
226
+ * @public
227
+ */
228
+ Threshold?: Threshold | undefined;
229
+ /**
230
+ * <p>The statistic for the metric.</p>
231
+ * @public
232
+ */
233
+ Statistic?: Statistic | undefined;
234
+ /**
235
+ * <p>The unit for the metric.</p>
236
+ * @public
237
+ */
238
+ Unit?: Unit | undefined;
239
+ }
240
+ /**
241
+ * @public
242
+ */
243
+ export interface GetMetricDataRequest {
244
+ /**
245
+ * <p>The identifier of the Connect Customer 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>
246
+ * @public
247
+ */
248
+ InstanceId: string | undefined;
249
+ /**
250
+ * <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
251
+ * historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10,
252
+ * 10:15.</p>
253
+ * <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available
254
+ * only for 24 hours.</p>
255
+ * @public
256
+ */
257
+ StartTime: Date | undefined;
258
+ /**
259
+ * <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
260
+ * metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be
261
+ * later than the start time timestamp.</p>
262
+ * <p>The time range between the start and end time must be less than 24 hours.</p>
263
+ * @public
264
+ */
265
+ EndTime: Date | undefined;
266
+ /**
267
+ * <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
268
+ * resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
269
+ * ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
270
+ * <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
271
+ * more up-to-date features.</p>
272
+ * <note>
273
+ * <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of
274
+ * the queue.</p>
275
+ * </note>
276
+ * @public
277
+ */
278
+ Filters: Filters | undefined;
279
+ /**
280
+ * <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
281
+ * returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all
282
+ * queues.</p>
283
+ * <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
284
+ * <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
285
+ * more up-to-date features.</p>
286
+ * @public
287
+ */
288
+ Groupings?: Grouping[] | undefined;
289
+ /**
290
+ * <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics
291
+ * are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definition</a> in the <i>Connect Customer Administrator Guide</i>.</p>
292
+ * <note>
293
+ * <p>This API does not support a contacts incoming metric (there's
294
+ * no CONTACTS_INCOMING metric missing from the documented list). </p>
295
+ * </note>
296
+ * <dl>
297
+ * <dt>ABANDON_TIME</dt>
298
+ * <dd>
299
+ * <p>Unit: SECONDS</p>
300
+ * <p>Statistic: AVG</p>
301
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
302
+ * time</a>
303
+ * </p>
304
+ * </dd>
305
+ * <dt>AFTER_CONTACT_WORK_TIME</dt>
306
+ * <dd>
307
+ * <p>Unit: SECONDS</p>
308
+ * <p>Statistic: AVG</p>
309
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a>
310
+ * </p>
311
+ * </dd>
312
+ * <dt>API_CONTACTS_HANDLED</dt>
313
+ * <dd>
314
+ * <p>Unit: COUNT</p>
315
+ * <p>Statistic: SUM</p>
316
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a>
317
+ * </p>
318
+ * </dd>
319
+ * <dt>AVG_HOLD_TIME</dt>
320
+ * <dd>
321
+ * <p>Unit: SECONDS</p>
322
+ * <p>Statistic: AVG</p>
323
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold
324
+ * time</a>
325
+ * </p>
326
+ * </dd>
327
+ * <dt>CALLBACK_CONTACTS_HANDLED</dt>
328
+ * <dd>
329
+ * <p>Unit: COUNT</p>
330
+ * <p>Statistic: SUM</p>
331
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts
332
+ * handled</a>
333
+ * </p>
334
+ * </dd>
335
+ * <dt>CONTACTS_ABANDONED</dt>
336
+ * <dd>
337
+ * <p>Unit: COUNT</p>
338
+ * <p>Statistic: SUM</p>
339
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a>
340
+ * </p>
341
+ * </dd>
342
+ * <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
343
+ * <dd>
344
+ * <p>Unit: COUNT</p>
345
+ * <p>Statistic: SUM</p>
346
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up
347
+ * first</a>
348
+ * </p>
349
+ * </dd>
350
+ * <dt>CONTACTS_CONSULTED</dt>
351
+ * <dd>
352
+ * <p>Unit: COUNT</p>
353
+ * <p>Statistic: SUM</p>
354
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a>
355
+ * </p>
356
+ * </dd>
357
+ * <dt>CONTACTS_HANDLED</dt>
358
+ * <dd>
359
+ * <p>Unit: COUNT</p>
360
+ * <p>Statistic: SUM</p>
361
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a>
362
+ * </p>
363
+ * </dd>
364
+ * <dt>CONTACTS_HANDLED_INCOMING</dt>
365
+ * <dd>
366
+ * <p>Unit: COUNT</p>
367
+ * <p>Statistic: SUM</p>
368
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled
369
+ * incoming</a>
370
+ * </p>
371
+ * </dd>
372
+ * <dt>CONTACTS_HANDLED_OUTBOUND</dt>
373
+ * <dd>
374
+ * <p>Unit: COUNT</p>
375
+ * <p>Statistic: SUM</p>
376
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled
377
+ * outbound</a>
378
+ * </p>
379
+ * </dd>
380
+ * <dt>CONTACTS_HOLD_ABANDONS</dt>
381
+ * <dd>
382
+ * <p>Unit: COUNT</p>
383
+ * <p>Statistic: SUM</p>
384
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold
385
+ * disconnect</a>
386
+ * </p>
387
+ * </dd>
388
+ * <dt>CONTACTS_MISSED</dt>
389
+ * <dd>
390
+ * <p>Unit: COUNT</p>
391
+ * <p>Statistic: SUM</p>
392
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
393
+ * </p>
394
+ * </dd>
395
+ * <dt>CONTACTS_QUEUED</dt>
396
+ * <dd>
397
+ * <p>Unit: COUNT</p>
398
+ * <p>Statistic: SUM</p>
399
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a>
400
+ * </p>
401
+ * </dd>
402
+ * <dt>CONTACTS_TRANSFERRED_IN</dt>
403
+ * <dd>
404
+ * <p>Unit: COUNT</p>
405
+ * <p>Statistic: SUM</p>
406
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a>
407
+ * </p>
408
+ * </dd>
409
+ * <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
410
+ * <dd>
411
+ * <p>Unit: COUNT</p>
412
+ * <p>Statistic: SUM</p>
413
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
414
+ * queue</a>
415
+ * </p>
416
+ * </dd>
417
+ * <dt>CONTACTS_TRANSFERRED_OUT</dt>
418
+ * <dd>
419
+ * <p>Unit: COUNT</p>
420
+ * <p>Statistic: SUM</p>
421
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred
422
+ * out</a>
423
+ * </p>
424
+ * </dd>
425
+ * <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
426
+ * <dd>
427
+ * <p>Unit: COUNT</p>
428
+ * <p>Statistic: SUM</p>
429
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
430
+ * queue</a>
431
+ * </p>
432
+ * </dd>
433
+ * <dt>HANDLE_TIME</dt>
434
+ * <dd>
435
+ * <p>Unit: SECONDS</p>
436
+ * <p>Statistic: AVG</p>
437
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a>
438
+ * </p>
439
+ * </dd>
440
+ * <dt>INTERACTION_AND_HOLD_TIME</dt>
441
+ * <dd>
442
+ * <p>Unit: SECONDS</p>
443
+ * <p>Statistic: AVG</p>
444
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average
445
+ * agent interaction and customer hold time</a>
446
+ * </p>
447
+ * </dd>
448
+ * <dt>INTERACTION_TIME</dt>
449
+ * <dd>
450
+ * <p>Unit: SECONDS</p>
451
+ * <p>Statistic: AVG</p>
452
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent
453
+ * interaction time</a>
454
+ * </p>
455
+ * </dd>
456
+ * <dt>OCCUPANCY</dt>
457
+ * <dd>
458
+ * <p>Unit: PERCENT</p>
459
+ * <p>Statistic: AVG</p>
460
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
461
+ * </p>
462
+ * </dd>
463
+ * <dt>QUEUE_ANSWER_TIME</dt>
464
+ * <dd>
465
+ * <p>Unit: SECONDS</p>
466
+ * <p>Statistic: AVG</p>
467
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer
468
+ * time</a>
469
+ * </p>
470
+ * </dd>
471
+ * <dt>QUEUED_TIME</dt>
472
+ * <dd>
473
+ * <p>Unit: SECONDS</p>
474
+ * <p>Statistic: MAX</p>
475
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a>
476
+ * </p>
477
+ * </dd>
478
+ * <dt>SERVICE_LEVEL</dt>
479
+ * <dd>
480
+ * <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
481
+ * <p>Unit: PERCENT</p>
482
+ * <p>Statistic: AVG</p>
483
+ * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds.
484
+ * For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than"). </p>
485
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
486
+ * time</a>
487
+ * </p>
488
+ * </dd>
489
+ * </dl>
490
+ * @public
491
+ */
492
+ HistoricalMetrics: HistoricalMetric[] | undefined;
493
+ /**
494
+ * <p>The token for the next set of results. Use the value returned in the previous
495
+ * response in the next request to retrieve the next set of results.</p>
496
+ * @public
497
+ */
498
+ NextToken?: string | undefined;
499
+ /**
500
+ * <p>The maximum number of results to return per page.</p>
501
+ * @public
502
+ */
503
+ MaxResults?: number | undefined;
504
+ }
505
+ /**
506
+ * <p>Contains the data for a historical metric.</p>
507
+ * @public
508
+ */
509
+ export interface HistoricalMetricData {
510
+ /**
511
+ * <p>Information about the metric.</p>
512
+ * @public
513
+ */
514
+ Metric?: HistoricalMetric | undefined;
515
+ /**
516
+ * <p>The value of the metric.</p>
517
+ * @public
518
+ */
519
+ Value?: number | undefined;
520
+ }
521
+ /**
522
+ * <p>Contains information about the historical metrics retrieved.</p>
523
+ * @public
524
+ */
525
+ export interface HistoricalMetricResult {
526
+ /**
527
+ * <p>The dimension for the metrics.</p>
528
+ * @public
529
+ */
530
+ Dimensions?: Dimensions | undefined;
531
+ /**
532
+ * <p>The set of metrics.</p>
533
+ * @public
534
+ */
535
+ Collections?: HistoricalMetricData[] | undefined;
536
+ }
4
537
  /**
5
538
  * @public
6
539
  */
@@ -9113,104 +9646,3 @@ export interface ContactSearchSummaryAgentInfo {
9113
9646
  */
9114
9647
  ConnectedToAgentTimestamp?: Date | undefined;
9115
9648
  }
9116
- /**
9117
- * <p>Information of the AI agent involved in the contact.</p>
9118
- * @public
9119
- */
9120
- export interface ContactSearchSummaryAiAgentInfo {
9121
- /**
9122
- * <p>The unique identifier that specifies both the AI agent ID and its version number that was
9123
- * involved in the contact.</p>
9124
- * @public
9125
- */
9126
- AiAgentVersionId?: string | undefined;
9127
- /**
9128
- * <p>A boolean flag indicating whether the contact initially handled by this AI agent was
9129
- * escalated to a human agent.</p>
9130
- * @public
9131
- */
9132
- AiAgentEscalated?: boolean | undefined;
9133
- /**
9134
- * <p>The use case or scenario for which the AI agent is involved in the contact. Valid values
9135
- * are <code>AgentAssistance</code> and <code>SelfService</code>.</p>
9136
- * @public
9137
- */
9138
- AiUseCase?: AiUseCase | undefined;
9139
- }
9140
- /**
9141
- * <p>If this contact was queued, this contains information about the queue.</p>
9142
- * @public
9143
- */
9144
- export interface ContactSearchSummaryQueueInfo {
9145
- /**
9146
- * <p>The unique identifier for the queue.</p>
9147
- * @public
9148
- */
9149
- Id?: string | undefined;
9150
- /**
9151
- * <p>The timestamp when the contact was added to the queue.</p>
9152
- * @public
9153
- */
9154
- EnqueueTimestamp?: Date | undefined;
9155
- }
9156
- /**
9157
- * <p>A data table search filter.</p>
9158
- * @public
9159
- */
9160
- export interface DataTableSearchFilter {
9161
- /**
9162
- * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
9163
- * <code>OR</code> or <code>AND</code> (List of List) input where:</p>
9164
- * <ul>
9165
- * <li>
9166
- * <p>The top level list specifies conditions that need to be applied with <code>OR</code> operator.</p>
9167
- * </li>
9168
- * <li>
9169
- * <p>The inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
9170
- * </li>
9171
- * </ul>
9172
- * @public
9173
- */
9174
- AttributeFilter?: ControlPlaneAttributeFilter | undefined;
9175
- }
9176
- /**
9177
- * @public
9178
- */
9179
- export interface SearchDataTablesResponse {
9180
- /**
9181
- * <p>An array of data tables matching the search criteria with the same structure as DescribeTable except Version,
9182
- * VersionDescription, and LockVersion are omitted.</p>
9183
- * @public
9184
- */
9185
- DataTables?: DataTable[] | undefined;
9186
- /**
9187
- * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
9188
- * @public
9189
- */
9190
- NextToken?: string | undefined;
9191
- /**
9192
- * <p>The approximate number of data tables that matched the search criteria.</p>
9193
- * @public
9194
- */
9195
- ApproximateTotalCount?: number | undefined;
9196
- }
9197
- /**
9198
- * <p>Filters to be applied to search results.</p>
9199
- * @public
9200
- */
9201
- export interface EmailAddressSearchFilter {
9202
- /**
9203
- * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
9204
- * <code>OR</code> of <code>AND</code> (List of List) input where:</p>
9205
- * <ul>
9206
- * <li>
9207
- * <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
9208
- * </li>
9209
- * <li>
9210
- * <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
9211
- * </li>
9212
- * </ul>
9213
- * @public
9214
- */
9215
- TagFilter?: ControlPlaneTagFilter | undefined;
9216
- }