@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,5 +1,289 @@
1
- import type { AgentAvailabilityTimer, AttachmentScope, AutoEvaluationStatus, Channel, ContactField, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactMetricName, ContactParticipantRole, ContactState, CurrentMetricName, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DirectoryType, EndpointType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationQuestionAnswerAnalysisType, EvaluationStatus, EvaluationSuggestedAnswerStatus, EvaluationTranscriptType, EvaluationType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, Grouping, InstanceAttributeType, InstanceReplicationStatus, InstanceStatus, InstanceStorageResourceType, LocaleCode, MediaStreamType, MediaType, NextContactType, NotificationPriority, OperationalStatus, OverrideType, ParticipantType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, PhoneNumberWorkflowStatus, QuestionRuleCategoryAutomationCondition, QueueStatus, QuickConnectType, RecordingStatus, RuleCapabilityTier, RulePublishStatus, SortOrder, Status, StorageType, TestCaseStatus, TrafficDistributionGroupStatus, Unit, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, WorkspaceFontFamily } from "./enums";
2
- import type { AfterContactWorkConfigPerChannel, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AiAgentInfo, AliasConfiguration, AllowedExtension, AudioQualityMetricsInfo, AutoAcceptConfig, CreatedByInfo, DataTableLockVersion, DeviceInfo, ExternalInvocationConfiguration, FailedBatchAssociationSummary, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, LexBot, LexV2Bot, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttributeValues, PrimaryValue, QueueReference, QuickConnectConfig, RecurrenceConfig, RoutingProfileQueueReference, RuleAction, RuleTriggerEventSource, SecurityProfileItem, SuccessfulBatchAssociationSummary, TestCaseEntryPoint, UserIdentityInfo, UserPhoneConfig, Validation, VoiceEnhancementConfig } from "./models_0";
1
+ import type { AgentAvailabilityTimer, AttachmentScope, AutoEvaluationStatus, AvailableFilterType, Channel, ContactField, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactMetricName, ContactParticipantRole, ContactState, CurrentMetricName, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DirectoryType, EndpointType, EntityType, EvaluationQuestionAnswerAnalysisType, EvaluationStatus, EvaluationSuggestedAnswerStatus, EvaluationTranscriptType, EvaluationType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, Grouping, InstanceAttributeType, InstanceReplicationStatus, InstanceStatus, InstanceStorageResourceType, LocaleCode, MediaStreamType, MediaType, MetricCreationMethod, MetricStatus, MetricType, MetricUnit, NextContactType, NotificationPriority, OverrideType, ParticipantType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, PhoneNumberWorkflowStatus, PhoneType, QuestionRuleCategoryAutomationCondition, QueueStatus, QuickConnectType, RecordingStatus, RuleCapabilityTier, RulePublishStatus, SortOrder, Status, StorageType, TestCaseStatus, TrafficDistributionGroupStatus, TrendIndicator, Unit, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, VoiceEnhancementMode, WorkspaceFontFamily } from "./enums";
2
+ import type { AfterContactWorkConfigPerChannel, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AiAgentInfo, AliasConfiguration, AllowedExtension, AudioQualityMetricsInfo, AutoAcceptConfig, CreatedByInfo, DataTableLockVersion, DeviceInfo, ExternalInvocationConfiguration, FailedBatchAssociationSummary, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, LexBot, LexV2Bot, MediaConcurrency, MetricCalculation, OutboundCallerConfig, OutboundEmailConfig, ParticipantCapabilities, PredefinedAttributeValues, PrimaryValue, QueueReference, QuickConnectConfig, RecurrenceConfig, RoutingProfileQueueReference, RuleAction, RuleTriggerEventSource, SecurityProfileItem, SuccessfulBatchAssociationSummary, TestCaseEntryPoint, Validation } from "./models_0";
3
+ /**
4
+ * <p>Contains information about the identity of a user.</p>
5
+ * <note>
6
+ * <p>For Connect Customer instances that are created with the <code>EXISTING_DIRECTORY</code> identity management
7
+ * type, <code>FirstName</code>, <code>LastName</code>, and <code>Email</code> cannot be updated from within Connect Customer because they are managed by the directory.</p>
8
+ * </note>
9
+ * <important>
10
+ * <p>The <code>FirstName</code> and <code>LastName</code> length constraints below apply only to instances using
11
+ * SAML for identity management. If you are using Connect Customer for identity management, the length constraints
12
+ * are 1-255 for <code>FirstName</code>, and 1-256 for <code>LastName</code>. </p>
13
+ * </important>
14
+ * @public
15
+ */
16
+ export interface UserIdentityInfo {
17
+ /**
18
+ * <p>The first name. This is required if you are using Connect Customer or SAML for identity management. Inputs
19
+ * must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed
20
+ * characters or combining marks) are not accepted.</p>
21
+ * @public
22
+ */
23
+ FirstName?: string | undefined;
24
+ /**
25
+ * <p>The last name. This is required if you are using Connect Customer or SAML for identity management. Inputs must
26
+ * be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed
27
+ * characters or combining marks) are not accepted.</p>
28
+ * @public
29
+ */
30
+ LastName?: string | undefined;
31
+ /**
32
+ * <p>The email address. If you are using SAML for identity management and include this parameter, an error is
33
+ * returned.</p>
34
+ * @public
35
+ */
36
+ Email?: string | undefined;
37
+ /**
38
+ * <p>The user's secondary email address. If you provide a secondary email, the user receives email notifications -
39
+ * other than password reset notifications - to this email address instead of to their primary email address.</p>
40
+ * <p>Pattern: <code>(?=^.\{0,265\}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]\{2,63\}</code>
41
+ * </p>
42
+ * @public
43
+ */
44
+ SecondaryEmail?: string | undefined;
45
+ /**
46
+ * <p>The user's mobile number.</p>
47
+ * @public
48
+ */
49
+ Mobile?: string | undefined;
50
+ }
51
+ /**
52
+ * <p>Configuration settings for persistent connection for a specific channel.</p>
53
+ * @public
54
+ */
55
+ export interface PersistentConnectionConfig {
56
+ /**
57
+ * <p>Configuration settings for persistent connection. <b>Only <code>VOICE</code> is supported for this data type.</b>
58
+ * </p>
59
+ * @public
60
+ */
61
+ Channel: Channel | undefined;
62
+ /**
63
+ * <p>Indicates whether persistent connection is enabled. When enabled, the agent's connection is maintained after a call ends, enabling subsequent calls to connect faster.</p>
64
+ * @public
65
+ */
66
+ PersistentConnection: boolean | undefined;
67
+ }
68
+ /**
69
+ * <p>Contains information about the phone configuration settings for a user.</p>
70
+ * @public
71
+ */
72
+ export interface UserPhoneConfig {
73
+ /**
74
+ * <p>The phone type.</p>
75
+ * @public
76
+ */
77
+ PhoneType?: PhoneType | undefined;
78
+ /**
79
+ * <p>The Auto accept setting.</p>
80
+ * @public
81
+ */
82
+ AutoAccept?: boolean | undefined;
83
+ /**
84
+ * <p>The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum
85
+ * value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a specific amount of ACW time. It
86
+ * essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close
87
+ * contact to end ACW. </p>
88
+ * <note>
89
+ * <p>When returned by a <code>SearchUsers</code> call, <code>AfterContactWorkTimeLimit</code> is returned in
90
+ * milliseconds. </p>
91
+ * </note>
92
+ * @public
93
+ */
94
+ AfterContactWorkTimeLimit?: number | undefined;
95
+ /**
96
+ * <p>The phone number for the user's desk phone.</p>
97
+ * @public
98
+ */
99
+ DeskPhoneNumber?: string | undefined;
100
+ /**
101
+ * <p>The persistent connection setting for the user.</p>
102
+ * @public
103
+ */
104
+ PersistentConnection?: boolean | undefined;
105
+ }
106
+ /**
107
+ * <p>Configuration settings for phone type and phone number.</p>
108
+ * @public
109
+ */
110
+ export interface PhoneNumberConfig {
111
+ /**
112
+ * <p>The channel for this phone number configuration. <b>Only <code>VOICE</code> is supported for this data type.</b>
113
+ * </p>
114
+ * @public
115
+ */
116
+ Channel: Channel | undefined;
117
+ /**
118
+ * <p>The phone type. Valid values: SOFT_PHONE, DESK_PHONE.</p>
119
+ * @public
120
+ */
121
+ PhoneType: PhoneType | undefined;
122
+ /**
123
+ * <p>The phone number for the user's desk phone.</p>
124
+ * @public
125
+ */
126
+ PhoneNumber?: string | undefined;
127
+ }
128
+ /**
129
+ * <p>Configuration settings for voice enhancement.</p>
130
+ * @public
131
+ */
132
+ export interface VoiceEnhancementConfig {
133
+ /**
134
+ * <p>The channel for this voice enhancement configuration. <b>Only <code>VOICE</code> is supported for this data type.</b>
135
+ * </p>
136
+ * @public
137
+ */
138
+ Channel: Channel | undefined;
139
+ /**
140
+ * <p>The voice enhancement mode.</p>
141
+ * @public
142
+ */
143
+ VoiceEnhancementMode: VoiceEnhancementMode | undefined;
144
+ }
145
+ /**
146
+ * @public
147
+ */
148
+ export interface CreateUserRequest {
149
+ /**
150
+ * <p>The user name for the account. For instances not using SAML for identity management, the user name can include
151
+ * up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters
152
+ * from [a-zA-Z0-9_-.\@]+.</p>
153
+ * <p>Username can include @ only if used in an email format. For example:</p>
154
+ * <ul>
155
+ * <li>
156
+ * <p>Correct: testuser</p>
157
+ * </li>
158
+ * <li>
159
+ * <p>Correct: testuser@example.com</p>
160
+ * </li>
161
+ * <li>
162
+ * <p>Incorrect: testuser@example</p>
163
+ * </li>
164
+ * </ul>
165
+ * @public
166
+ */
167
+ Username: string | undefined;
168
+ /**
169
+ * <p>The password for the user account. A password is required if you are using Connect Customer for identity
170
+ * management. Otherwise, it is an error to include a password.</p>
171
+ * @public
172
+ */
173
+ Password?: string | undefined;
174
+ /**
175
+ * <p>The information about the identity of the user.</p>
176
+ * @public
177
+ */
178
+ IdentityInfo?: UserIdentityInfo | undefined;
179
+ /**
180
+ * <p>The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code>.</p>
181
+ * @public
182
+ */
183
+ PhoneConfig?: UserPhoneConfig | undefined;
184
+ /**
185
+ * <p>The identifier of the user account in the directory used for identity management. If Connect Customer cannot
186
+ * access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume
187
+ * that Connect Customer cannot access the directory. Otherwise, the identity information is used to authenticate
188
+ * users from your directory.</p>
189
+ * <p>This parameter is required if you are using an existing directory for identity management in Connect Customer
190
+ * when Connect Customer cannot access your directory to authenticate users. If you are using SAML for identity
191
+ * management and include this parameter, an error is returned.</p>
192
+ * @public
193
+ */
194
+ DirectoryUserId?: string | undefined;
195
+ /**
196
+ * <p>The identifier of the security profile for the user.</p>
197
+ * @public
198
+ */
199
+ SecurityProfileIds: string[] | undefined;
200
+ /**
201
+ * <p>The identifier of the routing profile for the user.</p>
202
+ * @public
203
+ */
204
+ RoutingProfileId: string | undefined;
205
+ /**
206
+ * <p>The identifier of the hierarchy group for the user.</p>
207
+ * @public
208
+ */
209
+ HierarchyGroupId?: string | undefined;
210
+ /**
211
+ * <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>
212
+ * @public
213
+ */
214
+ InstanceId: string | undefined;
215
+ /**
216
+ * <p>The list of auto-accept configuration settings for each channel.</p>
217
+ * @public
218
+ */
219
+ AutoAcceptConfigs?: AutoAcceptConfig[] | undefined;
220
+ /**
221
+ * <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
222
+ * @public
223
+ */
224
+ AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined;
225
+ /**
226
+ * <p>The list of phone number configuration settings for each channel.</p>
227
+ * @public
228
+ */
229
+ PhoneNumberConfigs?: PhoneNumberConfig[] | undefined;
230
+ /**
231
+ * <p>The list of persistent connection configuration settings for each channel.</p>
232
+ * @public
233
+ */
234
+ PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined;
235
+ /**
236
+ * <p>The list of voice enhancement configuration settings for each channel.</p>
237
+ * @public
238
+ */
239
+ VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined;
240
+ /**
241
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
242
+ * @public
243
+ */
244
+ Tags?: Record<string, string> | undefined;
245
+ }
246
+ /**
247
+ * @public
248
+ */
249
+ export interface CreateUserResponse {
250
+ /**
251
+ * <p>The identifier of the user account.</p>
252
+ * @public
253
+ */
254
+ UserId?: string | undefined;
255
+ /**
256
+ * <p>The Amazon Resource Name (ARN) of the user account.</p>
257
+ * @public
258
+ */
259
+ UserArn?: string | undefined;
260
+ }
261
+ /**
262
+ * @public
263
+ */
264
+ export interface CreateUserHierarchyGroupRequest {
265
+ /**
266
+ * <p>The name of the user hierarchy group. Must not be more than 100 characters.</p>
267
+ * @public
268
+ */
269
+ Name: string | undefined;
270
+ /**
271
+ * <p>The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID
272
+ * is null.</p>
273
+ * @public
274
+ */
275
+ ParentGroupId?: string | undefined;
276
+ /**
277
+ * <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>
278
+ * @public
279
+ */
280
+ InstanceId: string | undefined;
281
+ /**
282
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
283
+ * @public
284
+ */
285
+ Tags?: Record<string, string> | undefined;
286
+ }
3
287
  /**
4
288
  * @public
5
289
  */
