@aws-sdk/client-connect 3.614.0 → 3.618.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 +17 -2
- package/dist-cjs/index.js +227 -31
- package/dist-es/Connect.js +4 -0
- package/dist-es/ConnectClient.js +5 -5
- package/dist-es/commands/SearchAgentStatusesCommand.js +24 -0
- package/dist-es/commands/SearchUserHierarchyGroupsCommand.js +24 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +5 -18
- package/dist-es/models/models_1.js +32 -0
- package/dist-es/models/models_2.js +12 -5
- package/dist-es/pagination/SearchAgentStatusesPaginator.js +4 -0
- package/dist-es/pagination/SearchUserHierarchyGroupsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +118 -2
- package/dist-types/Connect.d.ts +16 -3
- package/dist-types/ConnectClient.d.ts +8 -7
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +6 -1
- package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
- package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListUseCasesCommand.d.ts +1 -1
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +142 -0
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +181 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +32 -4
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +2 -3
- package/dist-types/models/models_0.d.ts +128 -133
- package/dist-types/models/models_1.d.ts +335 -241
- package/dist-types/models/models_2.d.ts +537 -73
- package/dist-types/pagination/SearchAgentStatusesPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchUserHierarchyGroupsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/Connect.d.ts +34 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +14 -2
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUseCasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +27 -60
- package/dist-types/ts3.4/models/models_1.d.ts +100 -46
- package/dist-types/ts3.4/models/models_2.d.ts +125 -20
- package/dist-types/ts3.4/pagination/SearchAgentStatusesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchUserHierarchyGroupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +17 -17
|
@@ -1,7 +1,229 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentInfo, AgentStatusState, AllowedCapabilities, AnsweringMachineDetectionStatus, Application, AttributeCondition, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, CreatedByInfo, Customer, CustomerVoiceActivity, DisconnectDetails,
|
|
4
|
-
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig } from "./models_1";
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentInfo, AgentStatus, AgentStatusSearchFilter, AgentStatusState, AllowedCapabilities, AnsweringMachineDetectionStatus, Application, AttributeCondition, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, Customer, CustomerVoiceActivity, DisconnectDetails, EvaluationFormQuestion, EvaluationFormScoringStrategy, Expiry, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QualityMetrics, QueueInfo, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RoutingCriteriaStepStatus, RoutingProfile, SegmentAttributeValue, SignInConfig, SortOrder, TelephonyConfig, TrafficDistributionGroupStatus, WisdomInfo } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ListTrafficDistributionGroupsRequest {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The maximum number of results to return per page.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
MaxResults?: number;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
16
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
NextToken?: string;
|
|
20
|
+
/**
|
|
21
|
+
* <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>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
InstanceId?: string;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* <p>Information about traffic distribution groups.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
export interface TrafficDistributionGroupSummary {
|
|
31
|
+
/**
|
|
32
|
+
* <p>The identifier of the traffic distribution group.
|
|
33
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
34
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
Id?: string;
|
|
38
|
+
/**
|
|
39
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
Arn?: string;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The name of the traffic distribution group.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
Name?: string;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
InstanceArn?: string;
|
|
53
|
+
/**
|
|
54
|
+
* <p>The status of the traffic distribution group. </p>
|
|
55
|
+
* <ul>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>
|
|
58
|
+
* <code>CREATION_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
59
|
+
* completed.</p>
|
|
60
|
+
* </li>
|
|
61
|
+
* <li>
|
|
62
|
+
* <p>
|
|
63
|
+
* <code>ACTIVE</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has succeeded.</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>CREATION_FAILED</code> indicates that the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html">CreateTrafficDistributionGroup</a> operation has failed.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>
|
|
71
|
+
* <code>PENDING_DELETION</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
72
|
+
* completed.</p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>
|
|
76
|
+
* <code>DELETION_FAILED</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html">DeleteTrafficDistributionGroup</a> operation has failed.</p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>
|
|
80
|
+
* <code>UPDATE_IN_PROGRESS</code> means the previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html">UpdateTrafficDistributionGroup</a> operation is still in progress and has not yet
|
|
81
|
+
* completed.</p>
|
|
82
|
+
* </li>
|
|
83
|
+
* </ul>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
Status?: TrafficDistributionGroupStatus;
|
|
87
|
+
/**
|
|
88
|
+
* <p>Whether this is the default traffic distribution group created during instance
|
|
89
|
+
* replication. The default traffic distribution group cannot be deleted by the
|
|
90
|
+
* <code>DeleteTrafficDistributionGroup</code> API. The default traffic distribution group is deleted as
|
|
91
|
+
* part of the process for deleting a replica.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
IsDefault?: boolean;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export interface ListTrafficDistributionGroupsResponse {
|
|
100
|
+
/**
|
|
101
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
NextToken?: string;
|
|
105
|
+
/**
|
|
106
|
+
* <p>A list of traffic distribution groups.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[];
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export interface ListTrafficDistributionGroupUsersRequest {
|
|
115
|
+
/**
|
|
116
|
+
* <p>The identifier of the traffic distribution group.
|
|
117
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
118
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
TrafficDistributionGroupId: string | undefined;
|
|
122
|
+
/**
|
|
123
|
+
* <p>The maximum number of results to return per page.</p>
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
MaxResults?: number;
|
|
127
|
+
/**
|
|
128
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
129
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
NextToken?: string;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* <p>Summary information about a traffic distribution group user.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export interface TrafficDistributionGroupUserSummary {
|
|
139
|
+
/**
|
|
140
|
+
* <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
UserId?: string;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
export interface ListTrafficDistributionGroupUsersResponse {
|
|
149
|
+
/**
|
|
150
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
NextToken?: string;
|
|
154
|
+
/**
|
|
155
|
+
* <p>A list of traffic distribution group users.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[];
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* <p>Provides summary information about the use cases for the specified integration
|
|
162
|
+
* association.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export interface ListUseCasesRequest {
|
|
166
|
+
/**
|
|
167
|
+
* <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>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
InstanceId: string | undefined;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The identifier for the integration association.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
IntegrationAssociationId: string | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
178
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
NextToken?: string;
|
|
182
|
+
/**
|
|
183
|
+
* <p>The maximum number of results to return per page.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
MaxResults?: number;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* <p>Contains the
|
|
190
|
+
* use
|
|
191
|
+
* case.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export interface UseCase {
|
|
195
|
+
/**
|
|
196
|
+
* <p>The identifier for the use case.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
UseCaseId?: string;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Resource Name (ARN) for the use case.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
UseCaseArn?: string;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The type of use case to associate to the integration association. Each integration
|
|
207
|
+
* association can have only one of each use case type.</p>
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
UseCaseType?: UseCaseType;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
export interface ListUseCasesResponse {
|
|
216
|
+
/**
|
|
217
|
+
* <p>The use cases.</p>
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
UseCaseSummaryList?: UseCase[];
|
|
221
|
+
/**
|
|
222
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
NextToken?: string;
|
|
226
|
+
}
|
|
5
227
|
/**
|
|
6
228
|
* @public
|
|
7
229
|
*/
|
|
@@ -553,6 +775,26 @@ export interface ResumeContactRecordingRequest {
|
|
|
553
775
|
*/
|
|
554
776
|
export interface ResumeContactRecordingResponse {
|
|
555
777
|
}
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
*/
|
|
781
|
+
export interface SearchAgentStatusesResponse {
|
|
782
|
+
/**
|
|
783
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
784
|
+
* @public
|
|
785
|
+
*/
|
|
786
|
+
AgentStatuses?: AgentStatus[];
|
|
787
|
+
/**
|
|
788
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
789
|
+
* @public
|
|
790
|
+
*/
|
|
791
|
+
NextToken?: string;
|
|
792
|
+
/**
|
|
793
|
+
* <p>The total number of agent statuses which matched your search query.</p>
|
|
794
|
+
* @public
|
|
795
|
+
*/
|
|
796
|
+
ApproximateTotalCount?: number;
|
|
797
|
+
}
|
|
556
798
|
/**
|
|
557
799
|
* @public
|
|
558
800
|
*/
|
|
@@ -632,61 +874,6 @@ export interface SearchAvailablePhoneNumbersResponse {
|
|
|
632
874
|
*/
|
|
633
875
|
AvailableNumbersList?: AvailableNumberSummary[];
|
|
634
876
|
}
|
|
635
|
-
/**
|
|
636
|
-
* @public
|
|
637
|
-
* @enum
|
|
638
|
-
*/
|
|
639
|
-
export declare const StringComparisonType: {
|
|
640
|
-
readonly CONTAINS: "CONTAINS";
|
|
641
|
-
readonly EXACT: "EXACT";
|
|
642
|
-
readonly STARTS_WITH: "STARTS_WITH";
|
|
643
|
-
};
|
|
644
|
-
/**
|
|
645
|
-
* @public
|
|
646
|
-
*/
|
|
647
|
-
export type StringComparisonType = (typeof StringComparisonType)[keyof typeof StringComparisonType];
|
|
648
|
-
/**
|
|
649
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
650
|
-
* <note>
|
|
651
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
652
|
-
* <code>description</code>.</p>
|
|
653
|
-
* </note>
|
|
654
|
-
* @public
|
|
655
|
-
*/
|
|
656
|
-
export interface StringCondition {
|
|
657
|
-
/**
|
|
658
|
-
* <p>The name of the field in the string condition.</p>
|
|
659
|
-
* @public
|
|
660
|
-
*/
|
|
661
|
-
FieldName?: string;
|
|
662
|
-
/**
|
|
663
|
-
* <p>The value of the string.</p>
|
|
664
|
-
* @public
|
|
665
|
-
*/
|
|
666
|
-
Value?: string;
|
|
667
|
-
/**
|
|
668
|
-
* <p>The type of comparison to be made when evaluating the string condition.</p>
|
|
669
|
-
* @public
|
|
670
|
-
*/
|
|
671
|
-
ComparisonType?: StringComparisonType;
|
|
672
|
-
}
|
|
673
|
-
/**
|
|
674
|
-
* <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
|
|
675
|
-
* BPO = 123</code>. </p>
|
|
676
|
-
* @public
|
|
677
|
-
*/
|
|
678
|
-
export interface TagCondition {
|
|
679
|
-
/**
|
|
680
|
-
* <p>The tag key in the tag condition.</p>
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
TagKey?: string;
|
|
684
|
-
/**
|
|
685
|
-
* <p>The tag value in the tag condition.</p>
|
|
686
|
-
* @public
|
|
687
|
-
*/
|
|
688
|
-
TagValue?: string;
|
|
689
|
-
}
|
|
690
877
|
/**
|
|
691
878
|
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
692
879
|
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
@@ -1443,6 +1630,35 @@ export interface SearchResourceTagsRequest {
|
|
|
1443
1630
|
/**
|
|
1444
1631
|
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
|
|
1445
1632
|
* list is provided, this API will search from all supported resource types.</p>
|
|
1633
|
+
* <p class="title">
|
|
1634
|
+
* <b>Supported resource types</b>
|
|
1635
|
+
* </p>
|
|
1636
|
+
* <ul>
|
|
1637
|
+
* <li>
|
|
1638
|
+
* <p>AGENT</p>
|
|
1639
|
+
* </li>
|
|
1640
|
+
* <li>
|
|
1641
|
+
* <p>ROUTING_PROFILE</p>
|
|
1642
|
+
* </li>
|
|
1643
|
+
* <li>
|
|
1644
|
+
* <p>STANDARD_QUEUE</p>
|
|
1645
|
+
* </li>
|
|
1646
|
+
* <li>
|
|
1647
|
+
* <p>SECURITY_PROFILE</p>
|
|
1648
|
+
* </li>
|
|
1649
|
+
* <li>
|
|
1650
|
+
* <p>OPERATING_HOURS</p>
|
|
1651
|
+
* </li>
|
|
1652
|
+
* <li>
|
|
1653
|
+
* <p>PROMPT</p>
|
|
1654
|
+
* </li>
|
|
1655
|
+
* <li>
|
|
1656
|
+
* <p>CONTACT_FLOW</p>
|
|
1657
|
+
* </li>
|
|
1658
|
+
* <li>
|
|
1659
|
+
* <p>FLOW_MODULE</p>
|
|
1660
|
+
* </li>
|
|
1661
|
+
* </ul>
|
|
1446
1662
|
* @public
|
|
1447
1663
|
*/
|
|
1448
1664
|
ResourceTypes?: string[];
|
|
@@ -1614,6 +1830,48 @@ export interface SearchSecurityProfilesResponse {
|
|
|
1614
1830
|
*/
|
|
1615
1831
|
ApproximateTotalCount?: number;
|
|
1616
1832
|
}
|
|
1833
|
+
/**
|
|
1834
|
+
* <p>Filters to be applied to search results.</p>
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
export interface UserHierarchyGroupSearchFilter {
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>An object that can be used to specify Tag conditions inside the SearchFilter. This accepts
|
|
1840
|
+
* an OR or AND (List of List) input where:</p>
|
|
1841
|
+
* <ul>
|
|
1842
|
+
* <li>
|
|
1843
|
+
* <p>The top level list specifies conditions that need to be applied with <code>OR</code>
|
|
1844
|
+
* operator.</p>
|
|
1845
|
+
* </li>
|
|
1846
|
+
* <li>
|
|
1847
|
+
* <p>The inner list specifies conditions that need to be applied with <code>AND</code>
|
|
1848
|
+
* operator.</p>
|
|
1849
|
+
* </li>
|
|
1850
|
+
* </ul>
|
|
1851
|
+
* @public
|
|
1852
|
+
*/
|
|
1853
|
+
AttributeFilter?: ControlPlaneAttributeFilter;
|
|
1854
|
+
}
|
|
1855
|
+
/**
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
export interface SearchUserHierarchyGroupsResponse {
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>Information about the userHierarchyGroups.</p>
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
UserHierarchyGroups?: HierarchyGroup[];
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
NextToken?: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The total number of userHierarchyGroups which matched your search query.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
ApproximateTotalCount?: number;
|
|
1874
|
+
}
|
|
1617
1875
|
/**
|
|
1618
1876
|
* @public
|
|
1619
1877
|
* @enum
|
|
@@ -1642,6 +1900,101 @@ export interface HierarchyGroupCondition {
|
|
|
1642
1900
|
*/
|
|
1643
1901
|
HierarchyGroupMatchType?: HierarchyGroupMatchType;
|
|
1644
1902
|
}
|
|
1903
|
+
/**
|
|
1904
|
+
* @public
|
|
1905
|
+
* @enum
|
|
1906
|
+
*/
|
|
1907
|
+
export declare const NumberComparisonType: {
|
|
1908
|
+
readonly EQUAL: "EQUAL";
|
|
1909
|
+
readonly GREATER: "GREATER";
|
|
1910
|
+
readonly GREATER_OR_EQUAL: "GREATER_OR_EQUAL";
|
|
1911
|
+
readonly LESSER: "LESSER";
|
|
1912
|
+
readonly LESSER_OR_EQUAL: "LESSER_OR_EQUAL";
|
|
1913
|
+
readonly NOT_EQUAL: "NOT_EQUAL";
|
|
1914
|
+
readonly RANGE: "RANGE";
|
|
1915
|
+
};
|
|
1916
|
+
/**
|
|
1917
|
+
* @public
|
|
1918
|
+
*/
|
|
1919
|
+
export type NumberComparisonType = (typeof NumberComparisonType)[keyof typeof NumberComparisonType];
|
|
1920
|
+
/**
|
|
1921
|
+
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
1922
|
+
* <note>
|
|
1923
|
+
* <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
|
|
1924
|
+
* </note>
|
|
1925
|
+
* @public
|
|
1926
|
+
*/
|
|
1927
|
+
export interface NumberCondition {
|
|
1928
|
+
/**
|
|
1929
|
+
* <p>The name of the field in the number condition.</p>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
FieldName?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>The minValue to be used while evaluating the number condition.</p>
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
MinValue?: number;
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>The maxValue to be used while evaluating the number condition.</p>
|
|
1940
|
+
* @public
|
|
1941
|
+
*/
|
|
1942
|
+
MaxValue?: number;
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>The type of comparison to be made when evaluating the number condition.</p>
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
ComparisonType?: NumberComparisonType;
|
|
1948
|
+
}
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and
|
|
1951
|
+
* ProficiencyLimit.</p>
|
|
1952
|
+
* @public
|
|
1953
|
+
*/
|
|
1954
|
+
export interface Condition {
|
|
1955
|
+
/**
|
|
1956
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
1957
|
+
* <note>
|
|
1958
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
1959
|
+
* <code>value</code>.</p>
|
|
1960
|
+
* </note>
|
|
1961
|
+
* @public
|
|
1962
|
+
*/
|
|
1963
|
+
StringCondition?: StringCondition;
|
|
1964
|
+
/**
|
|
1965
|
+
* <p>A leaf node condition which can be used to specify a numeric condition.</p>
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
NumberCondition?: NumberCondition;
|
|
1969
|
+
}
|
|
1970
|
+
/**
|
|
1971
|
+
* @public
|
|
1972
|
+
* @enum
|
|
1973
|
+
*/
|
|
1974
|
+
export declare const TargetListType: {
|
|
1975
|
+
readonly PROFICIENCIES: "PROFICIENCIES";
|
|
1976
|
+
};
|
|
1977
|
+
/**
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
export type TargetListType = (typeof TargetListType)[keyof typeof TargetListType];
|
|
1981
|
+
/**
|
|
1982
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with
|
|
1983
|
+
* attributes included in Lists like Proficiencies.</p>
|
|
1984
|
+
* @public
|
|
1985
|
+
*/
|
|
1986
|
+
export interface ListCondition {
|
|
1987
|
+
/**
|
|
1988
|
+
* <p>The type of target list that will be used to filter the users.</p>
|
|
1989
|
+
* @public
|
|
1990
|
+
*/
|
|
1991
|
+
TargetListType?: TargetListType;
|
|
1992
|
+
/**
|
|
1993
|
+
* <p>A list of Condition objects which would be applied together with an AND condition.</p>
|
|
1994
|
+
* @public
|
|
1995
|
+
*/
|
|
1996
|
+
Conditions?: Condition[];
|
|
1997
|
+
}
|
|
1645
1998
|
/**
|
|
1646
1999
|
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
1647
2000
|
* condition.</p>
|
|
@@ -5079,6 +5432,38 @@ export interface EvaluationFormSection {
|
|
|
5079
5432
|
*/
|
|
5080
5433
|
Weight?: number;
|
|
5081
5434
|
}
|
|
5435
|
+
/**
|
|
5436
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
5437
|
+
* @public
|
|
5438
|
+
*/
|
|
5439
|
+
export interface AgentStatusSearchCriteria {
|
|
5440
|
+
/**
|
|
5441
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
5442
|
+
* condition.</p>
|
|
5443
|
+
* @public
|
|
5444
|
+
*/
|
|
5445
|
+
OrConditions?: AgentStatusSearchCriteria[];
|
|
5446
|
+
/**
|
|
5447
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5448
|
+
* <note>
|
|
5449
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
5450
|
+
* <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
|
|
5451
|
+
* and <code>resourceID</code>.</p>
|
|
5452
|
+
* </note>
|
|
5453
|
+
* @public
|
|
5454
|
+
*/
|
|
5455
|
+
AndConditions?: AgentStatusSearchCriteria[];
|
|
5456
|
+
/**
|
|
5457
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5458
|
+
* <note>
|
|
5459
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
5460
|
+
* <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
|
|
5461
|
+
* and <code>resourceID</code>.</p>
|
|
5462
|
+
* </note>
|
|
5463
|
+
* @public
|
|
5464
|
+
*/
|
|
5465
|
+
StringCondition?: StringCondition;
|
|
5466
|
+
}
|
|
5082
5467
|
/**
|
|
5083
5468
|
* <p>The search criteria to be used to return flow modules.</p>
|
|
5084
5469
|
* @public
|
|
@@ -5098,10 +5483,6 @@ export interface ContactFlowModuleSearchCriteria {
|
|
|
5098
5483
|
AndConditions?: ContactFlowModuleSearchCriteria[];
|
|
5099
5484
|
/**
|
|
5100
5485
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5101
|
-
* <note>
|
|
5102
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
5103
|
-
* <code>description</code>.</p>
|
|
5104
|
-
* </note>
|
|
5105
5486
|
* @public
|
|
5106
5487
|
*/
|
|
5107
5488
|
StringCondition?: StringCondition;
|
|
@@ -5125,10 +5506,6 @@ export interface ContactFlowSearchCriteria {
|
|
|
5125
5506
|
AndConditions?: ContactFlowSearchCriteria[];
|
|
5126
5507
|
/**
|
|
5127
5508
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5128
|
-
* <note>
|
|
5129
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
5130
|
-
* <code>description</code>.</p>
|
|
5131
|
-
* </note>
|
|
5132
5509
|
* @public
|
|
5133
5510
|
*/
|
|
5134
5511
|
StringCondition?: StringCondition;
|
|
@@ -5368,10 +5745,6 @@ export interface PredefinedAttributeSearchCriteria {
|
|
|
5368
5745
|
AndConditions?: PredefinedAttributeSearchCriteria[];
|
|
5369
5746
|
/**
|
|
5370
5747
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5371
|
-
* <note>
|
|
5372
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
5373
|
-
* <code>description</code>.</p>
|
|
5374
|
-
* </note>
|
|
5375
5748
|
* @public
|
|
5376
5749
|
*/
|
|
5377
5750
|
StringCondition?: StringCondition;
|
|
@@ -5514,10 +5887,6 @@ export interface SecurityProfileSearchCriteria {
|
|
|
5514
5887
|
AndConditions?: SecurityProfileSearchCriteria[];
|
|
5515
5888
|
/**
|
|
5516
5889
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5517
|
-
* <note>
|
|
5518
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
|
|
5519
|
-
* <code>description</code>.</p>
|
|
5520
|
-
* </note>
|
|
5521
5890
|
* @public
|
|
5522
5891
|
*/
|
|
5523
5892
|
StringCondition?: StringCondition;
|
|
@@ -5575,6 +5944,31 @@ export interface UpdateEvaluationFormRequest {
|
|
|
5575
5944
|
*/
|
|
5576
5945
|
ClientToken?: string;
|
|
5577
5946
|
}
|
|
5947
|
+
/**
|
|
5948
|
+
* <p>The search criteria to be used to return userHierarchyGroup.</p>
|
|
5949
|
+
* @public
|
|
5950
|
+
*/
|
|
5951
|
+
export interface UserHierarchyGroupSearchCriteria {
|
|
5952
|
+
/**
|
|
5953
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
5954
|
+
* @public
|
|
5955
|
+
*/
|
|
5956
|
+
OrConditions?: UserHierarchyGroupSearchCriteria[];
|
|
5957
|
+
/**
|
|
5958
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
5959
|
+
* @public
|
|
5960
|
+
*/
|
|
5961
|
+
AndConditions?: UserHierarchyGroupSearchCriteria[];
|
|
5962
|
+
/**
|
|
5963
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
5964
|
+
* <note>
|
|
5965
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
5966
|
+
* <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
|
|
5967
|
+
* </note>
|
|
5968
|
+
* @public
|
|
5969
|
+
*/
|
|
5970
|
+
StringCondition?: StringCondition;
|
|
5971
|
+
}
|
|
5578
5972
|
/**
|
|
5579
5973
|
* <p>The search criteria to be used to return users.</p>
|
|
5580
5974
|
* <note>
|
|
@@ -5605,6 +5999,12 @@ export interface UserSearchCriteria {
|
|
|
5605
5999
|
* @public
|
|
5606
6000
|
*/
|
|
5607
6001
|
StringCondition?: StringCondition;
|
|
6002
|
+
/**
|
|
6003
|
+
* <p>A leaf node condition which can be used to specify a List condition to search users with
|
|
6004
|
+
* attributes included in Lists like Proficiencies.</p>
|
|
6005
|
+
* @public
|
|
6006
|
+
*/
|
|
6007
|
+
ListCondition?: ListCondition;
|
|
5608
6008
|
/**
|
|
5609
6009
|
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
5610
6010
|
* @public
|
|
@@ -5636,6 +6036,38 @@ export interface DescribeEvaluationFormResponse {
|
|
|
5636
6036
|
*/
|
|
5637
6037
|
EvaluationForm: EvaluationForm | undefined;
|
|
5638
6038
|
}
|
|
6039
|
+
/**
|
|
6040
|
+
* @public
|
|
6041
|
+
*/
|
|
6042
|
+
export interface SearchAgentStatusesRequest {
|
|
6043
|
+
/**
|
|
6044
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
6045
|
+
* the instance.</p>
|
|
6046
|
+
* @public
|
|
6047
|
+
*/
|
|
6048
|
+
InstanceId: string | undefined;
|
|
6049
|
+
/**
|
|
6050
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
6051
|
+
* the next request to retrieve the next set of results.</p>
|
|
6052
|
+
* @public
|
|
6053
|
+
*/
|
|
6054
|
+
NextToken?: string;
|
|
6055
|
+
/**
|
|
6056
|
+
* <p>The maximum number of results to return per page.</p>
|
|
6057
|
+
* @public
|
|
6058
|
+
*/
|
|
6059
|
+
MaxResults?: number;
|
|
6060
|
+
/**
|
|
6061
|
+
* <p>Filters to be applied to search results.</p>
|
|
6062
|
+
* @public
|
|
6063
|
+
*/
|
|
6064
|
+
SearchFilter?: AgentStatusSearchFilter;
|
|
6065
|
+
/**
|
|
6066
|
+
* <p>The search criteria to be used to return agent statuses.</p>
|
|
6067
|
+
* @public
|
|
6068
|
+
*/
|
|
6069
|
+
SearchCriteria?: AgentStatusSearchCriteria;
|
|
6070
|
+
}
|
|
5639
6071
|
/**
|
|
5640
6072
|
* @public
|
|
5641
6073
|
*/
|
|
@@ -5942,6 +6374,38 @@ export interface SearchSecurityProfilesRequest {
|
|
|
5942
6374
|
*/
|
|
5943
6375
|
SearchFilter?: SecurityProfilesSearchFilter;
|
|
5944
6376
|
}
|
|
6377
|
+
/**
|
|
6378
|
+
* @public
|
|
6379
|
+
*/
|
|
6380
|
+
export interface SearchUserHierarchyGroupsRequest {
|
|
6381
|
+
/**
|
|
6382
|
+
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
6383
|
+
* the instance.</p>
|
|
6384
|
+
* @public
|
|
6385
|
+
*/
|
|
6386
|
+
InstanceId: string | undefined;
|
|
6387
|
+
/**
|
|
6388
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
6389
|
+
* the next request to retrieve the next set of results.</p>
|
|
6390
|
+
* @public
|
|
6391
|
+
*/
|
|
6392
|
+
NextToken?: string;
|
|
6393
|
+
/**
|
|
6394
|
+
* <p>The maximum number of results to return per page.</p>
|
|
6395
|
+
* @public
|
|
6396
|
+
*/
|
|
6397
|
+
MaxResults?: number;
|
|
6398
|
+
/**
|
|
6399
|
+
* <p>Filters to be applied to search results.</p>
|
|
6400
|
+
* @public
|
|
6401
|
+
*/
|
|
6402
|
+
SearchFilter?: UserHierarchyGroupSearchFilter;
|
|
6403
|
+
/**
|
|
6404
|
+
* <p>The search criteria to be used to return UserHierarchyGroups.</p>
|
|
6405
|
+
* @public
|
|
6406
|
+
*/
|
|
6407
|
+
SearchCriteria?: UserHierarchyGroupSearchCriteria;
|
|
6408
|
+
}
|
|
5945
6409
|
/**
|
|
5946
6410
|
* @public
|
|
5947
6411
|
*/
|