@aws-sdk/client-connect 3.1106.0 → 3.1108.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.
- package/README.md +49 -0
- package/dist-cjs/index.js +391 -46
- package/dist-es/Connect.js +18 -0
- package/dist-es/commands/CreateMetricCommand.js +4 -0
- package/dist-es/commands/DeleteMetricCommand.js +4 -0
- package/dist-es/commands/DescribeMetricCommand.js +4 -0
- package/dist-es/commands/ListMetricsCommand.js +4 -0
- package/dist-es/commands/SearchMetricsCommand.js +4 -0
- package/dist-es/commands/UpdateMetricContentCommand.js +4 -0
- package/dist-es/commands/UpdateMetricMetadataCommand.js +4 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/index.js +1 -1
- package/dist-es/models/enums.js +42 -0
- package/dist-es/pagination/ListMetricsPaginator.js +4 -0
- package/dist-es/pagination/SearchMetricsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +268 -45
- package/dist-types/Connect.d.ts +63 -0
- package/dist-types/ConnectClient.d.ts +9 -2
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateMetricCommand.d.ts +137 -0
- package/dist-types/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +1 -2
- package/dist-types/commands/DeleteMetricCommand.d.ts +93 -0
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMetricCommand.d.ts +165 -0
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +2 -1
- package/dist-types/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
- package/dist-types/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +103 -0
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/commands/SearchEvaluationFormsCommand.d.ts +1 -1
- package/dist-types/commands/SearchMetricsCommand.d.ts +223 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMetricContentCommand.d.ts +121 -0
- package/dist-types/commands/UpdateMetricMetadataCommand.d.ts +93 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/enums.d.ts +114 -0
- package/dist-types/models/models_0.d.ts +185 -285
- package/dist-types/models/models_1.d.ts +526 -349
- package/dist-types/models/models_2.d.ts +394 -355
- package/dist-types/models/models_3.d.ts +469 -663
- package/dist-types/models/models_4.d.ts +715 -5
- package/dist-types/pagination/ListMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchMetricsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +32 -0
- package/dist-types/ts3.4/Connect.d.ts +130 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DeleteMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeMetricCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetEffectiveHoursOfOperationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetEvaluationFormValidationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactEvaluationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchContactFlowModulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchMetricsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateMetricContentCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateMetricMetadataCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +1 -1
- package/dist-types/ts3.4/models/enums.d.ts +54 -0
- package/dist-types/ts3.4/models/models_0.d.ts +49 -55
- package/dist-types/ts3.4/models/models_1.d.ts +108 -82
- package/dist-types/ts3.4/models/models_2.d.ts +99 -86
- package/dist-types/ts3.4/models/models_3.d.ts +121 -153
- package/dist-types/ts3.4/models/models_4.d.ts +174 -21
- package/dist-types/ts3.4/pagination/ListMetricsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/SearchMetricsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +32 -0
- package/package.json +6 -6
|
@@ -1,8 +1,687 @@
|
|
|
1
|
-
import type { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, DisconnectOnCustomerExitParticipantType, EvaluationFormValidationStatus, EvaluationFormVersionStatus, InitiateAs, RoutingCriteriaStepStatus } from "./enums";
|
|
2
|
-
import type { AdditionalEmailRecipients, AgentInfo, Campaign, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormLanguageConfiguration, EvaluationFormScoreThreshold, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy, Reference, UserInfo } from "./models_0";
|
|
3
|
-
import type { ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, Expiry, GlobalResiliencyMetadata, NextContactEntry, QualityMetrics, QueueInfo, RecordingInfo, TaskTemplateInfoV2, WisdomInfo } from "./models_1";
|
|
4
|
-
import type { ContactFlowSearchFilter } from "./models_2";
|
|
5
|
-
import type { ChatMessage, ContactFlowSearchCriteria, ContactSearchSummaryAgentInfo, ContactSearchSummaryAiAgentInfo, ContactSearchSummaryQueueInfo, DataTableSearchCriteria, DataTableSearchFilter, EmailAddressInfo, EmailAddressSearchCriteria, EmailAddressSearchFilter, EmailAttachment,
|
|
1
|
+
import type { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, DisconnectOnCustomerExitParticipantType, EvaluationFormQuestionType, EvaluationFormValidationStatus, EvaluationFormVersionStatus, InitiateAs, RoutingCriteriaStepStatus, SearchableQueueType, TestCaseStatus, ViewStatus, ViewType } from "./enums";
|
|
2
|
+
import type { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormLanguageConfiguration, EvaluationFormQuestionScoringConfiguration, EvaluationFormQuestionTypeProperties, EvaluationFormScoreThreshold, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy, Reference, StringCondition, UserInfo } from "./models_0";
|
|
3
|
+
import type { AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, Expiry, GlobalResiliencyMetadata, NextContactEntry, QualityMetrics, QueueInfo, RecordingInfo, TaskTemplateInfoV2, WisdomInfo } from "./models_1";
|
|
4
|
+
import type { BooleanCondition, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, EvaluationSearchFilter } from "./models_2";
|
|
5
|
+
import type { AgentStatusSearchCriteria, ChatMessage, ContactFlowModuleSearchCriteria, ContactFlowSearchCriteria, ContactSearchSummaryAgentInfo, ContactSearchSummaryAiAgentInfo, ContactSearchSummaryQueueInfo, DataTableSearchCriteria, DataTableSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchCriteria, EmailAddressSearchFilter, EmailAttachment, EvaluationFormItemEnablementConfiguration, EvaluationFormSearchCriteria, EvaluationFormSearchFilter, EvaluationSearchCriteria, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, MetricSearchFilter, NotificationSearchFilter, ParticipantConfiguration, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, RulesSearchFilter, SecurityProfilesSearchFilter, TaskAttachment, TemplatedMessageConfig, TestCaseSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter, ViewSearchFilter, WorkspaceAssociationSearchFilter, WorkspaceSearchFilter } from "./models_3";
|
|
6
|
+
/**
|
|
7
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export interface Expression {
|
|
11
|
+
/**
|
|
12
|
+
* <p>An object to specify the predefined attribute condition.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
AttributeCondition?: AttributeCondition | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>List of routing expressions which will be AND-ed together.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
AndExpression?: Expression[] | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* <p>List of routing expressions which will be OR-ed together.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
OrExpression?: Expression[] | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>An object to specify the predefined attribute condition.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
NotAttributeCondition?: AttributeCondition | undefined;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* <p>The search criteria to be used to return hours of operations overrides.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
export interface HoursOfOperationOverrideSearchCriteria {
|
|
37
|
+
/**
|
|
38
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
StringCondition?: StringCondition | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>A leaf node condition which can be used to specify a date condition.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
DateCondition?: DateCondition | undefined;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* <p>The search criteria to be used to return hours of operations.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export interface HoursOfOperationSearchCriteria {
|
|
63
|
+
/**
|
|
64
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
75
|
+
* <note>
|
|
76
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>,
|
|
77
|
+
* <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
78
|
+
* </note>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
StringCondition?: StringCondition | undefined;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* <p>Defines the search criteria for filtering metrics.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export interface MetricSearchCriteria {
|
|
88
|
+
/**
|
|
89
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
OrConditions?: MetricSearchCriteria[] | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
AndConditions?: MetricSearchCriteria[] | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
StringCondition?: StringCondition | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>A boolean search condition for Search APIs.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
BooleanCondition?: BooleanCondition | undefined;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* <p>The search criteria to be used to return notifications.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export interface NotificationSearchCriteria {
|
|
114
|
+
/**
|
|
115
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
OrConditions?: NotificationSearchCriteria[] | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
AndConditions?: NotificationSearchCriteria[] | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
StringCondition?: StringCondition | undefined;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export interface PredefinedAttributeSearchCriteria {
|
|
135
|
+
/**
|
|
136
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
StringCondition?: StringCondition | undefined;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
export interface PromptSearchCriteria {
|
|
156
|
+
/**
|
|
157
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
OrConditions?: PromptSearchCriteria[] | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
AndConditions?: PromptSearchCriteria[] | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
168
|
+
* <note>
|
|
169
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
170
|
+
* <code>resourceID</code>.</p>
|
|
171
|
+
* </note>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
StringCondition?: StringCondition | undefined;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
178
|
+
* <note>
|
|
179
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
180
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
181
|
+
* outside of this range will throw invalid results. </p>
|
|
182
|
+
* </note>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface QueueSearchCriteria {
|
|
186
|
+
/**
|
|
187
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
OrConditions?: QueueSearchCriteria[] | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
AndConditions?: QueueSearchCriteria[] | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
198
|
+
* <note>
|
|
199
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
200
|
+
* <code>resourceID</code>.</p>
|
|
201
|
+
* </note>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
StringCondition?: StringCondition | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The type of queue.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
QueueTypeCondition?: SearchableQueueType | undefined;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* <p>The search criteria to be used to return quick connects.</p>
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
export interface QuickConnectSearchCriteria {
|
|
216
|
+
/**
|
|
217
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
OrConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
AndConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
226
|
+
/**
|
|
227
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
228
|
+
* <note>
|
|
229
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
230
|
+
* <code>resourceID</code>.</p>
|
|
231
|
+
* </note>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
StringCondition?: StringCondition | undefined;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* <p>The search criteria to be used to return routing profiles.</p>
|
|
238
|
+
* <note>
|
|
239
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
240
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
241
|
+
* outside of this range will throw invalid results. </p>
|
|
242
|
+
* </note>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface RoutingProfileSearchCriteria {
|
|
246
|
+
/**
|
|
247
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
OrConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
AndConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
258
|
+
* <note>
|
|
259
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>associatedQueueIds</code>,
|
|
260
|
+
* <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p>
|
|
261
|
+
* </note>
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
StringCondition?: StringCondition | undefined;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* <p>The search criteria to be used to return rules.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export interface RulesSearchCriteria {
|
|
271
|
+
/**
|
|
272
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
OrConditions?: RulesSearchCriteria[] | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
AndConditions?: RulesSearchCriteria[] | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
283
|
+
* <note>
|
|
284
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>Name</code>,
|
|
285
|
+
* <code>PublishStatus</code>, <code>EventSourceName</code>, <code>RuleId</code>,
|
|
286
|
+
* <code>IntegrationAssociationId</code>, <code>ActionSummaries</code>, and
|
|
287
|
+
* <code>RuleCapabilityTiers</code>.</p>
|
|
288
|
+
* </note>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
StringCondition?: StringCondition | undefined;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* <p>The search criteria to be used to return security profiles.</p>
|
|
295
|
+
* <note>
|
|
296
|
+
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and maximum of 25
|
|
297
|
+
* characters. Any queries with character lengths outside of this range will throw invalid
|
|
298
|
+
* results.</p>
|
|
299
|
+
* </note>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
export interface SecurityProfileSearchCriteria {
|
|
303
|
+
/**
|
|
304
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
OrConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
308
|
+
/**
|
|
309
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
310
|
+
* @public
|
|
311
|
+
*/
|
|
312
|
+
AndConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
StringCondition?: StringCondition | undefined;
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* <p>A value for a segment attribute. This is structured as a map where the key is <code>valueString</code> and the
|
|
321
|
+
* value is a string.</p>
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
export interface SegmentAttributeValue {
|
|
325
|
+
/**
|
|
326
|
+
* <p>The value of a segment attribute.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
ValueString?: string | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The value of a segment attribute.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>The value of a segment attribute.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
ValueInteger?: number | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* <p>The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined
|
|
342
|
+
* attributes.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
ValueList?: SegmentAttributeValue[] | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined
|
|
348
|
+
* attributes, not for user-defined attributes.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
ValueArn?: string | undefined;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* <p>The search criteria to be used to return test cases.</p>
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
export interface TestCaseSearchCriteria {
|
|
358
|
+
/**
|
|
359
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
OrConditions?: TestCaseSearchCriteria[] | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
AndConditions?: TestCaseSearchCriteria[] | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
StringCondition?: StringCondition | undefined;
|
|
373
|
+
/**
|
|
374
|
+
* <p>The status of the test case.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
StatusCondition?: TestCaseStatus | undefined;
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
384
|
+
/**
|
|
385
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
388
|
+
OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
396
|
+
* <note>
|
|
397
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>parentId</code>,
|
|
398
|
+
* <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
399
|
+
* </note>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
StringCondition?: StringCondition | undefined;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* <p>The search criteria to be used to return users.</p>
|
|
406
|
+
* <note>
|
|
407
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
408
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
409
|
+
* outside of this range will throw invalid results. </p>
|
|
410
|
+
* </note>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
export interface UserSearchCriteria {
|
|
414
|
+
/**
|
|
415
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
OrConditions?: UserSearchCriteria[] | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
AndConditions?: UserSearchCriteria[] | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
426
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>, <code>FirstName</code>,
|
|
427
|
+
* <code>LastName</code>, <code>RoutingProfileId</code>, <code>SecurityProfileId</code>,
|
|
428
|
+
* <code>resourceId</code>.</p>
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
StringCondition?: StringCondition | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with attributes included in
|
|
434
|
+
* Lists like Proficiencies.</p>
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
ListCondition?: ListCondition | undefined;
|
|
438
|
+
/**
|
|
439
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* <p>Defines the search criteria for filtering views.</p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
export interface ViewSearchCriteria {
|
|
449
|
+
/**
|
|
450
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
OrConditions?: ViewSearchCriteria[] | undefined;
|
|
454
|
+
/**
|
|
455
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
AndConditions?: ViewSearchCriteria[] | undefined;
|
|
459
|
+
/**
|
|
460
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
StringCondition?: StringCondition | undefined;
|
|
464
|
+
/**
|
|
465
|
+
* <p>A condition that filters views by their type.</p>
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
ViewTypeCondition?: ViewType | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* <p>A condition that filters views by their status.</p>
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
ViewStatusCondition?: ViewStatus | undefined;
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* <p>Defines the search criteria for filtering workspace associations.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
export interface WorkspaceAssociationSearchCriteria {
|
|
480
|
+
/**
|
|
481
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
OrConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
AndConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
490
|
+
/**
|
|
491
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
StringCondition?: StringCondition | undefined;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* <p>Defines the search criteria for filtering workspaces.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
export interface WorkspaceSearchCriteria {
|
|
501
|
+
/**
|
|
502
|
+
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
OrConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* <p>A list of conditions that must all be satisfied.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
AndConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
StringCondition?: StringCondition | undefined;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* <p>Information about a question from an evaluation form.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
export interface EvaluationFormQuestion {
|
|
522
|
+
/**
|
|
523
|
+
* <p>The title of the question.</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
Title: string | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* <p>The instructions of the section.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
Instructions?: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>The identifier of the question. An identifier must be unique within the evaluation form.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
RefId: string | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>The flag to enable not applicable answers to the question.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
NotApplicableEnabled?: boolean | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>The type of the question.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
QuestionType: EvaluationFormQuestionType | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>The properties of the type of question. Text questions do not have to define question type properties.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
QuestionTypeProperties?: EvaluationFormQuestionTypeProperties | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>A question conditional enablement.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
Enablement?: EvaluationFormItemEnablementConfiguration | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The scoring weight of the section.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
Weight?: number | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The scoring configuration of the question.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
ScoringConfiguration?: EvaluationFormQuestionScoringConfiguration | undefined;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* <p>Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel,
|
|
570
|
+
* Name, or Value.</p>
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
export interface RoutingCriteriaInputStep {
|
|
574
|
+
/**
|
|
575
|
+
* <p>An object to specify the expiration of a routing step.</p>
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
Expiry?: RoutingCriteriaInputStepExpiry | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* <p>A tagged union to specify expression for a routing step.</p>
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
Expression?: Expression | undefined;
|
|
584
|
+
}
|
|
585
|
+
/**
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
export interface SearchAgentStatusesRequest {
|
|
589
|
+
/**
|
|
590
|
+
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
591
|
+
* instance.</p>
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
InstanceId: string | undefined;
|
|
595
|
+
/**
|
|
596
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
597
|
+
* retrieve the next set of results.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
NextToken?: string | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* <p>The maximum number of results to return per page.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
MaxResults?: number | undefined;
|
|
606
|
+
/**
|
|
607
|
+
* <p>Filters to be applied to search results.</p>
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
SearchFilter?: AgentStatusSearchFilter | undefined;
|
|
611
|
+
/**
|
|
612
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
SearchCriteria?: AgentStatusSearchCriteria | undefined;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
export interface SearchContactEvaluationsRequest {
|
|
621
|
+
/**
|
|
622
|
+
* <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>
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
InstanceId: string | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
628
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
NextToken?: string | undefined;
|
|
632
|
+
/**
|
|
633
|
+
* <p>The maximum number of results to return per page.</p>
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
MaxResults?: number | undefined;
|
|
637
|
+
/**
|
|
638
|
+
* <p>The search criteria to be used to return contact evaluations.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
SearchCriteria?: EvaluationSearchCriteria | undefined;
|
|
642
|
+
/**
|
|
643
|
+
* <p>Filters to be applied to search results.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
SearchFilter?: EvaluationSearchFilter | undefined;
|
|
647
|
+
}
|
|
648
|
+
/**
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
export interface SearchContactFlowModulesRequest {
|
|
652
|
+
/**
|
|
653
|
+
* <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name
|
|
654
|
+
* (ARN) of the instance.</p>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
InstanceId: string | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
660
|
+
* retrieve the next set of results.</p>
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
NextToken?: string | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* <p>The maximum number of results to return per page.</p>
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
MaxResults?: number | undefined;
|
|
669
|
+
/**
|
|
670
|
+
* <p>Filters to be applied to search results.</p>
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
SearchFilter?: ContactFlowModuleSearchFilter | undefined;
|
|
674
|
+
/**
|
|
675
|
+
* <p>The search criteria to be used to return flow modules.</p>
|
|
676
|
+
* <note>
|
|
677
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2
|
|
678
|
+
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
|
|
679
|
+
* invalid results.</p>
|
|
680
|
+
* </note>
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
|
|
684
|
+
}
|
|
6
685
|
/**
|
|
7
686
|
* @public
|
|
8
687
|
*/
|
|
@@ -196,6 +875,37 @@ export interface SearchHoursOfOperationsRequest {
|
|
|
196
875
|
*/
|
|
197
876
|
SearchCriteria?: HoursOfOperationSearchCriteria | undefined;
|
|
198
877
|
}
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
export interface SearchMetricsRequest {
|
|
882
|
+
/**
|
|
883
|
+
* <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>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
InstanceId: string | undefined;
|
|
887
|
+
/**
|
|
888
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
889
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
NextToken?: string | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* <p>The maximum number of results to return per page.</p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
MaxResults?: number | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* <p>Filters to be applied to search results.</p>
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
SearchFilter?: MetricSearchFilter | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* <p>The search criteria to filter the metrics.</p>
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
SearchCriteria?: MetricSearchCriteria | undefined;
|
|
908
|
+
}
|
|
199
909
|
/**
|
|
200
910
|
* @public
|
|
201
911
|
*/
|