@aws-sdk/client-connect 3.1107.0 → 3.1109.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 (76) hide show
  1. package/README.md +49 -0
  2. package/dist-cjs/index.js +390 -46
  3. package/dist-es/Connect.js +18 -0
  4. package/dist-es/commands/CreateMetricCommand.js +4 -0
  5. package/dist-es/commands/DeleteMetricCommand.js +4 -0
  6. package/dist-es/commands/DescribeMetricCommand.js +4 -0
  7. package/dist-es/commands/ListMetricsCommand.js +4 -0
  8. package/dist-es/commands/SearchMetricsCommand.js +4 -0
  9. package/dist-es/commands/UpdateMetricContentCommand.js +4 -0
  10. package/dist-es/commands/UpdateMetricMetadataCommand.js +4 -0
  11. package/dist-es/commands/index.js +7 -0
  12. package/dist-es/models/enums.js +41 -0
  13. package/dist-es/pagination/ListMetricsPaginator.js +4 -0
  14. package/dist-es/pagination/SearchMetricsPaginator.js +4 -0
  15. package/dist-es/pagination/index.js +2 -0
  16. package/dist-es/schemas/schemas_0.js +268 -45
  17. package/dist-types/Connect.d.ts +63 -0
  18. package/dist-types/ConnectClient.d.ts +9 -2
  19. package/dist-types/commands/CreateMetricCommand.d.ts +137 -0
  20. package/dist-types/commands/CreateUserCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +1 -2
  22. package/dist-types/commands/DeleteMetricCommand.d.ts +93 -0
  23. package/dist-types/commands/DescribeMetricCommand.d.ts +165 -0
  24. package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -1
  25. package/dist-types/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
  26. package/dist-types/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
  27. package/dist-types/commands/GetFederationTokenCommand.d.ts +1 -1
  28. package/dist-types/commands/ListMetricsCommand.d.ts +103 -0
  29. package/dist-types/commands/SearchAgentStatusesCommand.d.ts +1 -1
  30. package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +1 -1
  31. package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -1
  32. package/dist-types/commands/SearchMetricsCommand.d.ts +223 -0
  33. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  34. package/dist-types/commands/UpdateMetricContentCommand.d.ts +121 -0
  35. package/dist-types/commands/UpdateMetricMetadataCommand.d.ts +93 -0
  36. package/dist-types/commands/index.d.ts +7 -0
  37. package/dist-types/models/enums.d.ts +113 -0
  38. package/dist-types/models/models_0.d.ts +185 -285
  39. package/dist-types/models/models_1.d.ts +526 -349
  40. package/dist-types/models/models_2.d.ts +394 -355
  41. package/dist-types/models/models_3.d.ts +469 -663
  42. package/dist-types/models/models_4.d.ts +715 -5
  43. package/dist-types/pagination/ListMetricsPaginator.d.ts +7 -0
  44. package/dist-types/pagination/SearchMetricsPaginator.d.ts +7 -0
  45. package/dist-types/pagination/index.d.ts +2 -0
  46. package/dist-types/schemas/schemas_0.d.ts +32 -0
  47. package/dist-types/ts3.4/Connect.d.ts +130 -0
  48. package/dist-types/ts3.4/ConnectClient.d.ts +39 -0
  49. package/dist-types/ts3.4/commands/CreateMetricCommand.d.ts +38 -0
  50. package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +4 -2
  52. package/dist-types/ts3.4/commands/DeleteMetricCommand.d.ts +38 -0
  53. package/dist-types/ts3.4/commands/DescribeMetricCommand.d.ts +38 -0
  54. package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +2 -1
  55. package/dist-types/ts3.4/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +38 -0
  59. package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/SearchMetricsCommand.d.ts +39 -0
  63. package/dist-types/ts3.4/commands/UpdateMetricContentCommand.d.ts +39 -0
  64. package/dist-types/ts3.4/commands/UpdateMetricMetadataCommand.d.ts +39 -0
  65. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  66. package/dist-types/ts3.4/models/enums.d.ts +53 -0
  67. package/dist-types/ts3.4/models/models_0.d.ts +49 -55
  68. package/dist-types/ts3.4/models/models_1.d.ts +108 -82
  69. package/dist-types/ts3.4/models/models_2.d.ts +99 -86
  70. package/dist-types/ts3.4/models/models_3.d.ts +121 -153
  71. package/dist-types/ts3.4/models/models_4.d.ts +174 -21
  72. package/dist-types/ts3.4/pagination/ListMetricsPaginator.d.ts +8 -0
  73. package/dist-types/ts3.4/pagination/SearchMetricsPaginator.d.ts +11 -0
  74. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  75. package/dist-types/ts3.4/schemas/schemas_0.d.ts +32 -0
  76. package/package.json +6 -6
