@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,7 +1,359 @@
|
|
|
1
|
-
import type { AgentAvailabilityTimer, AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, Behavior, ChatEventType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInteractionType, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, EmailHeaderType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormLanguageCode,
|
|
2
|
-
import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentConfig,
|
|
3
|
-
import type {
|
|
4
|
-
import type { BooleanCondition,
|
|
1
|
+
import type { AgentAvailabilityTimer, AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, Behavior, Channel, ChatEventType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, EmailHeaderType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormLanguageCode, EvaluationFormVersionStatus, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MeetingFeatureStatus, MetricUnit, NotificationPriority, NotificationStatus, NotificationType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, Policy, QueueStatus, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, ViewStatus, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
|
|
2
|
+
import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentConfig, AgentHierarchyGroups, AiAgentsCriteria, AliasConfiguration, AllowedCapabilities, Application, AutoAcceptConfig, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, EvaluationFormItemEnablementExpression, FlowModule, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MediaConcurrency, MetricCalculation, OutboundCallerConfig, OutboundEmailConfig, OutboundStrategy, PredefinedAttributeValues, PrimaryValue, QuickConnectConfig, RecurrenceConfig, Reference, RoutingProfileQueueConfig, RuleAction, RuleTriggerEventSource, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TestCaseEntryPoint, UserProficiency, Validation } from "./models_0";
|
|
3
|
+
import type { DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, UserIdentityInfo, UserPhoneConfig, View, ViewInputContent, VoiceEnhancementConfig, WorkspaceTheme } from "./models_1";
|
|
4
|
+
import type { BooleanCondition, ControlPlaneTagFilter, DateTimeCondition, DecimalCondition, NumberCondition, SignInConfig, TelephonyConfig } from "./models_2";
|
|
5
|
+
/**
|
|
6
|
+
* <p>A structure of time range that you want to search results.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface SearchContactsTimeRange {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The type of timestamp to search.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
Type: SearchContactsTimeRangeType | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The start time of the time range.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
StartTime: Date | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The end time of the time range.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
EndTime: Date | undefined;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* <p>The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is
|
|
28
|
+
* not an actual timestamp value. </p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface SearchContactsTimestampCondition {
|
|
32
|
+
/**
|
|
33
|
+
* <p>Type of the timestamps to use for the filter.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
Type: SearchContactsTimeRangeType | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>Condition of the timestamp on the contact.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
ConditionType: SearchContactsTimeRangeConditionType | undefined;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* <p>The criteria of the time range to additionally filter on.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
export interface SearchContactsAdditionalTimeRangeCriteria {
|
|
48
|
+
/**
|
|
49
|
+
* <p>A structure of time range that you want to search results.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
TimeRange?: SearchContactsTimeRange | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>List of the timestamp conditions.</p>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
TimestampCondition?: SearchContactsTimestampCondition | undefined;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* <p>Time range that you <b>additionally</b> want to filter on.</p>
|
|
61
|
+
* <note>
|
|
62
|
+
* <p>This is different from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchContactsTimeRange.html">SearchContactsTimeRange</a> data
|
|
63
|
+
* type.</p>
|
|
64
|
+
* </note>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export interface SearchContactsAdditionalTimeRange {
|
|
68
|
+
/**
|
|
69
|
+
* <p>List of criteria of the time range to additionally filter on.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
Criteria: SearchContactsAdditionalTimeRangeCriteria[] | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The match type combining multiple time range filters.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
MatchType: SearchContactsMatchType | undefined;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* <p>A structure that defines search criteria base on words or phrases, participants in the Contact Lens
|
|
81
|
+
* conversational analytics transcript.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export interface TranscriptCriteria {
|
|
85
|
+
/**
|
|
86
|
+
* <p>The participant role in a transcript</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
ParticipantRole: ParticipantRole | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The words or phrases used to search within a transcript.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
SearchText: string[] | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The match type combining search criteria using multiple search texts in a transcript criteria.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
MatchType: SearchContactsMatchType | undefined;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* <p>A structure that defines search criteria and matching logic to search for contacts by matching text with
|
|
103
|
+
* transcripts analyzed by Connect Customer Contact Lens.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export interface Transcript {
|
|
107
|
+
/**
|
|
108
|
+
* <p>The list of search criteria based on Contact Lens conversational analytics transcript.</p>
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
Criteria: TranscriptCriteria[] | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* <p>The match type combining search criteria using multiple transcript criteria.</p>
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
MatchType?: SearchContactsMatchType | undefined;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* <p>A structure that defines search criteria for contacts using analysis outputs from Connect Customer Contact
|
|
120
|
+
* Lens.</p>
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export interface ContactAnalysis {
|
|
124
|
+
/**
|
|
125
|
+
* <p>Search criteria based on transcript analyzed by Connect Customer Contact Lens.</p>
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
Transcript?: Transcript | undefined;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* <p>The search criteria based on the contact name</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export interface NameCriteria {
|
|
135
|
+
/**
|
|
136
|
+
* <p>The words or phrases used to match the contact name.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
SearchText: string[] | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The match type combining name search criteria using multiple search texts in a name criteria.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
MatchType: SearchContactsMatchType | undefined;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* <p>The agent criteria to search for preferred agents on the routing criteria.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
export interface SearchableAgentCriteriaStep {
|
|
151
|
+
/**
|
|
152
|
+
* <p>The identifiers of agents used in preferred agents matching.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
AgentIds?: string[] | undefined;
|
|
156
|
+
/**
|
|
157
|
+
* <p>The match type combining multiple agent criteria steps.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
MatchType?: SearchContactsMatchType | undefined;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* <p>Routing criteria of the contact to match on.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export interface SearchableRoutingCriteriaStep {
|
|
167
|
+
/**
|
|
168
|
+
* <p>Agent matching the routing step of the routing criteria</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
AgentCriteria?: SearchableAgentCriteriaStep | undefined;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* <p>Routing criteria of the contact to match on.</p>
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export interface SearchableRoutingCriteria {
|
|
178
|
+
/**
|
|
179
|
+
* <p>The list of Routing criteria steps of the contact routing.</p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
Steps?: SearchableRoutingCriteriaStep[] | undefined;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* <p>The search criteria based on user-defined contact attribute key and values to search on.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export interface SearchableContactAttributesCriteria {
|
|
189
|
+
/**
|
|
190
|
+
* <p>The key containing a searchable user-defined contact attribute.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
Key: string | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* <p>The list of values to search for within a user-defined contact attribute.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
Values: string[] | undefined;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* <p>A structure that defines search criteria based on user-defined contact attributes that are configured for
|
|
202
|
+
* contact search.</p>
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
export interface SearchableContactAttributes {
|
|
206
|
+
/**
|
|
207
|
+
* <p>The list of criteria based on user-defined contact attributes that are configured for contact search.</p>
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
Criteria: SearchableContactAttributesCriteria[] | undefined;
|
|
211
|
+
/**
|
|
212
|
+
* <p>The match type combining search criteria using multiple searchable contact attributes.</p>
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
MatchType?: SearchContactsMatchType | undefined;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* <p>The search criteria based on searchable segment attribute key and values to search on.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
export interface SearchableSegmentAttributesCriteria {
|
|
222
|
+
/**
|
|
223
|
+
* <p>The key containing a searchable segment attribute.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
Key: string | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>The list of values to search for within a searchable segment attribute.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
Values: string[] | undefined;
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* <p>The search criteria based on searchable segment attributes of a contact</p>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
export interface SearchableSegmentAttributes {
|
|
238
|
+
/**
|
|
239
|
+
* <p>The list of criteria based on searchable segment attributes.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
Criteria: SearchableSegmentAttributesCriteria[] | undefined;
|
|
243
|
+
/**
|
|
244
|
+
* <p>The match type combining search criteria using multiple searchable segment attributes.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
MatchType?: SearchContactsMatchType | undefined;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* <p>A structure of search criteria to be used to return contacts.</p>
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export interface SearchCriteria {
|
|
254
|
+
/**
|
|
255
|
+
* <p>Name of the contact.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
Name?: NameCriteria | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The identifiers of agents who handled the contacts.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
AgentIds?: string[] | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The agent hierarchy groups of the agent at the time of handling the contact.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
AgentHierarchyGroups?: AgentHierarchyGroups | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The list of channels associated with contacts.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
Channels?: Channel[] | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>Search criteria based on analysis outputs from Connect Customer Contact Lens.</p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
ContactAnalysis?: ContactAnalysis | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* <p>The list of initiation methods associated with contacts.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
InitiationMethods?: ContactInitiationMethod[] | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <p>The list of queue IDs associated with contacts.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
QueueIds?: string[] | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>Routing criteria for the contact.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
RoutingCriteria?: SearchableRoutingCriteria | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>Additional TimeRange used to filter contacts.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
AdditionalTimeRange?: SearchContactsAdditionalTimeRange | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <p>The search criteria based on user-defined contact attributes that have been configured for contact search. For
|
|
301
|
+
* 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
|
|
302
|
+
* Guide</i>.</p>
|
|
303
|
+
* <important>
|
|
304
|
+
* <p>To use <code>SearchableContactAttributes</code> in a search request, the <code>GetContactAttributes</code>
|
|
305
|
+
* 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
|
|
306
|
+
* defined by Connect Customer.</p>
|
|
307
|
+
* </important>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
SearchableContactAttributes?: SearchableContactAttributes | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The search criteria based on searchable segment attributes of a contact.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* <p>The list of active regions for contacts in ACGR instances.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
ActiveRegions?: string[] | undefined;
|
|
321
|
+
/**
|
|
322
|
+
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
|
|
323
|
+
* <code>OR</code> of <code>AND</code> (List of List) input where:</p>
|
|
324
|
+
* <ul>
|
|
325
|
+
* <li>
|
|
326
|
+
* <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
|
|
327
|
+
* </li>
|
|
328
|
+
* <li>
|
|
329
|
+
* <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
|
|
330
|
+
* </li>
|
|
331
|
+
* </ul>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
ContactTags?: ControlPlaneTagFilter | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>AI Agent search criteria definitions.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
AiAgents?: AiAgentsCriteria | undefined;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* <p>A structure that defines the field name to sort by and a sort order.</p>
|
|
343
|
+
* @public
|
|
344
|
+
*/
|
|
345
|
+
export interface Sort {
|
|
346
|
+
/**
|
|
347
|
+
* <p>The name of the field on which to sort.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
FieldName: SortableFieldName | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* <p>An ascending or descending sort.</p>
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
Order: SortOrder | undefined;
|
|
356
|
+
}
|
|
5
357
|
/**
|
|
6
358
|
* @public
|
|
7
359
|
*/
|
|
@@ -426,6 +778,45 @@ export interface SearchHoursOfOperationsResponse {
|
|
|
426
778
|
*/
|
|
427
779
|
ApproximateTotalCount?: number | undefined;
|
|
428
780
|
}
|
|
781
|
+
/**
|
|
782
|
+
* <p>Filters to apply when searching for metrics.</p>
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
export interface MetricSearchFilter {
|
|
786
|
+
/**
|
|
787
|
+
* <p>An object that can be used to specify tag conditions inside the <code>SearchFilter</code>. This accepts an OR of AND (List of List) input where:</p>
|
|
788
|
+
* <ul>
|
|
789
|
+
* <li>
|
|
790
|
+
* <p>The top level list specifies conditions that need to be applied with OR operator.</p>
|
|
791
|
+
* </li>
|
|
792
|
+
* <li>
|
|
793
|
+
* <p>The inner list specifies conditions that need to be applied with AND operator.</p>
|
|
794
|
+
* </li>
|
|
795
|
+
* </ul>
|
|
796
|
+
* @public
|
|
797
|
+
*/
|
|
798
|
+
TagFilter?: ControlPlaneTagFilter | undefined;
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
*/
|
|
803
|
+
export interface SearchMetricsResponse {
|
|
804
|
+
/**
|
|
805
|
+
* <p>The metrics that matched the search criteria.</p>
|
|
806
|
+
* @public
|
|
807
|
+
*/
|
|
808
|
+
Metrics?: MetricDefinition[] | undefined;
|
|
809
|
+
/**
|
|
810
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
811
|
+
* @public
|
|
812
|
+
*/
|
|
813
|
+
NextToken?: string | undefined;
|
|
814
|
+
/**
|
|
815
|
+
* <p>The approximate total number of metrics that matched your search criteria.</p>
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
ApproximateTotalCount?: number | undefined;
|
|
819
|
+
}
|
|
429
820
|
/**
|
|
430
821
|
* <p>Filters to apply when searching for notifications.</p>
|
|
431
822
|
* @public
|
|
@@ -743,6 +1134,9 @@ export interface SearchResourceTagsRequest {
|
|
|
743
1134
|
* <li>
|
|
744
1135
|
* <p>transfer-destination (also known as quick connect)</p>
|
|
745
1136
|
* </li>
|
|
1137
|
+
* <li>
|
|
1138
|
+
* <p>metric</p>
|
|
1139
|
+
* </li>
|
|
746
1140
|
* </ul>
|
|
747
1141
|
* @public
|
|
748
1142
|
*/
|
|
@@ -4690,22 +5084,87 @@ export interface UpdateInstanceStorageConfigRequest {
|
|
|
4690
5084
|
/**
|
|
4691
5085
|
* @public
|
|
4692
5086
|
*/
|
|
4693
|
-
export interface
|
|
5087
|
+
export interface UpdateMetricContentRequest {
|
|
4694
5088
|
/**
|
|
4695
|
-
* <p>The identifier of the
|
|
5089
|
+
* <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>
|
|
4696
5090
|
* @public
|
|
4697
5091
|
*/
|
|
4698
5092
|
InstanceId: string | undefined;
|
|
4699
5093
|
/**
|
|
4700
|
-
* <p>The
|
|
5094
|
+
* <p>The identifier of the metric to update. Adding the <code>$SAVED</code> qualifier will update the saved version of the metric. Adding <code>$LATEST</code> or omitting a qualifier will update the published version.</p>
|
|
4701
5095
|
* @public
|
|
4702
5096
|
*/
|
|
4703
|
-
|
|
5097
|
+
MetricId: string | undefined;
|
|
4704
5098
|
/**
|
|
4705
|
-
* <p>The updated
|
|
5099
|
+
* <p>The updated calculation definition for the metric.</p>
|
|
4706
5100
|
* @public
|
|
4707
5101
|
*/
|
|
4708
|
-
|
|
5102
|
+
MetricCalculation?: MetricCalculation | undefined;
|
|
5103
|
+
/**
|
|
5104
|
+
* <p>The updated display unit for the metric.</p>
|
|
5105
|
+
* @public
|
|
5106
|
+
*/
|
|
5107
|
+
Unit?: MetricUnit | undefined;
|
|
5108
|
+
/**
|
|
5109
|
+
* <p>How an increase in the metric value should be interpreted. Valid values: <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>NEGATIVE</code>.</p>
|
|
5110
|
+
* @public
|
|
5111
|
+
*/
|
|
5112
|
+
PositiveTrendIndicator?: TrendIndicator | undefined;
|
|
5113
|
+
}
|
|
5114
|
+
/**
|
|
5115
|
+
* @public
|
|
5116
|
+
*/
|
|
5117
|
+
export interface UpdateMetricContentResponse {
|
|
5118
|
+
}
|
|
5119
|
+
/**
|
|
5120
|
+
* @public
|
|
5121
|
+
*/
|
|
5122
|
+
export interface UpdateMetricMetadataRequest {
|
|
5123
|
+
/**
|
|
5124
|
+
* <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>
|
|
5125
|
+
* @public
|
|
5126
|
+
*/
|
|
5127
|
+
InstanceId: string | undefined;
|
|
5128
|
+
/**
|
|
5129
|
+
* <p>The identifier of the metric to update. Adding the <code>$SAVED</code> qualifier will update the saved version of the metric. Adding <code>$LATEST</code> or omitting a qualifier will update the published version.</p>
|
|
5130
|
+
* @public
|
|
5131
|
+
*/
|
|
5132
|
+
MetricId: string | undefined;
|
|
5133
|
+
/**
|
|
5134
|
+
* <p>The updated name of the metric.</p>
|
|
5135
|
+
* @public
|
|
5136
|
+
*/
|
|
5137
|
+
Name?: string | undefined;
|
|
5138
|
+
/**
|
|
5139
|
+
* <p>The updated description of the metric.</p>
|
|
5140
|
+
* @public
|
|
5141
|
+
*/
|
|
5142
|
+
Description?: string | undefined;
|
|
5143
|
+
}
|
|
5144
|
+
/**
|
|
5145
|
+
* @public
|
|
5146
|
+
*/
|
|
5147
|
+
export interface UpdateMetricMetadataResponse {
|
|
5148
|
+
}
|
|
5149
|
+
/**
|
|
5150
|
+
* @public
|
|
5151
|
+
*/
|
|
5152
|
+
export interface UpdateNotificationContentRequest {
|
|
5153
|
+
/**
|
|
5154
|
+
* <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>
|
|
5155
|
+
* @public
|
|
5156
|
+
*/
|
|
5157
|
+
InstanceId: string | undefined;
|
|
5158
|
+
/**
|
|
5159
|
+
* <p>The unique identifier for the notification to update.</p>
|
|
5160
|
+
* @public
|
|
5161
|
+
*/
|
|
5162
|
+
NotificationId: string | undefined;
|
|
5163
|
+
/**
|
|
5164
|
+
* <p>The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.</p>
|
|
5165
|
+
* @public
|
|
5166
|
+
*/
|
|
5167
|
+
Content: Partial<Record<LocaleCode, string>> | undefined;
|
|
4709
5168
|
}
|
|
4710
5169
|
/**
|
|
4711
5170
|
* <p>The response from updating notification content.</p>
|
|
@@ -6439,656 +6898,3 @@ export interface EvaluationSearchCriteria {
|
|
|
6439
6898
|
*/
|
|
6440
6899
|
DecimalCondition?: DecimalCondition | undefined;
|
|
6441
6900
|
}
|
|
6442
|
-
/**
|
|
6443
|
-
* <p>A tagged union to specify expression for a routing step.</p>
|
|
6444
|
-
* @public
|
|
6445
|
-
*/
|
|
6446
|
-
export interface Expression {
|
|
6447
|
-
/**
|
|
6448
|
-
* <p>An object to specify the predefined attribute condition.</p>
|
|
6449
|
-
* @public
|
|
6450
|
-
*/
|
|
6451
|
-
AttributeCondition?: AttributeCondition | undefined;
|
|
6452
|
-
/**
|
|
6453
|
-
* <p>List of routing expressions which will be AND-ed together.</p>
|
|
6454
|
-
* @public
|
|
6455
|
-
*/
|
|
6456
|
-
AndExpression?: Expression[] | undefined;
|
|
6457
|
-
/**
|
|
6458
|
-
* <p>List of routing expressions which will be OR-ed together.</p>
|
|
6459
|
-
* @public
|
|
6460
|
-
*/
|
|
6461
|
-
OrExpression?: Expression[] | undefined;
|
|
6462
|
-
/**
|
|
6463
|
-
* <p>An object to specify the predefined attribute condition.</p>
|
|
6464
|
-
* @public
|
|
6465
|
-
*/
|
|
6466
|
-
NotAttributeCondition?: AttributeCondition | undefined;
|
|
6467
|
-
}
|
|
6468
|
-
/**
|
|
6469
|
-
* <p>The search criteria to be used to return hours of operations overrides.</p>
|
|
6470
|
-
* @public
|
|
6471
|
-
*/
|
|
6472
|
-
export interface HoursOfOperationOverrideSearchCriteria {
|
|
6473
|
-
/**
|
|
6474
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6475
|
-
* @public
|
|
6476
|
-
*/
|
|
6477
|
-
OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
6478
|
-
/**
|
|
6479
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6480
|
-
* @public
|
|
6481
|
-
*/
|
|
6482
|
-
AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined;
|
|
6483
|
-
/**
|
|
6484
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6485
|
-
* @public
|
|
6486
|
-
*/
|
|
6487
|
-
StringCondition?: StringCondition | undefined;
|
|
6488
|
-
/**
|
|
6489
|
-
* <p>A leaf node condition which can be used to specify a date condition.</p>
|
|
6490
|
-
* @public
|
|
6491
|
-
*/
|
|
6492
|
-
DateCondition?: DateCondition | undefined;
|
|
6493
|
-
}
|
|
6494
|
-
/**
|
|
6495
|
-
* <p>The search criteria to be used to return hours of operations.</p>
|
|
6496
|
-
* @public
|
|
6497
|
-
*/
|
|
6498
|
-
export interface HoursOfOperationSearchCriteria {
|
|
6499
|
-
/**
|
|
6500
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6501
|
-
* @public
|
|
6502
|
-
*/
|
|
6503
|
-
OrConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
6504
|
-
/**
|
|
6505
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6506
|
-
* @public
|
|
6507
|
-
*/
|
|
6508
|
-
AndConditions?: HoursOfOperationSearchCriteria[] | undefined;
|
|
6509
|
-
/**
|
|
6510
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6511
|
-
* <note>
|
|
6512
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>,
|
|
6513
|
-
* <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
6514
|
-
* </note>
|
|
6515
|
-
* @public
|
|
6516
|
-
*/
|
|
6517
|
-
StringCondition?: StringCondition | undefined;
|
|
6518
|
-
}
|
|
6519
|
-
/**
|
|
6520
|
-
* <p>The search criteria to be used to return notifications.</p>
|
|
6521
|
-
* @public
|
|
6522
|
-
*/
|
|
6523
|
-
export interface NotificationSearchCriteria {
|
|
6524
|
-
/**
|
|
6525
|
-
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
6526
|
-
* @public
|
|
6527
|
-
*/
|
|
6528
|
-
OrConditions?: NotificationSearchCriteria[] | undefined;
|
|
6529
|
-
/**
|
|
6530
|
-
* <p>A list of conditions that must all be satisfied.</p>
|
|
6531
|
-
* @public
|
|
6532
|
-
*/
|
|
6533
|
-
AndConditions?: NotificationSearchCriteria[] | undefined;
|
|
6534
|
-
/**
|
|
6535
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6536
|
-
* @public
|
|
6537
|
-
*/
|
|
6538
|
-
StringCondition?: StringCondition | undefined;
|
|
6539
|
-
}
|
|
6540
|
-
/**
|
|
6541
|
-
* <p>The search criteria to be used to return predefined attributes.</p>
|
|
6542
|
-
* @public
|
|
6543
|
-
*/
|
|
6544
|
-
export interface PredefinedAttributeSearchCriteria {
|
|
6545
|
-
/**
|
|
6546
|
-
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
6547
|
-
* @public
|
|
6548
|
-
*/
|
|
6549
|
-
OrConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
6550
|
-
/**
|
|
6551
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
6552
|
-
* @public
|
|
6553
|
-
*/
|
|
6554
|
-
AndConditions?: PredefinedAttributeSearchCriteria[] | undefined;
|
|
6555
|
-
/**
|
|
6556
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6557
|
-
* @public
|
|
6558
|
-
*/
|
|
6559
|
-
StringCondition?: StringCondition | undefined;
|
|
6560
|
-
}
|
|
6561
|
-
/**
|
|
6562
|
-
* <p>The search criteria to be used to return prompts.</p>
|
|
6563
|
-
* @public
|
|
6564
|
-
*/
|
|
6565
|
-
export interface PromptSearchCriteria {
|
|
6566
|
-
/**
|
|
6567
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6568
|
-
* @public
|
|
6569
|
-
*/
|
|
6570
|
-
OrConditions?: PromptSearchCriteria[] | undefined;
|
|
6571
|
-
/**
|
|
6572
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6573
|
-
* @public
|
|
6574
|
-
*/
|
|
6575
|
-
AndConditions?: PromptSearchCriteria[] | undefined;
|
|
6576
|
-
/**
|
|
6577
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6578
|
-
* <note>
|
|
6579
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
6580
|
-
* <code>resourceID</code>.</p>
|
|
6581
|
-
* </note>
|
|
6582
|
-
* @public
|
|
6583
|
-
*/
|
|
6584
|
-
StringCondition?: StringCondition | undefined;
|
|
6585
|
-
}
|
|
6586
|
-
/**
|
|
6587
|
-
* <p>The search criteria to be used to return queues.</p>
|
|
6588
|
-
* <note>
|
|
6589
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
6590
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
6591
|
-
* outside of this range will throw invalid results. </p>
|
|
6592
|
-
* </note>
|
|
6593
|
-
* @public
|
|
6594
|
-
*/
|
|
6595
|
-
export interface QueueSearchCriteria {
|
|
6596
|
-
/**
|
|
6597
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6598
|
-
* @public
|
|
6599
|
-
*/
|
|
6600
|
-
OrConditions?: QueueSearchCriteria[] | undefined;
|
|
6601
|
-
/**
|
|
6602
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6603
|
-
* @public
|
|
6604
|
-
*/
|
|
6605
|
-
AndConditions?: QueueSearchCriteria[] | undefined;
|
|
6606
|
-
/**
|
|
6607
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6608
|
-
* <note>
|
|
6609
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
6610
|
-
* <code>resourceID</code>.</p>
|
|
6611
|
-
* </note>
|
|
6612
|
-
* @public
|
|
6613
|
-
*/
|
|
6614
|
-
StringCondition?: StringCondition | undefined;
|
|
6615
|
-
/**
|
|
6616
|
-
* <p>The type of queue.</p>
|
|
6617
|
-
* @public
|
|
6618
|
-
*/
|
|
6619
|
-
QueueTypeCondition?: SearchableQueueType | undefined;
|
|
6620
|
-
}
|
|
6621
|
-
/**
|
|
6622
|
-
* <p>The search criteria to be used to return quick connects.</p>
|
|
6623
|
-
* @public
|
|
6624
|
-
*/
|
|
6625
|
-
export interface QuickConnectSearchCriteria {
|
|
6626
|
-
/**
|
|
6627
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6628
|
-
* @public
|
|
6629
|
-
*/
|
|
6630
|
-
OrConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
6631
|
-
/**
|
|
6632
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6633
|
-
* @public
|
|
6634
|
-
*/
|
|
6635
|
-
AndConditions?: QuickConnectSearchCriteria[] | undefined;
|
|
6636
|
-
/**
|
|
6637
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6638
|
-
* <note>
|
|
6639
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>description</code>, and
|
|
6640
|
-
* <code>resourceID</code>.</p>
|
|
6641
|
-
* </note>
|
|
6642
|
-
* @public
|
|
6643
|
-
*/
|
|
6644
|
-
StringCondition?: StringCondition | undefined;
|
|
6645
|
-
}
|
|
6646
|
-
/**
|
|
6647
|
-
* <p>The search criteria to be used to return routing profiles.</p>
|
|
6648
|
-
* <note>
|
|
6649
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
6650
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
6651
|
-
* outside of this range will throw invalid results. </p>
|
|
6652
|
-
* </note>
|
|
6653
|
-
* @public
|
|
6654
|
-
*/
|
|
6655
|
-
export interface RoutingProfileSearchCriteria {
|
|
6656
|
-
/**
|
|
6657
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6658
|
-
* @public
|
|
6659
|
-
*/
|
|
6660
|
-
OrConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
6661
|
-
/**
|
|
6662
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6663
|
-
* @public
|
|
6664
|
-
*/
|
|
6665
|
-
AndConditions?: RoutingProfileSearchCriteria[] | undefined;
|
|
6666
|
-
/**
|
|
6667
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6668
|
-
* <note>
|
|
6669
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>associatedQueueIds</code>,
|
|
6670
|
-
* <code>name</code>, <code>description</code>, and <code>resourceID</code>.</p>
|
|
6671
|
-
* </note>
|
|
6672
|
-
* @public
|
|
6673
|
-
*/
|
|
6674
|
-
StringCondition?: StringCondition | undefined;
|
|
6675
|
-
}
|
|
6676
|
-
/**
|
|
6677
|
-
* <p>The search criteria to be used to return rules.</p>
|
|
6678
|
-
* @public
|
|
6679
|
-
*/
|
|
6680
|
-
export interface RulesSearchCriteria {
|
|
6681
|
-
/**
|
|
6682
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6683
|
-
* @public
|
|
6684
|
-
*/
|
|
6685
|
-
OrConditions?: RulesSearchCriteria[] | undefined;
|
|
6686
|
-
/**
|
|
6687
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6688
|
-
* @public
|
|
6689
|
-
*/
|
|
6690
|
-
AndConditions?: RulesSearchCriteria[] | undefined;
|
|
6691
|
-
/**
|
|
6692
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6693
|
-
* <note>
|
|
6694
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>Name</code>,
|
|
6695
|
-
* <code>PublishStatus</code>, <code>EventSourceName</code>, <code>RuleId</code>,
|
|
6696
|
-
* <code>IntegrationAssociationId</code>, <code>ActionSummaries</code>, and
|
|
6697
|
-
* <code>RuleCapabilityTiers</code>.</p>
|
|
6698
|
-
* </note>
|
|
6699
|
-
* @public
|
|
6700
|
-
*/
|
|
6701
|
-
StringCondition?: StringCondition | undefined;
|
|
6702
|
-
}
|
|
6703
|
-
/**
|
|
6704
|
-
* <p>The search criteria to be used to return security profiles.</p>
|
|
6705
|
-
* <note>
|
|
6706
|
-
* <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and maximum of 25
|
|
6707
|
-
* characters. Any queries with character lengths outside of this range will throw invalid
|
|
6708
|
-
* results.</p>
|
|
6709
|
-
* </note>
|
|
6710
|
-
* @public
|
|
6711
|
-
*/
|
|
6712
|
-
export interface SecurityProfileSearchCriteria {
|
|
6713
|
-
/**
|
|
6714
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6715
|
-
* @public
|
|
6716
|
-
*/
|
|
6717
|
-
OrConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
6718
|
-
/**
|
|
6719
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6720
|
-
* @public
|
|
6721
|
-
*/
|
|
6722
|
-
AndConditions?: SecurityProfileSearchCriteria[] | undefined;
|
|
6723
|
-
/**
|
|
6724
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6725
|
-
* @public
|
|
6726
|
-
*/
|
|
6727
|
-
StringCondition?: StringCondition | undefined;
|
|
6728
|
-
}
|
|
6729
|
-
/**
|
|
6730
|
-
* <p>A value for a segment attribute. This is structured as a map where the key is <code>valueString</code> and the
|
|
6731
|
-
* value is a string.</p>
|
|
6732
|
-
* @public
|
|
6733
|
-
*/
|
|
6734
|
-
export interface SegmentAttributeValue {
|
|
6735
|
-
/**
|
|
6736
|
-
* <p>The value of a segment attribute.</p>
|
|
6737
|
-
* @public
|
|
6738
|
-
*/
|
|
6739
|
-
ValueString?: string | undefined;
|
|
6740
|
-
/**
|
|
6741
|
-
* <p>The value of a segment attribute.</p>
|
|
6742
|
-
* @public
|
|
6743
|
-
*/
|
|
6744
|
-
ValueMap?: Record<string, SegmentAttributeValue> | undefined;
|
|
6745
|
-
/**
|
|
6746
|
-
* <p>The value of a segment attribute.</p>
|
|
6747
|
-
* @public
|
|
6748
|
-
*/
|
|
6749
|
-
ValueInteger?: number | undefined;
|
|
6750
|
-
/**
|
|
6751
|
-
* <p>The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined
|
|
6752
|
-
* attributes.</p>
|
|
6753
|
-
* @public
|
|
6754
|
-
*/
|
|
6755
|
-
ValueList?: SegmentAttributeValue[] | undefined;
|
|
6756
|
-
/**
|
|
6757
|
-
* <p>The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined
|
|
6758
|
-
* attributes, not for user-defined attributes.</p>
|
|
6759
|
-
* @public
|
|
6760
|
-
*/
|
|
6761
|
-
ValueArn?: string | undefined;
|
|
6762
|
-
}
|
|
6763
|
-
/**
|
|
6764
|
-
* <p>The search criteria to be used to return test cases.</p>
|
|
6765
|
-
* @public
|
|
6766
|
-
*/
|
|
6767
|
-
export interface TestCaseSearchCriteria {
|
|
6768
|
-
/**
|
|
6769
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6770
|
-
* @public
|
|
6771
|
-
*/
|
|
6772
|
-
OrConditions?: TestCaseSearchCriteria[] | undefined;
|
|
6773
|
-
/**
|
|
6774
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6775
|
-
* @public
|
|
6776
|
-
*/
|
|
6777
|
-
AndConditions?: TestCaseSearchCriteria[] | undefined;
|
|
6778
|
-
/**
|
|
6779
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6780
|
-
* @public
|
|
6781
|
-
*/
|
|
6782
|
-
StringCondition?: StringCondition | undefined;
|
|
6783
|
-
/**
|
|
6784
|
-
* <p>The status of the test case.</p>
|
|
6785
|
-
* @public
|
|
6786
|
-
*/
|
|
6787
|
-
StatusCondition?: TestCaseStatus | undefined;
|
|
6788
|
-
}
|
|
6789
|
-
/**
|
|
6790
|
-
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
6791
|
-
* @public
|
|
6792
|
-
*/
|
|
6793
|
-
export interface UserHierarchyGroupSearchCriteria {
|
|
6794
|
-
/**
|
|
6795
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6796
|
-
* @public
|
|
6797
|
-
*/
|
|
6798
|
-
OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
6799
|
-
/**
|
|
6800
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6801
|
-
* @public
|
|
6802
|
-
*/
|
|
6803
|
-
AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined;
|
|
6804
|
-
/**
|
|
6805
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6806
|
-
* <note>
|
|
6807
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>, <code>parentId</code>,
|
|
6808
|
-
* <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
6809
|
-
* </note>
|
|
6810
|
-
* @public
|
|
6811
|
-
*/
|
|
6812
|
-
StringCondition?: StringCondition | undefined;
|
|
6813
|
-
}
|
|
6814
|
-
/**
|
|
6815
|
-
* <p>The search criteria to be used to return users.</p>
|
|
6816
|
-
* <note>
|
|
6817
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
6818
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
6819
|
-
* outside of this range will throw invalid results. </p>
|
|
6820
|
-
* </note>
|
|
6821
|
-
* @public
|
|
6822
|
-
*/
|
|
6823
|
-
export interface UserSearchCriteria {
|
|
6824
|
-
/**
|
|
6825
|
-
* <p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>
|
|
6826
|
-
* @public
|
|
6827
|
-
*/
|
|
6828
|
-
OrConditions?: UserSearchCriteria[] | undefined;
|
|
6829
|
-
/**
|
|
6830
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>
|
|
6831
|
-
* @public
|
|
6832
|
-
*/
|
|
6833
|
-
AndConditions?: UserSearchCriteria[] | undefined;
|
|
6834
|
-
/**
|
|
6835
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6836
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>Username</code>, <code>FirstName</code>,
|
|
6837
|
-
* <code>LastName</code>, <code>RoutingProfileId</code>, <code>SecurityProfileId</code>,
|
|
6838
|
-
* <code>resourceId</code>.</p>
|
|
6839
|
-
* @public
|
|
6840
|
-
*/
|
|
6841
|
-
StringCondition?: StringCondition | undefined;
|
|
6842
|
-
/**
|
|
6843
|
-
* <p>A leaf node condition which can be used to specify a List condition to search users with attributes included in
|
|
6844
|
-
* Lists like Proficiencies.</p>
|
|
6845
|
-
* @public
|
|
6846
|
-
*/
|
|
6847
|
-
ListCondition?: ListCondition | undefined;
|
|
6848
|
-
/**
|
|
6849
|
-
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
6850
|
-
* @public
|
|
6851
|
-
*/
|
|
6852
|
-
HierarchyGroupCondition?: HierarchyGroupCondition | undefined;
|
|
6853
|
-
}
|
|
6854
|
-
/**
|
|
6855
|
-
* <p>Defines the search criteria for filtering views.</p>
|
|
6856
|
-
* @public
|
|
6857
|
-
*/
|
|
6858
|
-
export interface ViewSearchCriteria {
|
|
6859
|
-
/**
|
|
6860
|
-
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
6861
|
-
* @public
|
|
6862
|
-
*/
|
|
6863
|
-
OrConditions?: ViewSearchCriteria[] | undefined;
|
|
6864
|
-
/**
|
|
6865
|
-
* <p>A list of conditions that must all be satisfied.</p>
|
|
6866
|
-
* @public
|
|
6867
|
-
*/
|
|
6868
|
-
AndConditions?: ViewSearchCriteria[] | undefined;
|
|
6869
|
-
/**
|
|
6870
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6871
|
-
* @public
|
|
6872
|
-
*/
|
|
6873
|
-
StringCondition?: StringCondition | undefined;
|
|
6874
|
-
/**
|
|
6875
|
-
* <p>A condition that filters views by their type.</p>
|
|
6876
|
-
* @public
|
|
6877
|
-
*/
|
|
6878
|
-
ViewTypeCondition?: ViewType | undefined;
|
|
6879
|
-
/**
|
|
6880
|
-
* <p>A condition that filters views by their status.</p>
|
|
6881
|
-
* @public
|
|
6882
|
-
*/
|
|
6883
|
-
ViewStatusCondition?: ViewStatus | undefined;
|
|
6884
|
-
}
|
|
6885
|
-
/**
|
|
6886
|
-
* <p>Defines the search criteria for filtering workspace associations.</p>
|
|
6887
|
-
* @public
|
|
6888
|
-
*/
|
|
6889
|
-
export interface WorkspaceAssociationSearchCriteria {
|
|
6890
|
-
/**
|
|
6891
|
-
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
6892
|
-
* @public
|
|
6893
|
-
*/
|
|
6894
|
-
OrConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
6895
|
-
/**
|
|
6896
|
-
* <p>A list of conditions that must all be satisfied.</p>
|
|
6897
|
-
* @public
|
|
6898
|
-
*/
|
|
6899
|
-
AndConditions?: WorkspaceAssociationSearchCriteria[] | undefined;
|
|
6900
|
-
/**
|
|
6901
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6902
|
-
* @public
|
|
6903
|
-
*/
|
|
6904
|
-
StringCondition?: StringCondition | undefined;
|
|
6905
|
-
}
|
|
6906
|
-
/**
|
|
6907
|
-
* <p>Defines the search criteria for filtering workspaces.</p>
|
|
6908
|
-
* @public
|
|
6909
|
-
*/
|
|
6910
|
-
export interface WorkspaceSearchCriteria {
|
|
6911
|
-
/**
|
|
6912
|
-
* <p>A list of conditions to be met, where at least one condition must be satisfied.</p>
|
|
6913
|
-
* @public
|
|
6914
|
-
*/
|
|
6915
|
-
OrConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
6916
|
-
/**
|
|
6917
|
-
* <p>A list of conditions that must all be satisfied.</p>
|
|
6918
|
-
* @public
|
|
6919
|
-
*/
|
|
6920
|
-
AndConditions?: WorkspaceSearchCriteria[] | undefined;
|
|
6921
|
-
/**
|
|
6922
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6923
|
-
* @public
|
|
6924
|
-
*/
|
|
6925
|
-
StringCondition?: StringCondition | undefined;
|
|
6926
|
-
}
|
|
6927
|
-
/**
|
|
6928
|
-
* <p>Information about a question from an evaluation form.</p>
|
|
6929
|
-
* @public
|
|
6930
|
-
*/
|
|
6931
|
-
export interface EvaluationFormQuestion {
|
|
6932
|
-
/**
|
|
6933
|
-
* <p>The title of the question.</p>
|
|
6934
|
-
* @public
|
|
6935
|
-
*/
|
|
6936
|
-
Title: string | undefined;
|
|
6937
|
-
/**
|
|
6938
|
-
* <p>The instructions of the section.</p>
|
|
6939
|
-
* @public
|
|
6940
|
-
*/
|
|
6941
|
-
Instructions?: string | undefined;
|
|
6942
|
-
/**
|
|
6943
|
-
* <p>The identifier of the question. An identifier must be unique within the evaluation form.</p>
|
|
6944
|
-
* @public
|
|
6945
|
-
*/
|
|
6946
|
-
RefId: string | undefined;
|
|
6947
|
-
/**
|
|
6948
|
-
* <p>The flag to enable not applicable answers to the question.</p>
|
|
6949
|
-
* @public
|
|
6950
|
-
*/
|
|
6951
|
-
NotApplicableEnabled?: boolean | undefined;
|
|
6952
|
-
/**
|
|
6953
|
-
* <p>The type of the question.</p>
|
|
6954
|
-
* @public
|
|
6955
|
-
*/
|
|
6956
|
-
QuestionType: EvaluationFormQuestionType | undefined;
|
|
6957
|
-
/**
|
|
6958
|
-
* <p>The properties of the type of question. Text questions do not have to define question type properties.</p>
|
|
6959
|
-
* @public
|
|
6960
|
-
*/
|
|
6961
|
-
QuestionTypeProperties?: EvaluationFormQuestionTypeProperties | undefined;
|
|
6962
|
-
/**
|
|
6963
|
-
* <p>A question conditional enablement.</p>
|
|
6964
|
-
* @public
|
|
6965
|
-
*/
|
|
6966
|
-
Enablement?: EvaluationFormItemEnablementConfiguration | undefined;
|
|
6967
|
-
/**
|
|
6968
|
-
* <p>The scoring weight of the section.</p>
|
|
6969
|
-
* @public
|
|
6970
|
-
*/
|
|
6971
|
-
Weight?: number | undefined;
|
|
6972
|
-
/**
|
|
6973
|
-
* <p>The scoring configuration of the question.</p>
|
|
6974
|
-
* @public
|
|
6975
|
-
*/
|
|
6976
|
-
ScoringConfiguration?: EvaluationFormQuestionScoringConfiguration | undefined;
|
|
6977
|
-
}
|
|
6978
|
-
/**
|
|
6979
|
-
* <p>Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel,
|
|
6980
|
-
* Name, or Value.</p>
|
|
6981
|
-
* @public
|
|
6982
|
-
*/
|
|
6983
|
-
export interface RoutingCriteriaInputStep {
|
|
6984
|
-
/**
|
|
6985
|
-
* <p>An object to specify the expiration of a routing step.</p>
|
|
6986
|
-
* @public
|
|
6987
|
-
*/
|
|
6988
|
-
Expiry?: RoutingCriteriaInputStepExpiry | undefined;
|
|
6989
|
-
/**
|
|
6990
|
-
* <p>A tagged union to specify expression for a routing step.</p>
|
|
6991
|
-
* @public
|
|
6992
|
-
*/
|
|
6993
|
-
Expression?: Expression | undefined;
|
|
6994
|
-
}
|
|
6995
|
-
/**
|
|
6996
|
-
* @public
|
|
6997
|
-
*/
|
|
6998
|
-
export interface SearchAgentStatusesRequest {
|
|
6999
|
-
/**
|
|
7000
|
-
* <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
|
|
7001
|
-
* instance.</p>
|
|
7002
|
-
* @public
|
|
7003
|
-
*/
|
|
7004
|
-
InstanceId: string | undefined;
|
|
7005
|
-
/**
|
|
7006
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
7007
|
-
* retrieve the next set of results.</p>
|
|
7008
|
-
* @public
|
|
7009
|
-
*/
|
|
7010
|
-
NextToken?: string | undefined;
|
|
7011
|
-
/**
|
|
7012
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7013
|
-
* @public
|
|
7014
|
-
*/
|
|
7015
|
-
MaxResults?: number | undefined;
|
|
7016
|
-
/**
|
|
7017
|
-
* <p>Filters to be applied to search results.</p>
|
|
7018
|
-
* @public
|
|
7019
|
-
*/
|
|
7020
|
-
SearchFilter?: AgentStatusSearchFilter | undefined;
|
|
7021
|
-
/**
|
|
7022
|
-
* <p>The search criteria to be used to return agent statuses.</p>
|
|
7023
|
-
* @public
|
|
7024
|
-
*/
|
|
7025
|
-
SearchCriteria?: AgentStatusSearchCriteria | undefined;
|
|
7026
|
-
}
|
|
7027
|
-
/**
|
|
7028
|
-
* @public
|
|
7029
|
-
*/
|
|
7030
|
-
export interface SearchContactEvaluationsRequest {
|
|
7031
|
-
/**
|
|
7032
|
-
* <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>
|
|
7033
|
-
* @public
|
|
7034
|
-
*/
|
|
7035
|
-
InstanceId: string | undefined;
|
|
7036
|
-
/**
|
|
7037
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
7038
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
7039
|
-
* @public
|
|
7040
|
-
*/
|
|
7041
|
-
NextToken?: string | undefined;
|
|
7042
|
-
/**
|
|
7043
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7044
|
-
* @public
|
|
7045
|
-
*/
|
|
7046
|
-
MaxResults?: number | undefined;
|
|
7047
|
-
/**
|
|
7048
|
-
* <p>The search criteria to be used to return contact evaluations.</p>
|
|
7049
|
-
* @public
|
|
7050
|
-
*/
|
|
7051
|
-
SearchCriteria?: EvaluationSearchCriteria | undefined;
|
|
7052
|
-
/**
|
|
7053
|
-
* <p>Filters to be applied to search results.</p>
|
|
7054
|
-
* @public
|
|
7055
|
-
*/
|
|
7056
|
-
SearchFilter?: EvaluationSearchFilter | undefined;
|
|
7057
|
-
}
|
|
7058
|
-
/**
|
|
7059
|
-
* @public
|
|
7060
|
-
*/
|
|
7061
|
-
export interface SearchContactFlowModulesRequest {
|
|
7062
|
-
/**
|
|
7063
|
-
* <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name
|
|
7064
|
-
* (ARN) of the instance.</p>
|
|
7065
|
-
* @public
|
|
7066
|
-
*/
|
|
7067
|
-
InstanceId: string | undefined;
|
|
7068
|
-
/**
|
|
7069
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to
|
|
7070
|
-
* retrieve the next set of results.</p>
|
|
7071
|
-
* @public
|
|
7072
|
-
*/
|
|
7073
|
-
NextToken?: string | undefined;
|
|
7074
|
-
/**
|
|
7075
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7076
|
-
* @public
|
|
7077
|
-
*/
|
|
7078
|
-
MaxResults?: number | undefined;
|
|
7079
|
-
/**
|
|
7080
|
-
* <p>Filters to be applied to search results.</p>
|
|
7081
|
-
* @public
|
|
7082
|
-
*/
|
|
7083
|
-
SearchFilter?: ContactFlowModuleSearchFilter | undefined;
|
|
7084
|
-
/**
|
|
7085
|
-
* <p>The search criteria to be used to return flow modules.</p>
|
|
7086
|
-
* <note>
|
|
7087
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a minimum of 2
|
|
7088
|
-
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
|
|
7089
|
-
* invalid results.</p>
|
|
7090
|
-
* </note>
|
|
7091
|
-
* @public
|
|
7092
|
-
*/
|
|
7093
|
-
SearchCriteria?: ContactFlowModuleSearchCriteria | undefined;
|
|
7094
|
-
}
|