@@ -996,6 +1280,26 @@ export interface DeleteIntegrationAssociationRequest {
996
1280
  */
997
1281
  IntegrationAssociationId: string | undefined;
998
1282
  }
1283
+ /**
1284
+ * @public
1285
+ */
1286
+ export interface DeleteMetricRequest {
1287
+ /**
1288
+ * <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>
1289
+ * @public
1290
+ */
1291
+ InstanceId: string | undefined;
1292
+ /**
1293
+ * <p>The identifier of the metric to delete.</p>
1294
+ * @public
1295
+ */
1296
+ MetricId: string | undefined;
1297
+ }
1298
+ /**
1299
+ * @public
1300
+ */
1301
+ export interface DeleteMetricResponse {
1302
+ }
999
1303
  /**
1000
1304
  * @public
1001
1305
  */
@@ -3822,90 +4126,272 @@ export interface DescribeInstanceStorageConfigResponse {
3822
4126
  /**
3823
4127
  * @public
3824
4128
  */
3825
- export interface DescribeNotificationRequest {
4129
+ export interface DescribeMetricRequest {
3826
4130
  /**
3827
- * <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>
4131
+ * <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>
3828
4132
  * @public
3829
4133
  */
3830
4134
  InstanceId: string | undefined;
3831
4135
  /**
3832
- * <p>The unique identifier for the notification.</p>
4136
+ * <p>The identifier of the metric to describe. Adding the <code>$SAVED</code> qualifier will describe the saved version of the metric. Adding <code>$LATEST</code> or omitting a qualifier will describe the published version.</p>
3833
4137
  * @public
3834
4138
  */
3835
- NotificationId: string | undefined;
4139
+ MetricId: string | undefined;
3836
4140
  }
3837
4141
  /**
3838
- * <p>Contains information about a notification, including its content, priority, recipients, and metadata.</p>
4142
+ * <p>A filter that is available for use with the metric. Part of an AvailableFilterList that describes the filters that are available for use with the metric.</p>
3839
4143
  * @public
3840
4144
  */
3841
- export interface Notification {
4145
+ export interface AvailableFilter {
3842
4146
  /**
3843
- * <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
4147
+ * <p>The identifier of the filter.</p>
3844
4148
  * @public
3845
4149
  */
3846
- Content?: Partial<Record<LocaleCode, string>> | undefined;
4150
+ Id?: string | undefined;
3847
4151
  /**
3848
- * <p>The unique identifier for the notification.</p>
4152
+ * <p>The type of the filter. Valid values: <code>METRIC_LEVEL</code> | <code>RESOURCE_LEVEL</code>.</p>
3849
4153
  * @public
3850
4154
  */
3851
- Id: string | undefined;
4155
+ Type?: AvailableFilterType | undefined;
4156
+ }
4157
+ /**
4158
+ * <p>Contains the full definition of a metric, including its calculation, unit, status, and trend indicator.</p>
4159
+ * @public
4160
+ */
4161
+ export interface MetricDefinition {
3852
4162
  /**
3853
- * <p>The Amazon Resource Name (ARN) of the notification.</p>
4163
+ * <p>The Amazon Resource Name (ARN) of the metric. May be qualified with <code>$SAVED</code> or <code>$LATEST</code>.</p>
3854
4164
  * @public
3855
4165
  */
3856
4166
  Arn: string | undefined;
3857
4167
  /**
3858
- * <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
4168
+ * <p>The identifier of the metric.</p>
3859
4169
  * @public
3860
4170
  */
3861
- Priority?: NotificationPriority | undefined;
4171
+ Id: string | undefined;
3862
4172
  /**
3863
- * <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
4173
+ * <p>The name of the metric.</p>
3864
4174
  * @public
3865
4175
  */
3866
- Recipients?: string[] | undefined;
4176
+ Name: string | undefined;
3867
4177
  /**
3868
- * <p>The timestamp when the notification was last modified.</p>
4178
+ * <p>The description of the metric.</p>
3869
4179
  * @public
3870
4180
  */
3871
- LastModifiedTime: Date | undefined;
4181
+ Description?: string | undefined;
3872
4182
  /**
3873
- * <p>The timestamp when the notification was created.</p>
4183
+ * <p>The calculation definition for the metric.</p>
3874
4184
  * @public
3875
4185
  */
3876
- CreatedAt?: Date | undefined;
4186
+ MetricCalculation?: MetricCalculation | undefined;
3877
4187
  /**
3878
- * <p>The timestamp when the notification expires and is no longer displayed to users.</p>
4188
+ * <p>The method used to create the metric. Valid values: <code>SERVICE_LEVEL_BUILDER</code> (created with the guided service-level experience) | <code>METRIC_BUILDER</code> (created with the free-form metric builder).</p>
3879
4189
  * @public
3880
4190
  */
3881
- ExpiresAt?: Date | undefined;
4191
+ CreationMethod?: MetricCreationMethod | undefined;
3882
4192
  /**
3883
- * <p>The AWS Region where the notification was last modified.</p>
4193
+ * <p>The publish status of the metric. Valid values: <code>PUBLISHED</code> | <code>SAVED</code>.</p>
3884
4194
  * @public
3885
4195
  */
3886
- LastModifiedRegion?: string | undefined;
4196
+ Status?: MetricStatus | undefined;
3887
4197
  /**
3888
- * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags": \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
4198
+ * <p>The type of the metric. Valid values: <code>AWS_MANAGED</code> | <code>CUSTOMER_MANAGED</code>.</p>
3889
4199
  * @public
3890
4200
  */
3891
- Tags?: Record<string, string> | undefined;
3892
- }
3893
- /**
3894
- * @public
3895
- */
3896
- export interface DescribeNotificationResponse {
4201
+ Type: MetricType | undefined;
3897
4202
  /**
3898
- * <p>The complete notification information including content, priority, recipients, and metadata.</p>
4203
+ * <p>The display unit for the metric's data.</p>
3899
4204
  * @public
3900
4205
  */
3901
- Notification: Notification | undefined;
3902
- }
3903
- /**
3904
- * @public
3905
- */
3906
- export interface DescribePhoneNumberRequest {
4206
+ Unit: MetricUnit | undefined;
3907
4207
  /**
3908
- * <p>A unique identifier for the phone number.</p>
4208
+ * <p>How an increase in the metric value should be interpreted. Valid values: <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>NEGATIVE</code>.</p>
4209
+ * @public
4210
+ */
4211
+ PositiveTrendIndicator?: TrendIndicator | undefined;
4212
+ /**
4213
+ * <p>The groupings available for this metric.</p>
4214
+ * @public
4215
+ */
4216
+ Groupings: string[] | undefined;
4217
+ /**
4218
+ * <p>The filters applied to the metric.</p>
4219
+ * @public
4220
+ */
4221
+ Filters: AvailableFilter[] | undefined;
4222
+ /**
4223
+ * <p>The earliest time that can be queried for this metric.</p>
4224
+ * @public
4225
+ */
4226
+ EffectiveTime?: Date | undefined;
4227
+ /**
4228
+ * <p>The minimum interval, in seconds, between data refreshes for this metric.</p>
4229
+ * @public
4230
+ */
4231
+ RefreshRate?: number | undefined;
4232
+ /**
4233
+ * <p>The category of the metric.</p>
4234
+ * @public
4235
+ */
4236
+ Category: string | undefined;
4237
+ /**
4238
+ * <p>The stat aggregations available for this metric.</p>
4239
+ * @public
4240
+ */
4241
+ SupportedStats?: string[] | undefined;
4242
+ /**
4243
+ * <p>The default stat aggregation for the metric.</p>
4244
+ * @public
4245
+ */
4246
+ DefaultStat?: string | undefined;
4247
+ /**
4248
+ * <p>Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.</p>
4249
+ * @public
4250
+ */
4251
+ SupportsPreaggregateCalculation: boolean | undefined;
4252
+ /**
4253
+ * <p>Specifies whether the metric can be used as a component of custom metrics.</p>
4254
+ * @public
4255
+ */
4256
+ SupportsCustomCalculation: boolean | undefined;
4257
+ /**
4258
+ * <p>The primary event source for the metric data.</p>
4259
+ * @public
4260
+ */
4261
+ PrimaryEventSource?: string | undefined;
4262
+ /**
4263
+ * <p>The timestamp type that determines where the metric appears on a time series.</p>
4264
+ * @public
4265
+ */
4266
+ PrimaryEventSourceEffectiveTimestampType?: string | undefined;
4267
+ /**
4268
+ * <p>The timestamp of when the metric was created.</p>
4269
+ * @public
4270
+ */
4271
+ CreatedTime?: Date | undefined;
4272
+ /**
4273
+ * <p>The user that created the metric. The creator for metrics created through the CreateMetric API will be <code>Amazon Connect API</code>.</p>
4274
+ * @public
4275
+ */
4276
+ CreatedUser?: CreatedByInfo | undefined;
4277
+ /**
4278
+ * <p>The region where the metric was last modified.</p>
4279
+ * @public
4280
+ */
4281
+ LastModifiedRegion?: string | undefined;
4282
+ /**
4283
+ * <p>The timestamp of when the metric was last modified.</p>
4284
+ * @public
4285
+ */
4286
+ LastModifiedTime?: Date | undefined;
4287
+ /**
4288
+ * <p>The user that last modified the metric. For modifications made through the API, this will be <code>Amazon Connect API</code>.</p>
4289
+ * @public
4290
+ */
4291
+ LastModifiedUser?: CreatedByInfo | undefined;
4292
+ /**
4293
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
4294
+ * @public
4295
+ */
4296
+ Tags?: Record<string, string> | undefined;
4297
+ }
4298
+ /**
4299
+ * @public
4300
+ */
4301
+ export interface DescribeMetricResponse {
4302
+ /**
4303
+ * <p>The metric definition.</p>
4304
+ * @public
4305
+ */
4306
+ Metric: MetricDefinition | undefined;
4307
+ }
4308
+ /**
4309
+ * @public
4310
+ */
4311
+ export interface DescribeNotificationRequest {
4312
+ /**
4313
+ * <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>
4314
+ * @public
4315
+ */
4316
+ InstanceId: string | undefined;
4317
+ /**
4318
+ * <p>The unique identifier for the notification.</p>
4319
+ * @public
4320
+ */
4321
+ NotificationId: string | undefined;
4322
+ }
4323
+ /**
4324
+ * <p>Contains information about a notification, including its content, priority, recipients, and metadata.</p>
4325
+ * @public
4326
+ */
4327
+ export interface Notification {
4328
+ /**
4329
+ * <p>The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.</p>
4330
+ * @public
4331
+ */
4332
+ Content?: Partial<Record<LocaleCode, string>> | undefined;
4333
+ /**
4334
+ * <p>The unique identifier for the notification.</p>
4335
+ * @public
4336
+ */
4337
+ Id: string | undefined;
4338
+ /**
4339
+ * <p>The Amazon Resource Name (ARN) of the notification.</p>
4340
+ * @public
4341
+ */
4342
+ Arn: string | undefined;
4343
+ /**
4344
+ * <p>The priority level of the notification. Valid values are URGENT, HIGH, and LOW.</p>
4345
+ * @public
4346
+ */
4347
+ Priority?: NotificationPriority | undefined;
4348
+ /**
4349
+ * <p>A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.</p>
4350
+ * @public
4351
+ */
4352
+ Recipients?: string[] | undefined;
4353
+ /**
4354
+ * <p>The timestamp when the notification was last modified.</p>
4355
+ * @public
4356
+ */
4357
+ LastModifiedTime: Date | undefined;
4358
+ /**
4359
+ * <p>The timestamp when the notification was created.</p>
4360
+ * @public
4361
+ */
4362
+ CreatedAt?: Date | undefined;
4363
+ /**
4364
+ * <p>The timestamp when the notification expires and is no longer displayed to users.</p>
4365
+ * @public
4366
+ */
4367
+ ExpiresAt?: Date | undefined;
4368
+ /**
4369
+ * <p>The AWS Region where the notification was last modified.</p>
4370
+ * @public
4371
+ */
4372
+ LastModifiedRegion?: string | undefined;
4373
+ /**
4374
+ * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags": \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
4375
+ * @public
4376
+ */
4377
+ Tags?: Record<string, string> | undefined;
4378
+ }
4379
+ /**
4380
+ * @public
4381
+ */
4382
+ export interface DescribeNotificationResponse {
4383
+ /**
4384
+ * <p>The complete notification information including content, priority, recipients, and metadata.</p>
4385
+ * @public
4386
+ */
4387
+ Notification: Notification | undefined;
4388
+ }
4389
+ /**
4390
+ * @public
4391
+ */
4392
+ export interface DescribePhoneNumberRequest {
4393
+ /**
4394
+ * <p>A unique identifier for the phone number.</p>
3909
4395
  * @public
3910
4396
  */
3911
4397
  PhoneNumberId: string | undefined;
@@ -6890,312 +7376,3 @@ export interface UserData {
6890
7376
  */
6891
7377
  NextStatus?: string | undefined;
6892
7378
  }
6893
- /**
6894
- * @public
6895
- */
6896
- export interface GetCurrentUserDataResponse {
6897
- /**
6898
- * <p>If there are additional results, this is the token for the next set of results.</p>
6899
- * @public
6900
- */
6901
- NextToken?: string | undefined;
6902
- /**
6903
- * <p>A list of the user data that is returned.</p>
6904
- * @public
6905
- */
6906
- UserDataList?: UserData[] | undefined;
6907
- /**
6908
- * <p>The total count of the result, regardless of the current page size.</p>
6909
- * @public
6910
- */
6911
- ApproximateTotalCount?: number | undefined;
6912
- }
6913
- /**
6914
- * @public
6915
- */
6916
- export interface GetEffectiveHoursOfOperationsRequest {
6917
- /**
6918
- * <p>The identifier of the Connect Customer instance.</p>
6919
- * @public
6920
- */
6921
- InstanceId: string | undefined;
6922
- /**
6923
- * <p>The identifier for the hours of operation.</p>
6924
- * @public
6925
- */
6926
- HoursOfOperationId: string | undefined;
6927
- /**
6928
- * <p>The date from when the hours of operation are listed.</p>
6929
- * @public
6930
- */
6931
- FromDate: string | undefined;
6932
- /**
6933
- * <p>The date until when the hours of operation are listed.</p>
6934
- * @public
6935
- */
6936
- ToDate: string | undefined;
6937
- }
6938
- /**
6939
- * <p>Information about the hours of operations with the effective override applied.</p>
6940
- * @public
6941
- */
6942
- export interface OperationalHour {
6943
- /**
6944
- * <p>The start time that your contact center opens.</p>
6945
- * @public
6946
- */
6947
- Start?: OverrideTimeSlice | undefined;
6948
- /**
6949
- * <p>The end time that your contact center closes.</p>
6950
- * @public
6951
- */
6952
- End?: OverrideTimeSlice | undefined;
6953
- }
6954
- /**
6955
- * <p>Information about the hours of operations with the effective override applied.</p>
6956
- * @public
6957
- */
6958
- export interface EffectiveHoursOfOperations {
6959
- /**
6960
- * <p>The date that the hours of operation or overrides applies to.</p>
6961
- * @public
6962
- */
6963
- Date?: string | undefined;
6964
- /**
6965
- * <p>Information about the hours of operations with the effective override applied.</p>
6966
- * @public
6967
- */
6968
- OperationalHours?: OperationalHour[] | undefined;
6969
- }
6970
- /**
6971
- * <p>Information about hours of operation override</p>
6972
- * @public
6973
- */
6974
- export interface OverrideHour {
6975
- /**
6976
- * <p>The start time or end time for an hours of operation override.</p>
6977
- * @public
6978
- */
6979
- Start?: OverrideTimeSlice | undefined;
6980
- /**
6981
- * <p>The start time or end time for an hours of operation override.</p>
6982
- * @public
6983
- */
6984
- End?: OverrideTimeSlice | undefined;
6985
- /**
6986
- * <p>Unique identifier name for the override.</p>
6987
- * @public
6988
- */
6989
- OverrideName?: string | undefined;
6990
- /**
6991
- * <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>
6992
- * @public
6993
- */
6994
- OperationalStatus?: OperationalStatus | undefined;
6995
- }
6996
- /**
6997
- * <p>Information about the hours of operation overrides which contribute to effective hours of operations.</p>
6998
- * @public
6999
- */
7000
- export interface EffectiveOverrideHours {
7001
- /**
7002
- * <p>The date that the hours of operation override applies to.</p>
7003
- * @public
7004
- */
7005
- Date?: string | undefined;
7006
- /**
7007
- * <p>Information about the hours of operation overrides that apply to a specific date.</p>
7008
- * @public
7009
- */
7010
- OverrideHours?: OverrideHour[] | undefined;
7011
- }
7012
- /**
7013
- * @public
7014
- */
7015
- export interface GetEffectiveHoursOfOperationsResponse {
7016
- /**
7017
- * <p>Information about the effective hours of operations.</p>
7018
- * @public
7019
- */
7020
- EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined;
7021
- /**
7022
- * <p>Information about override configurations applied to the base hours of operation to calculate the effective hours.</p>
7023
- * <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
7024
- * <i> Administrator Guide</i>.</p>
7025
- * @public
7026
- */
7027
- EffectiveOverrideHoursList?: EffectiveOverrideHours[] | undefined;
7028
- /**
7029
- * <p>The time zone for the hours of operation.</p>
7030
- * @public
7031
- */
7032
- TimeZone?: string | undefined;
7033
- }
7034
- /**
7035
- * @public
7036
- */
7037
- export interface GetEvaluationFormValidationRequest {
7038
- /**
7039
- * <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>
7040
- * @public
7041
- */
7042
- InstanceId: string | undefined;
7043
- /**
7044
- * <p>The unique identifier for the evaluation form.</p>
7045
- * @public
7046
- */
7047
- EvaluationFormId: string | undefined;
7048
- /**
7049
- * <p>The version of the evaluation form to retrieve validation results for.</p>
7050
- * @public
7051
- */
7052
- EvaluationFormVersion?: number | undefined;
7053
- }
7054
- /**
7055
- * <p>Information about an evaluation form item affected by a validation finding.</p>
7056
- * @public
7057
- */
7058
- export interface EvaluationFormValidationFindingItem {
7059
- /**
7060
- * <p>The identifier of the evaluation form item (question or section) affected by the finding.</p>
7061
- * @public
7062
- */
7063
- RefId?: string | undefined;
7064
- /**
7065
- * <p>The specific property of the evaluation form item that the finding relates to.</p>
7066
- * @public
7067
- */
7068
- Property?: string | undefined;
7069
- }
7070
- /**
7071
- * <p>Information about a finding from the evaluation form validation process. Each finding identifies a structural
7072
- * issue or quality improvement opportunity for the evaluation form.</p>
7073
- * @public
7074
- */
7075
- export interface EvaluationFormValidationFinding {
7076
- /**
7077
- * <p>A code that identifies the type of validation issue found.</p>
7078
- * @public
7079
- */
7080
- IssueCode: string | undefined;
7081
- /**
7082
- * <p>A list of evaluation form items affected by this finding.</p>
7083
- * @public
7084
- */
7085
- Items?: EvaluationFormValidationFindingItem[] | undefined;
7086
- /**
7087
- * <p>A description of the validation issue.</p>
7088
- * @public
7089
- */
7090
- Description: string | undefined;
7091
- /**
7092
- * <p>A suggested fix for the validation issue.</p>
7093
- * @public
7094
- */
7095
- Suggestion?: string | undefined;
7096
- /**
7097
- * <p>The severity of the finding. Valid values: <code>WARNING</code>, <code>ERROR</code>.</p>
7098
- * @public
7099
- */
7100
- Severity: EvaluationFormValidationFindingSeverity | undefined;
7101
- }
7102
- /**
7103
- * @public
7104
- */
7105
- export interface GetEvaluationFormValidationResponse {
7106
- /**
7107
- * <p>The current status of the validation process. Valid values: <code>IN_PROGRESS</code>,
7108
- * <code>COMPLETED</code>, <code>FAILED</code>.</p>
7109
- * @public
7110
- */
7111
- Status: EvaluationFormValidationStatus | undefined;
7112
- /**
7113
- * <p>The reason the validation failed. This field is populated only when the status is
7114
- * <code>FAILED</code>.</p>
7115
- * @public
7116
- */
7117
- FailureReason?: string | undefined;
7118
- /**
7119
- * <p>The unique identifier for the evaluation form.</p>
7120
- * @public
7121
- */
7122
- EvaluationFormId: string | undefined;
7123
- /**
7124
- * <p>A version of the evaluation form.</p>
7125
- * @public
7126
- */
7127
- EvaluationFormVersion: number | undefined;
7128
- /**
7129
- * <p>The timestamp when the validation process was started.</p>
7130
- * @public
7131
- */
7132
- StartedTime: Date | undefined;
7133
- /**
7134
- * <p>A list of findings from the validation process. Each finding identifies a structural issue or quality
7135
- * improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is
7136
- * <code>COMPLETED</code>.</p>
7137
- * @public
7138
- */
7139
- Findings?: EvaluationFormValidationFinding[] | undefined;
7140
- }
7141
- /**
7142
- * @public
7143
- */
7144
- export interface GetFederationTokenRequest {
7145
- /**
7146
- * <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>
7147
- * @public
7148
- */
7149
- InstanceId: string | undefined;
7150
- }
7151
- /**
7152
- * <p>Contains credentials to use for federation.</p>
7153
- * @public
7154
- */
7155
- export interface Credentials {
7156
- /**
7157
- * <p>An access token generated for a federated user to access Connect Customer.</p>
7158
- * @public
7159
- */
7160
- AccessToken?: string | undefined;
7161
- /**
7162
- * <p>A token generated with an expiration time for the session a user is logged in to Connect Customer.</p>
7163
- * @public
7164
- */
7165
- AccessTokenExpiration?: Date | undefined;
7166
- /**
7167
- * <p>Renews a token generated for a user to access the Connect Customer instance.</p>
7168
- * @public
7169
- */
7170
- RefreshToken?: string | undefined;
7171
- /**
7172
- * <p>Renews the expiration timer for a generated token.</p>
7173
- * @public
7174
- */
7175
- RefreshTokenExpiration?: Date | undefined;
7176
- }
7177
- /**
7178
- * @public
7179
- */
7180
- export interface GetFederationTokenResponse {
7181
- /**
7182
- * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
7183
- * @public
7184
- */
7185
- UserId?: string | undefined;
7186
- /**
7187
- * <p>The Amazon Resource Name (ARN) of the user.</p>
7188
- * @public
7189
- */
7190
- UserArn?: string | undefined;
7191
- /**
7192
- * <p>The credentials to use for federation.</p>
7193
- * @public
7194
- */
7195
- Credentials?: Credentials | undefined;
7196
- /**
7197
- * <p>The URL to sign into the user's instance. </p>
7198
- * @public
7199
- */
7200
- SignInUrl?: string | undefined;
7201
- }