@@ -1,6 +1,315 @@
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, FlowAssociationResourceType, 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, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
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, DataTableAttribute, Dimensions, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, Filters, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification } from "./models_1";
1
+ import type { AgentStatusType, ArtifactStatus, AttachmentScope, AutoEvaluationStatus, BooleanComparisonType, Channel, Comparison, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DateTimeComparisonType, DecimalComparisonType, DirectoryType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, EventSourceName, ExecutionRecordStatus, FilterV2StringConditionComparisonOperator, FlowAssociationResourceType, Grouping, HistoricalMetricName, InstanceStatus, InstanceStorageResourceType, IntegrationType, IntervalPeriod, LexVersion, ListFlowAssociationResourceType, LocaleCode, MediaType, MetricStatus, MetricType, MonitorCapability, NotificationPriority, NotificationSource, NotificationStatus, NumberComparisonType, OperationalStatus, ParticipantRole, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, QueueType, QuickConnectType, RealTimeContactAnalysisOutputType, RealTimeContactAnalysisPostContactSummaryFailureCode, RealTimeContactAnalysisPostContactSummaryStatus, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisSentimentLabel, RealTimeContactAnalysisStatus, RealTimeContactAnalysisSupportedChannel, ReferenceStatus, ReferenceType, RuleCapabilityTier, RulePublishStatus, SourceType, Statistic, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, ViewStatus, ViewType, VocabularyLanguageCode } from "./enums";
2
+ import type { ActionSummary, AgentConfig, AgentStatus, AgentStatusSummary, AnalyticsDataAssociationResult, Application, ControlPlaneAttributeFilter, DataTableLockVersion, Distribution, FlowAssociationSummary, FlowModule, InstanceStorageConfig, LexBot, LexV2Bot, OverrideTimeSlice, PrimaryValueResponse, SecurityProfileItem, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, UserProficiency } from "./models_0";
3
+ import type { Attribute, ContactFlow, ContactFlowModule, DataTableAttribute, Dimensions, EvaluationContactParticipant, EvaluationScore, ExtensionConfiguration, Filters, HierarchyGroupSummary, HoursOfOperationOverride, HoursOfOperationsIdentifier, Notification, UserData } from "./models_1";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface GetCurrentUserDataResponse {
8
+ /**
9
+ * <p>If there are additional results, this is the token for the next set of results.</p>
10
+ * @public
11
+ */
12
+ NextToken?: string | undefined;
13
+ /**
14
+ * <p>A list of the user data that is returned.</p>
15
+ * @public
16
+ */
17
+ UserDataList?: UserData[] | undefined;
18
+ /**
19
+ * <p>The total count of the result, regardless of the current page size.</p>
20
+ * @public
21
+ */
22
+ ApproximateTotalCount?: number | undefined;
23
+ }
24
+ /**
25
+ * @public
26
+ */
27
+ export interface GetEffectiveHoursOfOperationsRequest {
28
+ /**
29
+ * <p>The identifier of the Connect Customer instance.</p>
30
+ * @public
31
+ */
32
+ InstanceId: string | undefined;
33
+ /**
34
+ * <p>The identifier for the hours of operation.</p>
35
+ * @public
36
+ */
37
+ HoursOfOperationId: string | undefined;
38
+ /**
39
+ * <p>The date from when the hours of operation are listed.</p>
40
+ * @public
41
+ */
42
+ FromDate: string | undefined;
43
+ /**
44
+ * <p>The date until when the hours of operation are listed.</p>
45
+ * @public
46
+ */
47
+ ToDate: string | undefined;
48
+ }
49
+ /**
50
+ * <p>Information about the hours of operations with the effective override applied.</p>
51
+ * @public
52
+ */
53
+ export interface OperationalHour {
54
+ /**
55
+ * <p>The start time that your contact center opens.</p>
56
+ * @public
57
+ */
58
+ Start?: OverrideTimeSlice | undefined;
59
+ /**
60
+ * <p>The end time that your contact center closes.</p>
61
+ * @public
62
+ */
63
+ End?: OverrideTimeSlice | undefined;
64
+ }
65
+ /**
66
+ * <p>Information about the hours of operations with the effective override applied.</p>
67
+ * @public
68
+ */
69
+ export interface EffectiveHoursOfOperations {
70
+ /**
71
+ * <p>The date that the hours of operation or overrides applies to.</p>
72
+ * @public
73
+ */
74
+ Date?: string | undefined;
75
+ /**
76
+ * <p>Information about the hours of operations with the effective override applied.</p>
77
+ * @public
78
+ */
79
+ OperationalHours?: OperationalHour[] | undefined;
80
+ }
81
+ /**
82
+ * <p>Information about hours of operation override</p>
83
+ * @public
84
+ */
85
+ export interface OverrideHour {
86
+ /**
87
+ * <p>The start time or end time for an hours of operation override.</p>
88
+ * @public
89
+ */
90
+ Start?: OverrideTimeSlice | undefined;
91
+ /**
92
+ * <p>The start time or end time for an hours of operation override.</p>
93
+ * @public
94
+ */
95
+ End?: OverrideTimeSlice | undefined;
96
+ /**
97
+ * <p>Unique identifier name for the override.</p>
98
+ * @public
99
+ */
100
+ OverrideName?: string | undefined;
101
+ /**
102
+ * <p>Indicates whether the status is open or closed during the override period. This status determines how the override modifies the base hours of operation schedule.</p>
103
+ * @public
104
+ */
105
+ OperationalStatus?: OperationalStatus | undefined;
106
+ }
107
+ /**
108
+ * <p>Information about the hours of operation overrides which contribute to effective hours of operations.</p>
109
+ * @public
110
+ */
111
+ export interface EffectiveOverrideHours {
112
+ /**
113
+ * <p>The date that the hours of operation override applies to.</p>
114
+ * @public
115
+ */
116
+ Date?: string | undefined;
117
+ /**
118
+ * <p>Information about the hours of operation overrides that apply to a specific date.</p>
119
+ * @public
120
+ */
121
+ OverrideHours?: OverrideHour[] | undefined;
122
+ }
123
+ /**
124
+ * @public
125
+ */
126
+ export interface GetEffectiveHoursOfOperationsResponse {
127
+ /**
128
+ * <p>Information about the effective hours of operations.</p>
129
+ * @public
130
+ */
131
+ EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined;
132
+ /**
133
+ * <p>Information about override configurations applied to the base hours of operation to calculate the effective hours.</p>
134
+ * <p>For more information about how override types are applied, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html">Build your list of overrides</a> in the
135
+ * <i> Administrator Guide</i>.</p>
136
+ * @public
137
+ */
138
+ EffectiveOverrideHoursList?: EffectiveOverrideHours[] | undefined;
139
+ /**
140
+ * <p>The time zone for the hours of operation.</p>
141
+ * @public
142
+ */
143
+ TimeZone?: string | undefined;
144
+ }
145
+ /**
146
+ * @public
147
+ */
148
+ export interface GetEvaluationFormValidationRequest {
149
+ /**
150
+ * <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>
151
+ * @public
152
+ */
153
+ InstanceId: string | undefined;
154
+ /**
155
+ * <p>The unique identifier for the evaluation form.</p>
156
+ * @public
157
+ */
158
+ EvaluationFormId: string | undefined;
159
+ /**
160
+ * <p>The version of the evaluation form to retrieve validation results for.</p>
161
+ * @public
162
+ */
163
+ EvaluationFormVersion?: number | undefined;
164
+ }
165
+ /**
166
+ * <p>Information about an evaluation form item affected by a validation finding.</p>
167
+ * @public
168
+ */
169
+ export interface EvaluationFormValidationFindingItem {
170
+ /**
171
+ * <p>The identifier of the evaluation form item (question or section) affected by the finding.</p>
172
+ * @public
173
+ */
174
+ RefId?: string | undefined;
175
+ /**
176
+ * <p>The specific property of the evaluation form item that the finding relates to.</p>
177
+ * @public
178
+ */
179
+ Property?: string | undefined;
180
+ }
181
+ /**
182
+ * <p>Information about a finding from the evaluation form validation process. Each finding identifies a structural
183
+ * issue or quality improvement opportunity for the evaluation form.</p>
184
+ * @public
185
+ */
186
+ export interface EvaluationFormValidationFinding {
187
+ /**
188
+ * <p>A code that identifies the type of validation issue found.</p>
189
+ * @public
190
+ */
191
+ IssueCode: string | undefined;
192
+ /**
193
+ * <p>A list of evaluation form items affected by this finding.</p>
194
+ * @public
195
+ */
196
+ Items?: EvaluationFormValidationFindingItem[] | undefined;
197
+ /**
198
+ * <p>A description of the validation issue.</p>
199
+ * @public
200
+ */
201
+ Description: string | undefined;
202
+ /**
203
+ * <p>A suggested fix for the validation issue.</p>
204
+ * @public
205
+ */
206
+ Suggestion?: string | undefined;
207
+ /**
208
+ * <p>The severity of the finding. Valid values: <code>WARNING</code>, <code>ERROR</code>.</p>
209
+ * @public
210
+ */
211
+ Severity: EvaluationFormValidationFindingSeverity | undefined;
212
+ }
213
+ /**
214
+ * @public
215
+ */
216
+ export interface GetEvaluationFormValidationResponse {
217
+ /**
218
+ * <p>The current status of the validation process. Valid values: <code>IN_PROGRESS</code>,
219
+ * <code>COMPLETED</code>, <code>FAILED</code>.</p>
220
+ * @public
221
+ */
222
+ Status: EvaluationFormValidationStatus | undefined;
223
+ /**
224
+ * <p>The reason the validation failed. This field is populated only when the status is
225
+ * <code>FAILED</code>.</p>
226
+ * @public
227
+ */
228
+ FailureReason?: string | undefined;
229
+ /**
230
+ * <p>The unique identifier for the evaluation form.</p>
231
+ * @public
232
+ */
233
+ EvaluationFormId: string | undefined;
234
+ /**
235
+ * <p>A version of the evaluation form.</p>
236
+ * @public
237
+ */
238
+ EvaluationFormVersion: number | undefined;
239
+ /**
240
+ * <p>The timestamp when the validation process was started.</p>
241
+ * @public
242
+ */
243
+ StartedTime: Date | undefined;
244
+ /**
245
+ * <p>A list of findings from the validation process. Each finding identifies a structural issue or quality
246
+ * improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is
247
+ * <code>COMPLETED</code>.</p>
248
+ * @public
249
+ */
250
+ Findings?: EvaluationFormValidationFinding[] | undefined;
251
+ }
252
+ /**
253
+ * @public
254
+ */
255
+ export interface GetFederationTokenRequest {
256
+ /**
257
+ * <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>
258
+ * @public
259
+ */
260
+ InstanceId: string | undefined;
261
+ }
262
+ /**
263
+ * <p>Contains credentials to use for federation.</p>
264
+ * @public
265
+ */
266
+ export interface Credentials {
267
+ /**
268
+ * <p>An access token generated for a federated user to access Connect Customer.</p>
269
+ * @public
270
+ */
271
+ AccessToken?: string | undefined;
272
+ /**
273
+ * <p>A token generated with an expiration time for the session a user is logged in to Connect Customer.</p>
274
+ * @public
275
+ */
276
+ AccessTokenExpiration?: Date | undefined;
277
+ /**
278
+ * <p>Renews a token generated for a user to access the Connect Customer instance.</p>
279
+ * @public
280
+ */
281
+ RefreshToken?: string | undefined;
282
+ /**
283
+ * <p>Renews the expiration timer for a generated token.</p>
284
+ * @public
285
+ */
286
+ RefreshTokenExpiration?: Date | undefined;
287
+ }
288
+ /**
289
+ * @public
290
+ */
291
+ export interface GetFederationTokenResponse {
292
+ /**
293
+ * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
294
+ * @public
295
+ */
296
+ UserId?: string | undefined;
297
+ /**
298
+ * <p>The Amazon Resource Name (ARN) of the user.</p>
299
+ * @public
300
+ */
301
+ UserArn?: string | undefined;
302
+ /**
303
+ * <p>The credentials to use for federation.</p>
304
+ * @public
305
+ */
306
+ Credentials?: Credentials | undefined;
307
+ /**
308
+ * <p>The URL to sign into the user's instance. </p>
309
+ * @public
310
+ */
311
+ SignInUrl?: string | undefined;
312
+ }
4
313
  /**
5
314
  * @public
6
315
  */
@@ -5473,6 +5782,88 @@ export interface ListLexBotsResponse {
5473
5782
  */
5474
5783
  NextToken?: string | undefined;
5475
5784
  }
5785
+ /**
5786
+ * @public
5787
+ */
5788
+ export interface ListMetricsRequest {
5789
+ /**
5790
+ * <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>
5791
+ * @public
5792
+ */
5793
+ InstanceId: string | undefined;
5794
+ /**
5795
+ * <p>The type of metrics to list. Valid values: <code>AWS_MANAGED</code> | <code>CUSTOMER_MANAGED</code>.</p>
5796
+ * @public
5797
+ */
5798
+ Type?: MetricType | undefined;
5799
+ /**
5800
+ * <p>The maximum number of results to return per page.</p>
5801
+ * @public
5802
+ */
5803
+ MaxResults?: number | undefined;
5804
+ /**
5805
+ * <p>The token for the next set of results. Use the value returned in the previous
5806
+ * response in the next request to retrieve the next set of results.</p>
5807
+ * @public
5808
+ */
5809
+ NextToken?: string | undefined;
5810
+ }
5811
+ /**
5812
+ * <p>Contains summary information about a metric.</p>
5813
+ * @public
5814
+ */
5815
+ export interface MetricSummary {
5816
+ /**
5817
+ * <p>The Amazon Resource Name (ARN) of the metric.</p>
5818
+ * @public
5819
+ */
5820
+ Arn: string | undefined;
5821
+ /**
5822
+ * <p>The identifier of the metric.</p>
5823
+ * @public
5824
+ */
5825
+ Id: string | undefined;
5826
+ /**
5827
+ * <p>The name of the metric.</p>
5828
+ * @public
5829
+ */
5830
+ Name: string | undefined;
5831
+ /**
5832
+ * <p>The publish status of the metric.</p>
5833
+ * @public
5834
+ */
5835
+ Status: MetricStatus | undefined;
5836
+ /**
5837
+ * <p>The type of the metric.</p>
5838
+ * @public
5839
+ */
5840
+ Type: MetricType | undefined;
5841
+ /**
5842
+ * <p>The region where the metric was last modified.</p>
5843
+ * @public
5844
+ */
5845
+ LastModifiedRegion?: string | undefined;
5846
+ /**
5847
+ * <p>The timestamp of when the metric was last modified.</p>
5848
+ * @public
5849
+ */
5850
+ LastModifiedTime?: Date | undefined;
5851
+ }
5852
+ /**
5853
+ * @public
5854
+ */
5855
+ export interface ListMetricsResponse {
5856
+ /**
5857
+ * <p>The list of metric summaries.</p>
5858
+ * @public
5859
+ */
5860
+ MetricSummaryList: MetricSummary[] | undefined;
5861
+ /**
5862
+ * <p>If there are additional results, this is the token for the next set of results.</p>
5863
+ * @public
5864
+ */
5865
+ NextToken?: string | undefined;
5866
+ }
5476
5867
  /**
5477
5868
  * @public
5478
5869
  */
@@ -9308,355 +9699,3 @@ export interface SearchContactFlowsResponse {
9308
9699
  */
9309
9700
  ApproximateTotalCount?: number | undefined;
9310
9701
  }
9311
- /**
9312
- * <p>A structure of time range that you want to search results.</p>
9313
- * @public
9314
- */
9315
- export interface SearchContactsTimeRange {
9316
- /**
9317
- * <p>The type of timestamp to search.</p>
9318
- * @public
9319
- */
9320
- Type: SearchContactsTimeRangeType | undefined;
9321
- /**
9322
- * <p>The start time of the time range.</p>
9323
- * @public
9324
- */
9325
- StartTime: Date | undefined;
9326
- /**
9327
- * <p>The end time of the time range.</p>
9328
- * @public
9329
- */
9330
- EndTime: Date | undefined;
9331
- }
9332
- /**
9333
- * <p>The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is
9334
- * not an actual timestamp value. </p>
9335
- * @public
9336
- */
9337
- export interface SearchContactsTimestampCondition {
9338
- /**
9339
- * <p>Type of the timestamps to use for the filter.</p>
9340
- * @public
9341
- */
9342
- Type: SearchContactsTimeRangeType | undefined;
9343
- /**
9344
- * <p>Condition of the timestamp on the contact.</p>
9345
- * @public
9346
- */
9347
- ConditionType: SearchContactsTimeRangeConditionType | undefined;
9348
- }
9349
- /**
9350
- * <p>The criteria of the time range to additionally filter on.</p>
9351
- * @public
9352
- */
9353
- export interface SearchContactsAdditionalTimeRangeCriteria {
9354
- /**
9355
- * <p>A structure of time range that you want to search results.</p>
9356
- * @public
9357
- */
9358
- TimeRange?: SearchContactsTimeRange | undefined;
9359
- /**
9360
- * <p>List of the timestamp conditions.</p>
9361
- * @public
9362
- */
9363
- TimestampCondition?: SearchContactsTimestampCondition | undefined;
9364
- }
9365
- /**
9366
- * <p>Time range that you <b>additionally</b> want to filter on.</p>
9367
- * <note>
9368
- * <p>This is different from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchContactsTimeRange.html">SearchContactsTimeRange</a> data
9369
- * type.</p>
9370
- * </note>
9371
- * @public
9372
- */
9373
- export interface SearchContactsAdditionalTimeRange {
9374
- /**
9375
- * <p>List of criteria of the time range to additionally filter on.</p>
9376
- * @public
9377
- */
9378
- Criteria: SearchContactsAdditionalTimeRangeCriteria[] | undefined;
9379
- /**
9380
- * <p>The match type combining multiple time range filters.</p>
9381
- * @public
9382
- */
9383
- MatchType: SearchContactsMatchType | undefined;
9384
- }
9385
- /**
9386
- * <p>A structure that defines search criteria base on words or phrases, participants in the Contact Lens
9387
- * conversational analytics transcript.</p>
9388
- * @public
9389
- */
9390
- export interface TranscriptCriteria {
9391
- /**
9392
- * <p>The participant role in a transcript</p>
9393
- * @public
9394
- */
9395
- ParticipantRole: ParticipantRole | undefined;
9396
- /**
9397
- * <p>The words or phrases used to search within a transcript.</p>
9398
- * @public
9399
- */
9400
- SearchText: string[] | undefined;
9401
- /**
9402
- * <p>The match type combining search criteria using multiple search texts in a transcript criteria.</p>
9403
- * @public
9404
- */
9405
- MatchType: SearchContactsMatchType | undefined;
9406
- }
9407
- /**
9408
- * <p>A structure that defines search criteria and matching logic to search for contacts by matching text with
9409
- * transcripts analyzed by Connect Customer Contact Lens.</p>
9410
- * @public
9411
- */
9412
- export interface Transcript {
9413
- /**
9414
- * <p>The list of search criteria based on Contact Lens conversational analytics transcript.</p>
9415
- * @public
9416
- */
9417
- Criteria: TranscriptCriteria[] | undefined;
9418
- /**
9419
- * <p>The match type combining search criteria using multiple transcript criteria.</p>
9420
- * @public
9421
- */
9422
- MatchType?: SearchContactsMatchType | undefined;
9423
- }
9424
- /**
9425
- * <p>A structure that defines search criteria for contacts using analysis outputs from Connect Customer Contact
9426
- * Lens.</p>
9427
- * @public
9428
- */
9429
- export interface ContactAnalysis {
9430
- /**
9431
- * <p>Search criteria based on transcript analyzed by Connect Customer Contact Lens.</p>
9432
- * @public
9433
- */
9434
- Transcript?: Transcript | undefined;
9435
- }
9436
- /**
9437
- * <p>The search criteria based on the contact name</p>
9438
- * @public
9439
- */
9440
- export interface NameCriteria {
9441
- /**
9442
- * <p>The words or phrases used to match the contact name.</p>
9443
- * @public
9444
- */
9445
- SearchText: string[] | undefined;
9446
- /**
9447
- * <p>The match type combining name search criteria using multiple search texts in a name criteria.</p>
9448
- * @public
9449
- */
9450
- MatchType: SearchContactsMatchType | undefined;
9451
- }
9452
- /**
9453
- * <p>The agent criteria to search for preferred agents on the routing criteria.</p>
9454
- * @public
9455
- */
9456
- export interface SearchableAgentCriteriaStep {
9457
- /**
9458
- * <p>The identifiers of agents used in preferred agents matching.</p>
9459
- * @public
9460
- */
9461
- AgentIds?: string[] | undefined;
9462
- /**
9463
- * <p>The match type combining multiple agent criteria steps.</p>
9464
- * @public
9465
- */
9466
- MatchType?: SearchContactsMatchType | undefined;
9467
- }
9468
- /**
9469
- * <p>Routing criteria of the contact to match on.</p>
9470
- * @public
9471
- */
9472
- export interface SearchableRoutingCriteriaStep {
9473
- /**
9474
- * <p>Agent matching the routing step of the routing criteria</p>
9475
- * @public
9476
- */
9477
- AgentCriteria?: SearchableAgentCriteriaStep | undefined;
9478
- }
9479
- /**
9480
- * <p>Routing criteria of the contact to match on.</p>
9481
- * @public
9482
- */
9483
- export interface SearchableRoutingCriteria {
9484
- /**
9485
- * <p>The list of Routing criteria steps of the contact routing.</p>
9486
- * @public
9487
- */
9488
- Steps?: SearchableRoutingCriteriaStep[] | undefined;
9489
- }
9490
- /**
9491
- * <p>The search criteria based on user-defined contact attribute key and values to search on.</p>
9492
- * @public
9493
- */
9494
- export interface SearchableContactAttributesCriteria {
9495
- /**
9496
- * <p>The key containing a searchable user-defined contact attribute.</p>
9497
- * @public
9498
- */
9499
- Key: string | undefined;
9500
- /**
9501
- * <p>The list of values to search for within a user-defined contact attribute.</p>
9502
- * @public
9503
- */
9504
- Values: string[] | undefined;
9505
- }
9506
- /**
9507
- * <p>A structure that defines search criteria based on user-defined contact attributes that are configured for
9508
- * contact search.</p>
9509
- * @public
9510
- */
9511
- export interface SearchableContactAttributes {
9512
- /**
9513
- * <p>The list of criteria based on user-defined contact attributes that are configured for contact search.</p>
9514
- * @public
9515
- */
9516
- Criteria: SearchableContactAttributesCriteria[] | undefined;
9517
- /**
9518
- * <p>The match type combining search criteria using multiple searchable contact attributes.</p>
9519
- * @public
9520
- */
9521
- MatchType?: SearchContactsMatchType | undefined;
9522
- }
9523
- /**
9524
- * <p>The search criteria based on searchable segment attribute key and values to search on.</p>
9525
- * @public
9526
- */
9527
- export interface SearchableSegmentAttributesCriteria {
9528
- /**
9529
- * <p>The key containing a searchable segment attribute.</p>
9530
- * @public
9531
- */
9532
- Key: string | undefined;
9533
- /**
9534
- * <p>The list of values to search for within a searchable segment attribute.</p>
9535
- * @public
9536
- */
9537
- Values: string[] | undefined;
9538
- }
9539
- /**
9540
- * <p>The search criteria based on searchable segment attributes of a contact</p>
9541
- * @public
9542
- */
9543
- export interface SearchableSegmentAttributes {
9544
- /**
9545
- * <p>The list of criteria based on searchable segment attributes.</p>
9546
- * @public
9547
- */
9548
- Criteria: SearchableSegmentAttributesCriteria[] | undefined;
9549
- /**
9550
- * <p>The match type combining search criteria using multiple searchable segment attributes.</p>
9551
- * @public
9552
- */
9553
- MatchType?: SearchContactsMatchType | undefined;
9554
- }
9555
- /**
9556
- * <p>A structure of search criteria to be used to return contacts.</p>
9557
- * @public
9558
- */
9559
- export interface SearchCriteria {
9560
- /**
9561
- * <p>Name of the contact.</p>
9562
- * @public
9563
- */
9564
- Name?: NameCriteria | undefined;
9565
- /**
9566
- * <p>The identifiers of agents who handled the contacts.</p>
9567
- * @public
9568
- */
9569
- AgentIds?: string[] | undefined;
9570
- /**
9571
- * <p>The agent hierarchy groups of the agent at the time of handling the contact.</p>
9572
- * @public
9573
- */
9574
- AgentHierarchyGroups?: AgentHierarchyGroups | undefined;
9575
- /**
9576
- * <p>The list of channels associated with contacts.</p>
9577
- * @public
9578
- */
9579
- Channels?: Channel[] | undefined;
9580
- /**
9581
- * <p>Search criteria based on analysis outputs from Connect Customer Contact Lens.</p>
9582
- * @public
9583
- */
9584
- ContactAnalysis?: ContactAnalysis | undefined;
9585
- /**
9586
- * <p>The list of initiation methods associated with contacts.</p>
9587
- * @public
9588
- */
9589
- InitiationMethods?: ContactInitiationMethod[] | undefined;
9590
- /**
9591
- * <p>The list of queue IDs associated with contacts.</p>
9592
- * @public
9593
- */
9594
- QueueIds?: string[] | undefined;
9595
- /**
9596
- * <p>Routing criteria for the contact.</p>
9597
- * @public
9598
- */
9599
- RoutingCriteria?: SearchableRoutingCriteria | undefined;
9600
- /**
9601
- * <p>Additional TimeRange used to filter contacts.</p>
9602
- * @public
9603
- */
9604
- AdditionalTimeRange?: SearchContactsAdditionalTimeRange | undefined;
9605
- /**
9606
- * <p>The search criteria based on user-defined contact attributes that have been configured for contact search. For
9607
- * more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html">Search by custom contact attributes</a> in the <i>Connect Customer Administrator
9608
- * Guide</i>.</p>
9609
- * <important>
9610
- * <p>To use <code>SearchableContactAttributes</code> in a search request, the <code>GetContactAttributes</code>
9611
- * action is required to perform an API request. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions">https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions</a>Actions
9612
- * defined by Connect Customer.</p>
9613
- * </important>
9614
- * @public
9615
- */
9616
- SearchableContactAttributes?: SearchableContactAttributes | undefined;
9617
- /**
9618
- * <p>The search criteria based on searchable segment attributes of a contact.</p>
9619
- * @public
9620
- */
9621
- SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined;
9622
- /**
9623
- * <p>The list of active regions for contacts in ACGR instances.</p>
9624
- * @public
9625
- */
9626
- ActiveRegions?: string[] | undefined;
9627
- /**
9628
- * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
9629
- * <code>OR</code> of <code>AND</code> (List of List) input where:</p>
9630
- * <ul>
9631
- * <li>
9632
- * <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
9633
- * </li>
9634
- * <li>
9635
- * <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
9636
- * </li>
9637
- * </ul>
9638
- * @public
9639
- */
9640
- ContactTags?: ControlPlaneTagFilter | undefined;
9641
- /**
9642
- * <p>AI Agent search criteria definitions.</p>
9643
- * @public
9644
- */
9645
- AiAgents?: AiAgentsCriteria | undefined;
9646
- }
9647
- /**
9648
- * <p>A structure that defines the field name to sort by and a sort order.</p>
9649
- * @public
9650
- */
9651
- export interface Sort {
9652
- /**
9653
- * <p>The name of the field on which to sort.</p>
9654
- * @public
9655
- */
9656
- FieldName: SortableFieldName | undefined;
9657
- /**
9658
- * <p>An ascending or descending sort.</p>
9659
- * @public
9660
- */
9661
- Order: SortOrder | undefined;
9662
- }