@aws-sdk/client-connect 3.319.0 → 3.321.1
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 +119 -7
- package/dist-cjs/Connect.js +28 -0
- package/dist-cjs/commands/ActivateEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/CreateEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/DeactivateEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/DeleteContactEvaluationCommand.js +45 -0
- package/dist-cjs/commands/DeleteEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/DescribeContactEvaluationCommand.js +45 -0
- package/dist-cjs/commands/DescribeEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/GetFederationTokenCommand.js +2 -2
- package/dist-cjs/commands/ListContactEvaluationsCommand.js +45 -0
- package/dist-cjs/commands/ListEvaluationFormVersionsCommand.js +45 -0
- package/dist-cjs/commands/ListEvaluationFormsCommand.js +45 -0
- package/dist-cjs/commands/StartContactEvaluationCommand.js +45 -0
- package/dist-cjs/commands/SubmitContactEvaluationCommand.js +45 -0
- package/dist-cjs/commands/UpdateContactEvaluationCommand.js +45 -0
- package/dist-cjs/commands/UpdateEvaluationFormCommand.js +45 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/models/models_0.js +142 -125
- package/dist-cjs/models/models_1.js +71 -1
- package/dist-cjs/pagination/ListContactEvaluationsPaginator.js +28 -0
- package/dist-cjs/pagination/ListEvaluationFormVersionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListEvaluationFormsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1272 -41
- package/dist-es/Connect.js +28 -0
- package/dist-es/commands/ActivateEvaluationFormCommand.js +41 -0
- package/dist-es/commands/CreateEvaluationFormCommand.js +41 -0
- package/dist-es/commands/DeactivateEvaluationFormCommand.js +41 -0
- package/dist-es/commands/DeleteContactEvaluationCommand.js +41 -0
- package/dist-es/commands/DeleteEvaluationFormCommand.js +41 -0
- package/dist-es/commands/DescribeContactEvaluationCommand.js +41 -0
- package/dist-es/commands/DescribeEvaluationFormCommand.js +41 -0
- package/dist-es/commands/GetFederationTokenCommand.js +1 -1
- package/dist-es/commands/ListContactEvaluationsCommand.js +41 -0
- package/dist-es/commands/ListEvaluationFormVersionsCommand.js +41 -0
- package/dist-es/commands/ListEvaluationFormsCommand.js +41 -0
- package/dist-es/commands/StartContactEvaluationCommand.js +41 -0
- package/dist-es/commands/SubmitContactEvaluationCommand.js +41 -0
- package/dist-es/commands/UpdateContactEvaluationCommand.js +41 -0
- package/dist-es/commands/UpdateEvaluationFormCommand.js +41 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/models_0.js +136 -116
- package/dist-es/models/models_1.js +67 -0
- package/dist-es/pagination/ListContactEvaluationsPaginator.js +24 -0
- package/dist-es/pagination/ListEvaluationFormVersionsPaginator.js +25 -0
- package/dist-es/pagination/ListEvaluationFormsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1235 -33
- package/dist-types/Connect.d.ts +98 -0
- package/dist-types/ConnectClient.d.ts +16 -2
- package/dist-types/commands/ActivateEvaluationFormCommand.d.ts +81 -0
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +213 -0
- package/dist-types/commands/CreateParticipantCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +81 -0
- package/dist-types/commands/DeleteContactEvaluationCommand.d.ts +79 -0
- package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +89 -0
- package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +77 -0
- package/dist-types/commands/DescribeEvaluationFormCommand.d.ts +79 -0
- package/dist-types/commands/GetCurrentUserDataCommand.d.ts +1 -1
- package/dist-types/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +1 -1
- package/dist-types/commands/GetMetricDataV2Command.d.ts +1 -1
- package/dist-types/commands/GetTaskTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +1 -2
- package/dist-types/commands/ListContactEvaluationsCommand.d.ts +77 -0
- package/dist-types/commands/ListEvaluationFormVersionsCommand.d.ts +78 -0
- package/dist-types/commands/ListEvaluationFormsCommand.d.ts +77 -0
- package/dist-types/commands/StartContactEvaluationCommand.d.ts +91 -0
- package/dist-types/commands/SubmitContactEvaluationCommand.d.ts +98 -0
- package/dist-types/commands/UpdateContactEvaluationCommand.d.ts +96 -0
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +215 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/models_0.d.ts +859 -1281
- package/dist-types/models/models_1.d.ts +1758 -3
- package/dist-types/pagination/ListContactEvaluationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEvaluationFormVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEvaluationFormsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/Connect.d.ts +238 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/ActivateEvaluationFormCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/DeleteContactEvaluationCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DeleteEvaluationFormCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DescribeEvaluationFormCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetFederationTokenCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMetricDataV2Command.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetTaskTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetTrafficDistributionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAgentStatusesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListContactEvaluationsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListEvaluationFormVersionsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/ListEvaluationFormsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartContactEvaluationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/SubmitContactEvaluationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateContactEvaluationCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateEvaluationFormCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/models_0.d.ts +328 -262
- package/dist-types/ts3.4/models/models_1.d.ts +425 -1
- package/dist-types/ts3.4/pagination/ListContactEvaluationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEvaluationFormVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEvaluationFormsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +4 -4
|
@@ -1,6 +1,1123 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentStatusState, AgentStatusSummary, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, DirectoryType, EventSourceName, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus,
|
|
3
|
+
import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFilter, ContactFlowModuleState, ContactFlowState, ContactFlowType, Dimensions, DirectoryType, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RoutingProfileReference, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* <p>A filter for the user data.</p>
|
|
7
|
+
*/
|
|
8
|
+
export interface UserDataFilters {
|
|
9
|
+
/**
|
|
10
|
+
* <p>A list of up to 100 queues or ARNs.</p>
|
|
11
|
+
*/
|
|
12
|
+
Queues?: string[];
|
|
13
|
+
/**
|
|
14
|
+
* <p>A filter for the user data based on the contact information that is associated to the user.
|
|
15
|
+
* It contains a list of contact states. </p>
|
|
16
|
+
*/
|
|
17
|
+
ContactFilter?: ContactFilter;
|
|
18
|
+
/**
|
|
19
|
+
* <p>A list of up to 100 routing profile IDs or ARNs.</p>
|
|
20
|
+
*/
|
|
21
|
+
RoutingProfiles?: string[];
|
|
22
|
+
/**
|
|
23
|
+
* <p>A list of up to 100 agent IDs or ARNs.</p>
|
|
24
|
+
*/
|
|
25
|
+
Agents?: string[];
|
|
26
|
+
/**
|
|
27
|
+
* <p>A UserHierarchyGroup ID or ARN.</p>
|
|
28
|
+
*/
|
|
29
|
+
UserHierarchyGroups?: string[];
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface GetCurrentUserDataRequest {
|
|
35
|
+
/**
|
|
36
|
+
* <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>
|
|
37
|
+
*/
|
|
38
|
+
InstanceId: string | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>The filters to apply to returned user data. You can filter up to the following
|
|
41
|
+
* limits:</p>
|
|
42
|
+
* <ul>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>Queues: 100</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>Routing profiles: 100</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>Agents: 100</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>Contact states: 9</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>User hierarchy groups: 1</p>
|
|
57
|
+
* </li>
|
|
58
|
+
* </ul>
|
|
59
|
+
* <p> The user data is retrieved for only the specified values/resources in the filter. A maximum
|
|
60
|
+
* of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups. </p>
|
|
61
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
62
|
+
*/
|
|
63
|
+
Filters: UserDataFilters | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
66
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
67
|
+
*/
|
|
68
|
+
NextToken?: string;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The maximum number of results to return per page.</p>
|
|
71
|
+
*/
|
|
72
|
+
MaxResults?: number;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* <p>Information about the hierarchy group.</p>
|
|
77
|
+
*/
|
|
78
|
+
export interface HierarchyGroupSummaryReference {
|
|
79
|
+
/**
|
|
80
|
+
* <p>The unique identifier for the hierarchy group.</p>
|
|
81
|
+
*/
|
|
82
|
+
Id?: string;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The Amazon Resource Name (ARN) for the hierarchy group. </p>
|
|
85
|
+
*/
|
|
86
|
+
Arn?: string;
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
* <p>Information about the levels in the hierarchy group.</p>
|
|
91
|
+
*/
|
|
92
|
+
export interface HierarchyPathReference {
|
|
93
|
+
/**
|
|
94
|
+
* <p>Information about level one.</p>
|
|
95
|
+
*/
|
|
96
|
+
LevelOne?: HierarchyGroupSummaryReference;
|
|
97
|
+
/**
|
|
98
|
+
* <p>Information about level two.</p>
|
|
99
|
+
*/
|
|
100
|
+
LevelTwo?: HierarchyGroupSummaryReference;
|
|
101
|
+
/**
|
|
102
|
+
* <p>Information about level three.</p>
|
|
103
|
+
*/
|
|
104
|
+
LevelThree?: HierarchyGroupSummaryReference;
|
|
105
|
+
/**
|
|
106
|
+
* <p>Information about level four.</p>
|
|
107
|
+
*/
|
|
108
|
+
LevelFour?: HierarchyGroupSummaryReference;
|
|
109
|
+
/**
|
|
110
|
+
* <p>Information about level five.</p>
|
|
111
|
+
*/
|
|
112
|
+
LevelFive?: HierarchyGroupSummaryReference;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
* <p>Information about the user.</p>
|
|
117
|
+
*/
|
|
118
|
+
export interface UserReference {
|
|
119
|
+
/**
|
|
120
|
+
* <p>The unique identifier for the user.</p>
|
|
121
|
+
*/
|
|
122
|
+
Id?: string;
|
|
123
|
+
/**
|
|
124
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
125
|
+
*/
|
|
126
|
+
Arn?: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
* <p>Data for a user.</p>
|
|
131
|
+
*/
|
|
132
|
+
export interface UserData {
|
|
133
|
+
/**
|
|
134
|
+
* <p>Information about the user for the data that is returned. It contains the
|
|
135
|
+
* <code>resourceId</code> and ARN of the user. </p>
|
|
136
|
+
*/
|
|
137
|
+
User?: UserReference;
|
|
138
|
+
/**
|
|
139
|
+
* <p>Information about the routing profile that is assigned to the user.</p>
|
|
140
|
+
*/
|
|
141
|
+
RoutingProfile?: RoutingProfileReference;
|
|
142
|
+
/**
|
|
143
|
+
* <p>Contains information about the levels of a hierarchy group assigned to a user.</p>
|
|
144
|
+
*/
|
|
145
|
+
HierarchyPath?: HierarchyPathReference;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that
|
|
148
|
+
* the supervisor manually changes in the real-time metrics report.</p>
|
|
149
|
+
*/
|
|
150
|
+
Status?: AgentStatusReference;
|
|
151
|
+
/**
|
|
152
|
+
* <p>A map of available slots by channel. The key is a channel name. The value is an integer: the
|
|
153
|
+
* available number of slots. </p>
|
|
154
|
+
*/
|
|
155
|
+
AvailableSlotsByChannel?: Record<string, number>;
|
|
156
|
+
/**
|
|
157
|
+
* <p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the
|
|
158
|
+
* maximum number of slots. This is calculated from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html">MediaConcurrency</a> of the
|
|
159
|
+
* <code>RoutingProfile</code> assigned to the agent. </p>
|
|
160
|
+
*/
|
|
161
|
+
MaxSlotsByChannel?: Record<string, number>;
|
|
162
|
+
/**
|
|
163
|
+
* <p> A map of active slots by channel. The key is a channel name. The value is an integer: the
|
|
164
|
+
* number of active slots. </p>
|
|
165
|
+
*/
|
|
166
|
+
ActiveSlotsByChannel?: Record<string, number>;
|
|
167
|
+
/**
|
|
168
|
+
* <p>A list of contact reference information.</p>
|
|
169
|
+
*/
|
|
170
|
+
Contacts?: AgentContactReference[];
|
|
171
|
+
/**
|
|
172
|
+
* <p>The Next status of the agent.</p>
|
|
173
|
+
*/
|
|
174
|
+
NextStatus?: string;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export interface GetCurrentUserDataResponse {
|
|
180
|
+
/**
|
|
181
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
182
|
+
*/
|
|
183
|
+
NextToken?: string;
|
|
184
|
+
/**
|
|
185
|
+
* <p>A list of the user data that is returned.</p>
|
|
186
|
+
*/
|
|
187
|
+
UserDataList?: UserData[];
|
|
188
|
+
/**
|
|
189
|
+
* <p>The total count of the result, regardless of the current page size.</p>
|
|
190
|
+
*/
|
|
191
|
+
ApproximateTotalCount?: number;
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
export interface GetFederationTokenRequest {
|
|
197
|
+
/**
|
|
198
|
+
* <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>
|
|
199
|
+
*/
|
|
200
|
+
InstanceId: string | undefined;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* @public
|
|
204
|
+
* <p>Contains credentials to use for federation.</p>
|
|
205
|
+
*/
|
|
206
|
+
export interface Credentials {
|
|
207
|
+
/**
|
|
208
|
+
* <p>An access token generated for a federated user to access Amazon Connect.</p>
|
|
209
|
+
*/
|
|
210
|
+
AccessToken?: string;
|
|
211
|
+
/**
|
|
212
|
+
* <p>A token generated with an expiration time for the session a user is logged in to Amazon Connect.</p>
|
|
213
|
+
*/
|
|
214
|
+
AccessTokenExpiration?: Date;
|
|
215
|
+
/**
|
|
216
|
+
* <p>Renews a token generated for a user to access the Amazon Connect instance.</p>
|
|
217
|
+
*/
|
|
218
|
+
RefreshToken?: string;
|
|
219
|
+
/**
|
|
220
|
+
* <p>Renews the expiration timer for a generated token.</p>
|
|
221
|
+
*/
|
|
222
|
+
RefreshTokenExpiration?: Date;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export interface GetFederationTokenResponse {
|
|
228
|
+
/**
|
|
229
|
+
* <p>The credentials to use for federation.</p>
|
|
230
|
+
*/
|
|
231
|
+
Credentials?: Credentials;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The URL to sign into the user's instance. </p>
|
|
234
|
+
*/
|
|
235
|
+
SignInUrl?: string;
|
|
236
|
+
/**
|
|
237
|
+
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
238
|
+
*/
|
|
239
|
+
UserArn?: string;
|
|
240
|
+
/**
|
|
241
|
+
* <p>The identifier for the user.</p>
|
|
242
|
+
*/
|
|
243
|
+
UserId?: string;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* @public
|
|
247
|
+
* <p>No user with the specified credentials was found in the Amazon Connect instance.</p>
|
|
248
|
+
*/
|
|
249
|
+
export declare class UserNotFoundException extends __BaseException {
|
|
250
|
+
readonly name: "UserNotFoundException";
|
|
251
|
+
readonly $fault: "client";
|
|
252
|
+
Message?: string;
|
|
253
|
+
/**
|
|
254
|
+
* @internal
|
|
255
|
+
*/
|
|
256
|
+
constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
* @enum
|
|
261
|
+
*/
|
|
262
|
+
export declare const HistoricalMetricName: {
|
|
263
|
+
readonly ABANDON_TIME: "ABANDON_TIME";
|
|
264
|
+
readonly AFTER_CONTACT_WORK_TIME: "AFTER_CONTACT_WORK_TIME";
|
|
265
|
+
readonly API_CONTACTS_HANDLED: "API_CONTACTS_HANDLED";
|
|
266
|
+
readonly CALLBACK_CONTACTS_HANDLED: "CALLBACK_CONTACTS_HANDLED";
|
|
267
|
+
readonly CONTACTS_ABANDONED: "CONTACTS_ABANDONED";
|
|
268
|
+
readonly CONTACTS_AGENT_HUNG_UP_FIRST: "CONTACTS_AGENT_HUNG_UP_FIRST";
|
|
269
|
+
readonly CONTACTS_CONSULTED: "CONTACTS_CONSULTED";
|
|
270
|
+
readonly CONTACTS_HANDLED: "CONTACTS_HANDLED";
|
|
271
|
+
readonly CONTACTS_HANDLED_INCOMING: "CONTACTS_HANDLED_INCOMING";
|
|
272
|
+
readonly CONTACTS_HANDLED_OUTBOUND: "CONTACTS_HANDLED_OUTBOUND";
|
|
273
|
+
readonly CONTACTS_HOLD_ABANDONS: "CONTACTS_HOLD_ABANDONS";
|
|
274
|
+
readonly CONTACTS_MISSED: "CONTACTS_MISSED";
|
|
275
|
+
readonly CONTACTS_QUEUED: "CONTACTS_QUEUED";
|
|
276
|
+
readonly CONTACTS_TRANSFERRED_IN: "CONTACTS_TRANSFERRED_IN";
|
|
277
|
+
readonly CONTACTS_TRANSFERRED_IN_FROM_QUEUE: "CONTACTS_TRANSFERRED_IN_FROM_QUEUE";
|
|
278
|
+
readonly CONTACTS_TRANSFERRED_OUT: "CONTACTS_TRANSFERRED_OUT";
|
|
279
|
+
readonly CONTACTS_TRANSFERRED_OUT_FROM_QUEUE: "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE";
|
|
280
|
+
readonly HANDLE_TIME: "HANDLE_TIME";
|
|
281
|
+
readonly HOLD_TIME: "HOLD_TIME";
|
|
282
|
+
readonly INTERACTION_AND_HOLD_TIME: "INTERACTION_AND_HOLD_TIME";
|
|
283
|
+
readonly INTERACTION_TIME: "INTERACTION_TIME";
|
|
284
|
+
readonly OCCUPANCY: "OCCUPANCY";
|
|
285
|
+
readonly QUEUED_TIME: "QUEUED_TIME";
|
|
286
|
+
readonly QUEUE_ANSWER_TIME: "QUEUE_ANSWER_TIME";
|
|
287
|
+
readonly SERVICE_LEVEL: "SERVICE_LEVEL";
|
|
288
|
+
};
|
|
289
|
+
/**
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
export type HistoricalMetricName = (typeof HistoricalMetricName)[keyof typeof HistoricalMetricName];
|
|
293
|
+
/**
|
|
294
|
+
* @public
|
|
295
|
+
* @enum
|
|
296
|
+
*/
|
|
297
|
+
export declare const Statistic: {
|
|
298
|
+
readonly AVG: "AVG";
|
|
299
|
+
readonly MAX: "MAX";
|
|
300
|
+
readonly SUM: "SUM";
|
|
301
|
+
};
|
|
302
|
+
/**
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
export type Statistic = (typeof Statistic)[keyof typeof Statistic];
|
|
306
|
+
/**
|
|
307
|
+
* @public
|
|
308
|
+
* @enum
|
|
309
|
+
*/
|
|
310
|
+
export declare const Comparison: {
|
|
311
|
+
readonly LT: "LT";
|
|
312
|
+
};
|
|
313
|
+
/**
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
export type Comparison = (typeof Comparison)[keyof typeof Comparison];
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
* <p>Contains information about the threshold for service level metrics.</p>
|
|
320
|
+
*/
|
|
321
|
+
export interface Threshold {
|
|
322
|
+
/**
|
|
323
|
+
* <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
|
|
324
|
+
*/
|
|
325
|
+
Comparison?: Comparison | string;
|
|
326
|
+
/**
|
|
327
|
+
* <p>The threshold value to compare.</p>
|
|
328
|
+
*/
|
|
329
|
+
ThresholdValue?: number;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* @public
|
|
333
|
+
* <p>Contains information about a historical metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator
|
|
334
|
+
* Guide</i>.</p>
|
|
335
|
+
*/
|
|
336
|
+
export interface HistoricalMetric {
|
|
337
|
+
/**
|
|
338
|
+
* <p>The name of the metric.</p>
|
|
339
|
+
*/
|
|
340
|
+
Name?: HistoricalMetricName | string;
|
|
341
|
+
/**
|
|
342
|
+
* <p>The threshold for the metric, used with service level metrics.</p>
|
|
343
|
+
*/
|
|
344
|
+
Threshold?: Threshold;
|
|
345
|
+
/**
|
|
346
|
+
* <p>The statistic for the metric.</p>
|
|
347
|
+
*/
|
|
348
|
+
Statistic?: Statistic | string;
|
|
349
|
+
/**
|
|
350
|
+
* <p>The unit for the metric.</p>
|
|
351
|
+
*/
|
|
352
|
+
Unit?: Unit | string;
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
export interface GetMetricDataRequest {
|
|
358
|
+
/**
|
|
359
|
+
* <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>
|
|
360
|
+
*/
|
|
361
|
+
InstanceId: string | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
364
|
+
* retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,
|
|
365
|
+
* such as 10:05, 10:10, 10:15.</p>
|
|
366
|
+
* <p>The start time cannot be earlier than 24 hours before the time of the request. Historical
|
|
367
|
+
* metrics are available only for 24 hours.</p>
|
|
368
|
+
*/
|
|
369
|
+
StartTime: Date | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
372
|
+
* retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,
|
|
373
|
+
* such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
|
|
374
|
+
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
375
|
+
*/
|
|
376
|
+
EndTime: Date | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is
|
|
379
|
+
* retrieved only for the resources associated with the queues or channels included in the filter.
|
|
380
|
+
* You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
|
|
381
|
+
* <note>
|
|
382
|
+
* <p>To filter by <code>Queues</code>, enter the queue
|
|
383
|
+
* ID/ARN, not the name of the queue.</p>
|
|
384
|
+
* </note>
|
|
385
|
+
*/
|
|
386
|
+
Filters: Filters | undefined;
|
|
387
|
+
/**
|
|
388
|
+
* <p>The grouping applied to the metrics returned. For example, when results are grouped by
|
|
389
|
+
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
|
|
390
|
+
* each queue rather than aggregated for all queues.</p>
|
|
391
|
+
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
|
|
392
|
+
*/
|
|
393
|
+
Groupings?: (Grouping | string)[];
|
|
394
|
+
/**
|
|
395
|
+
* <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The
|
|
396
|
+
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator
|
|
397
|
+
* Guide</i>.</p>
|
|
398
|
+
* <note>
|
|
399
|
+
* <p>This API does not support a contacts
|
|
400
|
+
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
401
|
+
* </note>
|
|
402
|
+
* <dl>
|
|
403
|
+
* <dt>ABANDON_TIME</dt>
|
|
404
|
+
* <dd>
|
|
405
|
+
* <p>Unit: SECONDS</p>
|
|
406
|
+
* <p>Statistic: AVG</p>
|
|
407
|
+
* </dd>
|
|
408
|
+
* <dt>AFTER_CONTACT_WORK_TIME</dt>
|
|
409
|
+
* <dd>
|
|
410
|
+
* <p>Unit: SECONDS</p>
|
|
411
|
+
* <p>Statistic: AVG</p>
|
|
412
|
+
* </dd>
|
|
413
|
+
* <dt>API_CONTACTS_HANDLED</dt>
|
|
414
|
+
* <dd>
|
|
415
|
+
* <p>Unit: COUNT</p>
|
|
416
|
+
* <p>Statistic: SUM</p>
|
|
417
|
+
* </dd>
|
|
418
|
+
* <dt>CALLBACK_CONTACTS_HANDLED</dt>
|
|
419
|
+
* <dd>
|
|
420
|
+
* <p>Unit: COUNT</p>
|
|
421
|
+
* <p>Statistic: SUM</p>
|
|
422
|
+
* </dd>
|
|
423
|
+
* <dt>CONTACTS_ABANDONED</dt>
|
|
424
|
+
* <dd>
|
|
425
|
+
* <p>Unit: COUNT</p>
|
|
426
|
+
* <p>Statistic: SUM</p>
|
|
427
|
+
* </dd>
|
|
428
|
+
* <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
|
|
429
|
+
* <dd>
|
|
430
|
+
* <p>Unit: COUNT</p>
|
|
431
|
+
* <p>Statistic: SUM</p>
|
|
432
|
+
* </dd>
|
|
433
|
+
* <dt>CONTACTS_CONSULTED</dt>
|
|
434
|
+
* <dd>
|
|
435
|
+
* <p>Unit: COUNT</p>
|
|
436
|
+
* <p>Statistic: SUM</p>
|
|
437
|
+
* </dd>
|
|
438
|
+
* <dt>CONTACTS_HANDLED</dt>
|
|
439
|
+
* <dd>
|
|
440
|
+
* <p>Unit: COUNT</p>
|
|
441
|
+
* <p>Statistic: SUM</p>
|
|
442
|
+
* </dd>
|
|
443
|
+
* <dt>CONTACTS_HANDLED_INCOMING</dt>
|
|
444
|
+
* <dd>
|
|
445
|
+
* <p>Unit: COUNT</p>
|
|
446
|
+
* <p>Statistic: SUM</p>
|
|
447
|
+
* </dd>
|
|
448
|
+
* <dt>CONTACTS_HANDLED_OUTBOUND</dt>
|
|
449
|
+
* <dd>
|
|
450
|
+
* <p>Unit: COUNT</p>
|
|
451
|
+
* <p>Statistic: SUM</p>
|
|
452
|
+
* </dd>
|
|
453
|
+
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
454
|
+
* <dd>
|
|
455
|
+
* <p>Unit: COUNT</p>
|
|
456
|
+
* <p>Statistic: SUM</p>
|
|
457
|
+
* </dd>
|
|
458
|
+
* <dt>CONTACTS_MISSED</dt>
|
|
459
|
+
* <dd>
|
|
460
|
+
* <p>Unit: COUNT</p>
|
|
461
|
+
* <p>Statistic: SUM</p>
|
|
462
|
+
* </dd>
|
|
463
|
+
* <dt>CONTACTS_QUEUED</dt>
|
|
464
|
+
* <dd>
|
|
465
|
+
* <p>Unit: COUNT</p>
|
|
466
|
+
* <p>Statistic: SUM</p>
|
|
467
|
+
* </dd>
|
|
468
|
+
* <dt>CONTACTS_TRANSFERRED_IN</dt>
|
|
469
|
+
* <dd>
|
|
470
|
+
* <p>Unit: COUNT</p>
|
|
471
|
+
* <p>Statistic: SUM</p>
|
|
472
|
+
* </dd>
|
|
473
|
+
* <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
|
|
474
|
+
* <dd>
|
|
475
|
+
* <p>Unit: COUNT</p>
|
|
476
|
+
* <p>Statistic: SUM</p>
|
|
477
|
+
* </dd>
|
|
478
|
+
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
479
|
+
* <dd>
|
|
480
|
+
* <p>Unit: COUNT</p>
|
|
481
|
+
* <p>Statistic: SUM</p>
|
|
482
|
+
* </dd>
|
|
483
|
+
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
484
|
+
* <dd>
|
|
485
|
+
* <p>Unit: COUNT</p>
|
|
486
|
+
* <p>Statistic: SUM</p>
|
|
487
|
+
* </dd>
|
|
488
|
+
* <dt>HANDLE_TIME</dt>
|
|
489
|
+
* <dd>
|
|
490
|
+
* <p>Unit: SECONDS</p>
|
|
491
|
+
* <p>Statistic: AVG</p>
|
|
492
|
+
* </dd>
|
|
493
|
+
* <dt>HOLD_TIME</dt>
|
|
494
|
+
* <dd>
|
|
495
|
+
* <p>Unit: SECONDS</p>
|
|
496
|
+
* <p>Statistic: AVG</p>
|
|
497
|
+
* </dd>
|
|
498
|
+
* <dt>INTERACTION_AND_HOLD_TIME</dt>
|
|
499
|
+
* <dd>
|
|
500
|
+
* <p>Unit: SECONDS</p>
|
|
501
|
+
* <p>Statistic: AVG</p>
|
|
502
|
+
* </dd>
|
|
503
|
+
* <dt>INTERACTION_TIME</dt>
|
|
504
|
+
* <dd>
|
|
505
|
+
* <p>Unit: SECONDS</p>
|
|
506
|
+
* <p>Statistic: AVG</p>
|
|
507
|
+
* </dd>
|
|
508
|
+
* <dt>OCCUPANCY</dt>
|
|
509
|
+
* <dd>
|
|
510
|
+
* <p>Unit: PERCENT</p>
|
|
511
|
+
* <p>Statistic: AVG</p>
|
|
512
|
+
* </dd>
|
|
513
|
+
* <dt>QUEUE_ANSWER_TIME</dt>
|
|
514
|
+
* <dd>
|
|
515
|
+
* <p>Unit: SECONDS</p>
|
|
516
|
+
* <p>Statistic: AVG</p>
|
|
517
|
+
* </dd>
|
|
518
|
+
* <dt>QUEUED_TIME</dt>
|
|
519
|
+
* <dd>
|
|
520
|
+
* <p>Unit: SECONDS</p>
|
|
521
|
+
* <p>Statistic: MAX</p>
|
|
522
|
+
* </dd>
|
|
523
|
+
* <dt>SERVICE_LEVEL</dt>
|
|
524
|
+
* <dd>
|
|
525
|
+
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
526
|
+
* <p>Unit: PERCENT</p>
|
|
527
|
+
* <p>Statistic: AVG</p>
|
|
528
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
529
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
530
|
+
* "Less than"). </p>
|
|
531
|
+
* </dd>
|
|
532
|
+
* </dl>
|
|
533
|
+
*/
|
|
534
|
+
HistoricalMetrics: HistoricalMetric[] | undefined;
|
|
535
|
+
/**
|
|
536
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
537
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
538
|
+
*/
|
|
539
|
+
NextToken?: string;
|
|
540
|
+
/**
|
|
541
|
+
* <p>The maximum number of results to return per page.</p>
|
|
542
|
+
*/
|
|
543
|
+
MaxResults?: number;
|
|
544
|
+
}
|
|
545
|
+
/**
|
|
546
|
+
* @public
|
|
547
|
+
* <p>Contains the data for a historical metric.</p>
|
|
548
|
+
*/
|
|
549
|
+
export interface HistoricalMetricData {
|
|
550
|
+
/**
|
|
551
|
+
* <p>Information about the metric.</p>
|
|
552
|
+
*/
|
|
553
|
+
Metric?: HistoricalMetric;
|
|
554
|
+
/**
|
|
555
|
+
* <p>The value of the metric.</p>
|
|
556
|
+
*/
|
|
557
|
+
Value?: number;
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
* @public
|
|
561
|
+
* <p>Contains information about the historical metrics retrieved.</p>
|
|
562
|
+
*/
|
|
563
|
+
export interface HistoricalMetricResult {
|
|
564
|
+
/**
|
|
565
|
+
* <p>The dimension for the metrics.</p>
|
|
566
|
+
*/
|
|
567
|
+
Dimensions?: Dimensions;
|
|
568
|
+
/**
|
|
569
|
+
* <p>The set of metrics.</p>
|
|
570
|
+
*/
|
|
571
|
+
Collections?: HistoricalMetricData[];
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
export interface GetMetricDataResponse {
|
|
577
|
+
/**
|
|
578
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
579
|
+
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
580
|
+
* the token must use the same request parameters as the request that generated the token.</p>
|
|
581
|
+
*/
|
|
582
|
+
NextToken?: string;
|
|
583
|
+
/**
|
|
584
|
+
* <p>Information about the historical metrics.</p>
|
|
585
|
+
* <p>If no grouping is specified, a summary of metric data is returned.</p>
|
|
586
|
+
*/
|
|
587
|
+
MetricResults?: HistoricalMetricResult[];
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
* <p>Contains the filter to apply when retrieving metrics with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API.</p>
|
|
592
|
+
*/
|
|
593
|
+
export interface FilterV2 {
|
|
594
|
+
/**
|
|
595
|
+
* <p>The key to use for filtering data. For example, <code>QUEUE</code>, <code>ROUTING_PROFILE,
|
|
596
|
+
* AGENT</code>, <code>CHANNEL</code>, <code>AGENT_HIERARCHY_LEVEL_ONE</code>,
|
|
597
|
+
* <code>AGENT_HIERARCHY_LEVEL_TWO</code>, <code>AGENT_HIERARCHY_LEVEL_THREE</code>,
|
|
598
|
+
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code>, <code>AGENT_HIERARCHY_LEVEL_FIVE</code>. There must be
|
|
599
|
+
* at least 1 key and a maximum 5 keys. </p>
|
|
600
|
+
*/
|
|
601
|
+
FilterKey?: string;
|
|
602
|
+
/**
|
|
603
|
+
* <p>The identifiers to use for filtering data. For example, if you have a filter key of
|
|
604
|
+
* <code>QUEUE</code>, you would add queue IDs or ARNs in <code>FilterValues</code>. </p>
|
|
605
|
+
*/
|
|
606
|
+
FilterValues?: string[];
|
|
607
|
+
}
|
|
608
|
+
/**
|
|
609
|
+
* @public
|
|
610
|
+
* <p>Contains information about the filter used when retrieving metrics.
|
|
611
|
+
* <code>MetricFiltersV2</code> can be used on the following metrics:
|
|
612
|
+
* <code>AVG_AGENT_CONNECTING_TIME</code>, <code>CONTACTS_CREATED</code>,
|
|
613
|
+
* <code>CONTACTS_HANDLED</code>, <code>SUM_CONTACTS_DISCONNECTED</code>.</p>
|
|
614
|
+
*/
|
|
615
|
+
export interface MetricFilterV2 {
|
|
616
|
+
/**
|
|
617
|
+
* <p>The key to use for filtering data. </p>
|
|
618
|
+
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
|
|
619
|
+
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
|
|
620
|
+
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
|
|
621
|
+
*/
|
|
622
|
+
MetricFilterKey?: string;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The values to use for filtering data. </p>
|
|
625
|
+
* <p>Valid metric filter values for <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
|
|
626
|
+
* <code>OUTBOUND</code> | <code>TRANSFER</code> | <code>QUEUE_TRANSFER</code> |
|
|
627
|
+
* <code>CALLBACK</code> | <code>API</code>
|
|
628
|
+
* </p>
|
|
629
|
+
* <p>Valid metric filter values for <code>DISCONNECT_REASON</code>:
|
|
630
|
+
* <code>CUSTOMER_DISCONNECT</code> | <code>AGENT_DISCONNECT</code> |
|
|
631
|
+
* <code>THIRD_PARTY_DISCONNECT</code> | <code>TELECOM_PROBLEM</code> | <code>BARGED</code> |
|
|
632
|
+
* <code>CONTACT_FLOW_DISCONNECT</code> | <code>OTHER</code> | <code>EXPIRED</code> |
|
|
633
|
+
* <code>API</code>
|
|
634
|
+
* </p>
|
|
635
|
+
*/
|
|
636
|
+
MetricFilterValues?: string[];
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
* <p>Contains information about the threshold for service level metrics.</p>
|
|
641
|
+
*/
|
|
642
|
+
export interface ThresholdV2 {
|
|
643
|
+
/**
|
|
644
|
+
* <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
|
|
645
|
+
*/
|
|
646
|
+
Comparison?: string;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The threshold value to compare.</p>
|
|
649
|
+
*/
|
|
650
|
+
ThresholdValue?: number;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
* <p>Contains information about the metric.</p>
|
|
655
|
+
*/
|
|
656
|
+
export interface MetricV2 {
|
|
657
|
+
/**
|
|
658
|
+
* <p>The name of the metric.</p>
|
|
659
|
+
*/
|
|
660
|
+
Name?: string;
|
|
661
|
+
/**
|
|
662
|
+
* <p>Contains information about the threshold for service level metrics.</p>
|
|
663
|
+
*/
|
|
664
|
+
Threshold?: ThresholdV2[];
|
|
665
|
+
/**
|
|
666
|
+
* <p>Contains the filters to be used when returning data.</p>
|
|
667
|
+
*/
|
|
668
|
+
MetricFilters?: MetricFilterV2[];
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
export interface GetMetricDataV2Request {
|
|
674
|
+
/**
|
|
675
|
+
* <p>The Amazon Resource Name (ARN) of the resource. This includes the <code>instanceId</code> an Amazon Connect
|
|
676
|
+
* instance.</p>
|
|
677
|
+
*/
|
|
678
|
+
ResourceArn: string | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
681
|
+
* retrieval of historical metrics data. The time must be before the end time timestamp. The time
|
|
682
|
+
* range between the start and end time must be less than 24 hours. The start time cannot be earlier
|
|
683
|
+
* than 14 days before the time of the request. Historical metrics are available for 14 days.</p>
|
|
684
|
+
*/
|
|
685
|
+
StartTime: Date | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
688
|
+
* retrieval of historical metrics data. The time must be later than the start time timestamp. It
|
|
689
|
+
* cannot be later than the current timestamp.</p>
|
|
690
|
+
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
691
|
+
*/
|
|
692
|
+
EndTime: Date | undefined;
|
|
693
|
+
/**
|
|
694
|
+
* <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
|
|
695
|
+
* <ul>
|
|
696
|
+
* <li>
|
|
697
|
+
* <p>Queues</p>
|
|
698
|
+
* </li>
|
|
699
|
+
* <li>
|
|
700
|
+
* <p>Routing profiles</p>
|
|
701
|
+
* </li>
|
|
702
|
+
* <li>
|
|
703
|
+
* <p>Agents</p>
|
|
704
|
+
* </li>
|
|
705
|
+
* <li>
|
|
706
|
+
* <p>Channels</p>
|
|
707
|
+
* </li>
|
|
708
|
+
* <li>
|
|
709
|
+
* <p>User hierarchy groups</p>
|
|
710
|
+
* </li>
|
|
711
|
+
* </ul>
|
|
712
|
+
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
|
|
713
|
+
* groups.</p>
|
|
714
|
+
* <p>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical
|
|
715
|
+
* metrics report</a> in the <i>Amazon Connect Administrator's
|
|
716
|
+
* Guide</i>.</p>
|
|
717
|
+
* <p>Note the following limits:</p>
|
|
718
|
+
* <ul>
|
|
719
|
+
* <li>
|
|
720
|
+
* <p>
|
|
721
|
+
* <b>Filter keys</b>: A maximum of 5 filter keys are supported in
|
|
722
|
+
* a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
|
|
723
|
+
* <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
724
|
+
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
725
|
+
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
|
|
726
|
+
* </p>
|
|
727
|
+
* </li>
|
|
728
|
+
* <li>
|
|
729
|
+
* <p>
|
|
730
|
+
* <b>Filter values</b>: A maximum of 100 filter values are
|
|
731
|
+
* supported in a single request. For example, a <code>GetMetricDataV2</code> request can filter
|
|
732
|
+
* by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values.
|
|
733
|
+
* <code>VOICE</code>, <code>CHAT</code>, and <code>TASK</code> are valid
|
|
734
|
+
* <code>filterValue</code> for the <code>CHANNEL</code> filter key.</p>
|
|
735
|
+
* </li>
|
|
736
|
+
* </ul>
|
|
737
|
+
*/
|
|
738
|
+
Filters: FilterV2[] | undefined;
|
|
739
|
+
/**
|
|
740
|
+
* <p>The grouping applied to the metrics that are returned. For example, when results are grouped
|
|
741
|
+
* by queue, the metrics returned are grouped by queue. The values that are returned apply to the
|
|
742
|
+
* metrics for each queue. They are not aggregated for all queues.</p>
|
|
743
|
+
* <p>If no grouping is specified, a summary of all metrics is returned.</p>
|
|
744
|
+
* <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
|
|
745
|
+
* | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
746
|
+
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
747
|
+
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
|
|
748
|
+
* </p>
|
|
749
|
+
*/
|
|
750
|
+
Groupings?: string[];
|
|
751
|
+
/**
|
|
752
|
+
* <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
|
|
753
|
+
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator's
|
|
754
|
+
* Guide</i>.</p>
|
|
755
|
+
* <dl>
|
|
756
|
+
* <dt>AGENT_ADHERENT_TIME</dt>
|
|
757
|
+
* <dd>
|
|
758
|
+
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
759
|
+
* <p>Unit: Seconds</p>
|
|
760
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
761
|
+
* </dd>
|
|
762
|
+
* <dt>AGENT_NON_RESPONSE</dt>
|
|
763
|
+
* <dd>
|
|
764
|
+
* <p>Unit: Count</p>
|
|
765
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
766
|
+
* </dd>
|
|
767
|
+
* <dt>AGENT_OCCUPANCY</dt>
|
|
768
|
+
* <dd>
|
|
769
|
+
* <p>Unit: Percentage</p>
|
|
770
|
+
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p>
|
|
771
|
+
* </dd>
|
|
772
|
+
* <dt>AGENT_SCHEDULE_ADHERENCE</dt>
|
|
773
|
+
* <dd>
|
|
774
|
+
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
775
|
+
* <p>Unit: Percent</p>
|
|
776
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
777
|
+
* </dd>
|
|
778
|
+
* <dt>AGENT_SCHEDULED_TIME</dt>
|
|
779
|
+
* <dd>
|
|
780
|
+
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
781
|
+
* <p>Unit: Seconds</p>
|
|
782
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
783
|
+
* </dd>
|
|
784
|
+
* <dt>AVG_ABANDON_TIME</dt>
|
|
785
|
+
* <dd>
|
|
786
|
+
* <p>Unit: Seconds</p>
|
|
787
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
788
|
+
* </dd>
|
|
789
|
+
* <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
|
|
790
|
+
* <dd>
|
|
791
|
+
* <p>Unit: Seconds</p>
|
|
792
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
793
|
+
* </dd>
|
|
794
|
+
* <dt>AVG_AGENT_CONNECTING_TIME</dt>
|
|
795
|
+
* <dd>
|
|
796
|
+
* <p>Unit: Seconds</p>
|
|
797
|
+
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
|
|
798
|
+
* supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
|
|
799
|
+
* <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
|
|
800
|
+
* </p>
|
|
801
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
802
|
+
* </dd>
|
|
803
|
+
* <dt>AVG_HANDLE_TIME</dt>
|
|
804
|
+
* <dd>
|
|
805
|
+
* <p>Unit: Seconds</p>
|
|
806
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
807
|
+
* </dd>
|
|
808
|
+
* <dt>AVG_HOLD_TIME</dt>
|
|
809
|
+
* <dd>
|
|
810
|
+
* <p>Unit: Seconds</p>
|
|
811
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
812
|
+
* </dd>
|
|
813
|
+
* <dt>AVG_INTERACTION_AND_HOLD_TIME</dt>
|
|
814
|
+
* <dd>
|
|
815
|
+
* <p>Unit: Seconds</p>
|
|
816
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
817
|
+
* </dd>
|
|
818
|
+
* <dt>AVG_INTERACTION_TIME</dt>
|
|
819
|
+
* <dd>
|
|
820
|
+
* <p>Unit: Seconds</p>
|
|
821
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
822
|
+
* </dd>
|
|
823
|
+
* <dt>AVG_QUEUE_ANSWER_TIME</dt>
|
|
824
|
+
* <dd>
|
|
825
|
+
* <p>Unit: Seconds</p>
|
|
826
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
827
|
+
* </dd>
|
|
828
|
+
* <dt>CONTACTS_ABANDONED</dt>
|
|
829
|
+
* <dd>
|
|
830
|
+
* <p>Unit: Count</p>
|
|
831
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
832
|
+
* </dd>
|
|
833
|
+
* <dt>CONTACTS_CREATED</dt>
|
|
834
|
+
* <dd>
|
|
835
|
+
* <p>Unit: Count</p>
|
|
836
|
+
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>
|
|
837
|
+
* </p>
|
|
838
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
839
|
+
* </dd>
|
|
840
|
+
* <dt>CONTACTS_HANDLED</dt>
|
|
841
|
+
* <dd>
|
|
842
|
+
* <p>Unit: Count</p>
|
|
843
|
+
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>,
|
|
844
|
+
* <code>DISCONNECT_REASON</code>
|
|
845
|
+
* </p>
|
|
846
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
847
|
+
* </dd>
|
|
848
|
+
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
849
|
+
* <dd>
|
|
850
|
+
* <p>Unit: Count</p>
|
|
851
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
852
|
+
* </dd>
|
|
853
|
+
* <dt>CONTACTS_QUEUED</dt>
|
|
854
|
+
* <dd>
|
|
855
|
+
* <p>Unit: Count</p>
|
|
856
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
857
|
+
* </dd>
|
|
858
|
+
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
859
|
+
* <dd>
|
|
860
|
+
* <p>Unit: Count</p>
|
|
861
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
862
|
+
* </dd>
|
|
863
|
+
* <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt>
|
|
864
|
+
* <dd>
|
|
865
|
+
* <p>Unit: Count</p>
|
|
866
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
867
|
+
* </dd>
|
|
868
|
+
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
869
|
+
* <dd>
|
|
870
|
+
* <p>Unit: Count</p>
|
|
871
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
872
|
+
* </dd>
|
|
873
|
+
* <dt>MAX_QUEUED_TIME</dt>
|
|
874
|
+
* <dd>
|
|
875
|
+
* <p>Unit: Seconds</p>
|
|
876
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
877
|
+
* </dd>
|
|
878
|
+
* <dt>SERVICE_LEVEL</dt>
|
|
879
|
+
* <dd>
|
|
880
|
+
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
881
|
+
* <p>Unit: Percent</p>
|
|
882
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
883
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
884
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
885
|
+
* "Less than"). </p>
|
|
886
|
+
* </dd>
|
|
887
|
+
* <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
|
|
888
|
+
* <dd>
|
|
889
|
+
* <p>Unit: Count</p>
|
|
890
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
891
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
892
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
893
|
+
* "Less than"). </p>
|
|
894
|
+
* </dd>
|
|
895
|
+
* <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
|
|
896
|
+
* <dd>
|
|
897
|
+
* <p>Unit: Count</p>
|
|
898
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
899
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
900
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
901
|
+
* "Less than"). </p>
|
|
902
|
+
* </dd>
|
|
903
|
+
* <dt>SUM_CONTACTS_DISCONNECTED </dt>
|
|
904
|
+
* <dd>
|
|
905
|
+
* <p>Valid metric filter key: <code>DISCONNECT_REASON</code>
|
|
906
|
+
* </p>
|
|
907
|
+
* <p>Unit: Count</p>
|
|
908
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
909
|
+
* </dd>
|
|
910
|
+
* <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt>
|
|
911
|
+
* <dd>
|
|
912
|
+
* <p>Unit: Count</p>
|
|
913
|
+
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
914
|
+
* </dd>
|
|
915
|
+
* </dl>
|
|
916
|
+
*/
|
|
917
|
+
Metrics: MetricV2[] | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
920
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
921
|
+
*/
|
|
922
|
+
NextToken?: string;
|
|
923
|
+
/**
|
|
924
|
+
* <p>The maximum number of results to return per page.</p>
|
|
925
|
+
*/
|
|
926
|
+
MaxResults?: number;
|
|
927
|
+
}
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
* <p>Contains the name, thresholds, and metric filters.</p>
|
|
931
|
+
*/
|
|
932
|
+
export interface MetricDataV2 {
|
|
933
|
+
/**
|
|
934
|
+
* <p>The metric name, thresholds, and metric filters of the returned metric.</p>
|
|
935
|
+
*/
|
|
936
|
+
Metric?: MetricV2;
|
|
937
|
+
/**
|
|
938
|
+
* <p>The corresponding value of the metric returned in the response.</p>
|
|
939
|
+
*/
|
|
940
|
+
Value?: number;
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* @public
|
|
944
|
+
* <p>Contains information about the metric results.</p>
|
|
945
|
+
*/
|
|
946
|
+
export interface MetricResultV2 {
|
|
947
|
+
/**
|
|
948
|
+
* <p>The dimension for the metrics.</p>
|
|
949
|
+
*/
|
|
950
|
+
Dimensions?: Record<string, string>;
|
|
951
|
+
/**
|
|
952
|
+
* <p>The set of metrics.</p>
|
|
953
|
+
*/
|
|
954
|
+
Collections?: MetricDataV2[];
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
export interface GetMetricDataV2Response {
|
|
960
|
+
/**
|
|
961
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
962
|
+
*/
|
|
963
|
+
NextToken?: string;
|
|
964
|
+
/**
|
|
965
|
+
* <p>Information about the metrics requested in the API request If no grouping is specified, a
|
|
966
|
+
* summary of metric data is returned. </p>
|
|
967
|
+
*/
|
|
968
|
+
MetricResults?: MetricResultV2[];
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
export interface GetTaskTemplateRequest {
|
|
974
|
+
/**
|
|
975
|
+
* <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>
|
|
976
|
+
*/
|
|
977
|
+
InstanceId: string | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>A unique identifier for the task template.</p>
|
|
980
|
+
*/
|
|
981
|
+
TaskTemplateId: string | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* <p>The system generated version of a task template that is associated with a task, when the
|
|
984
|
+
* task is created.</p>
|
|
985
|
+
*/
|
|
986
|
+
SnapshotVersion?: string;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* @public
|
|
990
|
+
*/
|
|
991
|
+
export interface GetTaskTemplateResponse {
|
|
992
|
+
/**
|
|
993
|
+
* <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>
|
|
994
|
+
*/
|
|
995
|
+
InstanceId?: string;
|
|
996
|
+
/**
|
|
997
|
+
* <p>A unique identifier for the task template.</p>
|
|
998
|
+
*/
|
|
999
|
+
Id: string | undefined;
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>The Amazon Resource Name (ARN).</p>
|
|
1002
|
+
*/
|
|
1003
|
+
Arn: string | undefined;
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The name of the task template.</p>
|
|
1006
|
+
*/
|
|
1007
|
+
Name: string | undefined;
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The description of the task template.</p>
|
|
1010
|
+
*/
|
|
1011
|
+
Description?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
1014
|
+
*/
|
|
1015
|
+
ContactFlowId?: string;
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>Constraints that are applicable to the fields listed.</p>
|
|
1018
|
+
*/
|
|
1019
|
+
Constraints?: TaskTemplateConstraints;
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
1022
|
+
*/
|
|
1023
|
+
Defaults?: TaskTemplateDefaults;
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>Fields that are part of the template.</p>
|
|
1026
|
+
*/
|
|
1027
|
+
Fields?: TaskTemplateField[];
|
|
1028
|
+
/**
|
|
1029
|
+
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
1030
|
+
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
1031
|
+
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
1032
|
+
*/
|
|
1033
|
+
Status?: TaskTemplateStatus | string;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>The timestamp when the task template was last modified.</p>
|
|
1036
|
+
*/
|
|
1037
|
+
LastModifiedTime?: Date;
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>The timestamp when the task template was created.</p>
|
|
1040
|
+
*/
|
|
1041
|
+
CreatedTime?: Date;
|
|
1042
|
+
/**
|
|
1043
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1044
|
+
*/
|
|
1045
|
+
Tags?: Record<string, string>;
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
export interface GetTrafficDistributionRequest {
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>The identifier of the traffic distribution group.</p>
|
|
1053
|
+
*/
|
|
1054
|
+
Id: string | undefined;
|
|
1055
|
+
}
|
|
1056
|
+
/**
|
|
1057
|
+
* @public
|
|
1058
|
+
* <p>Information about a traffic distribution.</p>
|
|
1059
|
+
*/
|
|
1060
|
+
export interface Distribution {
|
|
1061
|
+
/**
|
|
1062
|
+
* <p>The Amazon Web Services Region where the traffic is distributed.</p>
|
|
1063
|
+
*/
|
|
1064
|
+
Region: string | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>The percentage of the traffic that is distributed, in increments of 10.</p>
|
|
1067
|
+
*/
|
|
1068
|
+
Percentage: number | undefined;
|
|
1069
|
+
}
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
1073
|
+
*/
|
|
1074
|
+
export interface TelephonyConfig {
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>Information about traffic distributions.</p>
|
|
1077
|
+
*/
|
|
1078
|
+
Distributions: Distribution[] | undefined;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
export interface GetTrafficDistributionResponse {
|
|
1084
|
+
/**
|
|
1085
|
+
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
1086
|
+
*/
|
|
1087
|
+
TelephonyConfig?: TelephonyConfig;
|
|
1088
|
+
/**
|
|
1089
|
+
* <p>The identifier of the traffic distribution group.
|
|
1090
|
+
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
1091
|
+
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
1092
|
+
*/
|
|
1093
|
+
Id?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
1096
|
+
*/
|
|
1097
|
+
Arn?: string;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
export interface ListAgentStatusRequest {
|
|
1103
|
+
/**
|
|
1104
|
+
* <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>
|
|
1105
|
+
*/
|
|
1106
|
+
InstanceId: string | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1109
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1110
|
+
*/
|
|
1111
|
+
NextToken?: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1114
|
+
*/
|
|
1115
|
+
MaxResults?: number;
|
|
1116
|
+
/**
|
|
1117
|
+
* <p>Available agent status types.</p>
|
|
1118
|
+
*/
|
|
1119
|
+
AgentStatusTypes?: (AgentStatusType | string)[];
|
|
1120
|
+
}
|
|
4
1121
|
/**
|
|
5
1122
|
* @public
|
|
6
1123
|
*/
|
|
@@ -107,6 +1224,86 @@ export interface ListBotsResponse {
|
|
|
107
1224
|
*/
|
|
108
1225
|
NextToken?: string;
|
|
109
1226
|
}
|
|
1227
|
+
/**
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
export interface ListContactEvaluationsRequest {
|
|
1231
|
+
/**
|
|
1232
|
+
* <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>
|
|
1233
|
+
*/
|
|
1234
|
+
InstanceId: string | undefined;
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1237
|
+
*/
|
|
1238
|
+
ContactId: string | undefined;
|
|
1239
|
+
/**
|
|
1240
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1241
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1242
|
+
* <important>
|
|
1243
|
+
* <p>This is not expected to be set because the value returned in the previous response is
|
|
1244
|
+
* always null.</p>
|
|
1245
|
+
* </important>
|
|
1246
|
+
*/
|
|
1247
|
+
NextToken?: string;
|
|
1248
|
+
}
|
|
1249
|
+
/**
|
|
1250
|
+
* @public
|
|
1251
|
+
* <p>Summary information about a contact evaluation.</p>
|
|
1252
|
+
*/
|
|
1253
|
+
export interface EvaluationSummary {
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
1256
|
+
*/
|
|
1257
|
+
EvaluationId: string | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
1260
|
+
*/
|
|
1261
|
+
EvaluationArn: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>A unique title of the evaluation form.</p>
|
|
1264
|
+
*/
|
|
1265
|
+
EvaluationFormTitle: string | undefined;
|
|
1266
|
+
/**
|
|
1267
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1268
|
+
*/
|
|
1269
|
+
EvaluationFormId: string | undefined;
|
|
1270
|
+
/**
|
|
1271
|
+
* <p>The status of the contact evaluation.</p>
|
|
1272
|
+
*/
|
|
1273
|
+
Status: EvaluationStatus | string | undefined;
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
|
|
1276
|
+
*/
|
|
1277
|
+
EvaluatorArn: string | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* <p>The overall score of the contact evaluation.</p>
|
|
1280
|
+
*/
|
|
1281
|
+
Score?: EvaluationScore;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>The timestamp for when the evaluation was created.</p>
|
|
1284
|
+
*/
|
|
1285
|
+
CreatedTime: Date | undefined;
|
|
1286
|
+
/**
|
|
1287
|
+
* <p>The timestamp for when the evaluation was last updated.</p>
|
|
1288
|
+
*/
|
|
1289
|
+
LastModifiedTime: Date | undefined;
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
export interface ListContactEvaluationsResponse {
|
|
1295
|
+
/**
|
|
1296
|
+
* <p>Provides details about a list of contact evaluations belonging to an instance.</p>
|
|
1297
|
+
*/
|
|
1298
|
+
EvaluationSummaryList: EvaluationSummary[] | undefined;
|
|
1299
|
+
/**
|
|
1300
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1301
|
+
* <important>
|
|
1302
|
+
* <p>This is always returned as null in the response.</p>
|
|
1303
|
+
* </important>
|
|
1304
|
+
*/
|
|
1305
|
+
NextToken?: string;
|
|
1306
|
+
}
|
|
110
1307
|
/**
|
|
111
1308
|
* @public
|
|
112
1309
|
*/
|
|
@@ -535,9 +1732,167 @@ export interface DefaultVocabulary {
|
|
|
535
1732
|
*/
|
|
536
1733
|
export interface ListDefaultVocabulariesResponse {
|
|
537
1734
|
/**
|
|
538
|
-
* <p>A list of default vocabularies.</p>
|
|
1735
|
+
* <p>A list of default vocabularies.</p>
|
|
1736
|
+
*/
|
|
1737
|
+
DefaultVocabularyList: DefaultVocabulary[] | undefined;
|
|
1738
|
+
/**
|
|
1739
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1740
|
+
*/
|
|
1741
|
+
NextToken?: string;
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* @public
|
|
1745
|
+
*/
|
|
1746
|
+
export interface ListEvaluationFormsRequest {
|
|
1747
|
+
/**
|
|
1748
|
+
* <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>
|
|
1749
|
+
*/
|
|
1750
|
+
InstanceId: string | undefined;
|
|
1751
|
+
/**
|
|
1752
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1753
|
+
*/
|
|
1754
|
+
MaxResults?: number;
|
|
1755
|
+
/**
|
|
1756
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1757
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1758
|
+
*/
|
|
1759
|
+
NextToken?: string;
|
|
1760
|
+
}
|
|
1761
|
+
/**
|
|
1762
|
+
* @public
|
|
1763
|
+
* <p>Summary information about an evaluation form.</p>
|
|
1764
|
+
*/
|
|
1765
|
+
export interface EvaluationFormSummary {
|
|
1766
|
+
/**
|
|
1767
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1768
|
+
*/
|
|
1769
|
+
EvaluationFormId: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
1772
|
+
*/
|
|
1773
|
+
EvaluationFormArn: string | undefined;
|
|
1774
|
+
/**
|
|
1775
|
+
* <p>A unique title of the evaluation form.</p>
|
|
1776
|
+
*/
|
|
1777
|
+
Title: string | undefined;
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>The timestamp for when the evaluation form was created.</p>
|
|
1780
|
+
*/
|
|
1781
|
+
CreatedTime: Date | undefined;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
1784
|
+
*/
|
|
1785
|
+
CreatedBy: string | undefined;
|
|
1786
|
+
/**
|
|
1787
|
+
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
1788
|
+
*/
|
|
1789
|
+
LastModifiedTime: Date | undefined;
|
|
1790
|
+
/**
|
|
1791
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
1792
|
+
*/
|
|
1793
|
+
LastModifiedBy: string | undefined;
|
|
1794
|
+
/**
|
|
1795
|
+
* <p>The timestamp for when the evaluation form was last activated.</p>
|
|
1796
|
+
*/
|
|
1797
|
+
LastActivatedTime?: Date;
|
|
1798
|
+
/**
|
|
1799
|
+
* <p> The Amazon Resource Name (ARN) of the user who last activated the evaluation form.</p>
|
|
1800
|
+
*/
|
|
1801
|
+
LastActivatedBy?: string;
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>The version number of the latest evaluation form version.</p>
|
|
1804
|
+
*/
|
|
1805
|
+
LatestVersion: number | undefined;
|
|
1806
|
+
/**
|
|
1807
|
+
* <p>The version of the active evaluation form version.</p>
|
|
1808
|
+
*/
|
|
1809
|
+
ActiveVersion?: number;
|
|
1810
|
+
}
|
|
1811
|
+
/**
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
export interface ListEvaluationFormsResponse {
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>Provides details about a list of evaluation forms belonging to an instance.</p>
|
|
1817
|
+
*/
|
|
1818
|
+
EvaluationFormSummaryList: EvaluationFormSummary[] | undefined;
|
|
1819
|
+
/**
|
|
1820
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1821
|
+
*/
|
|
1822
|
+
NextToken?: string;
|
|
1823
|
+
}
|
|
1824
|
+
/**
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
export interface ListEvaluationFormVersionsRequest {
|
|
1828
|
+
/**
|
|
1829
|
+
* <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>
|
|
1830
|
+
*/
|
|
1831
|
+
InstanceId: string | undefined;
|
|
1832
|
+
/**
|
|
1833
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1834
|
+
*/
|
|
1835
|
+
EvaluationFormId: string | undefined;
|
|
1836
|
+
/**
|
|
1837
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1838
|
+
*/
|
|
1839
|
+
MaxResults?: number;
|
|
1840
|
+
/**
|
|
1841
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1842
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1843
|
+
*/
|
|
1844
|
+
NextToken?: string;
|
|
1845
|
+
}
|
|
1846
|
+
/**
|
|
1847
|
+
* @public
|
|
1848
|
+
* <p>Summary information about an evaluation form.</p>
|
|
1849
|
+
*/
|
|
1850
|
+
export interface EvaluationFormVersionSummary {
|
|
1851
|
+
/**
|
|
1852
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
1853
|
+
*/
|
|
1854
|
+
EvaluationFormArn: string | undefined;
|
|
1855
|
+
/**
|
|
1856
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1857
|
+
*/
|
|
1858
|
+
EvaluationFormId: string | undefined;
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>A version of the evaluation form.</p>
|
|
1861
|
+
*/
|
|
1862
|
+
EvaluationFormVersion: number | undefined;
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>The flag indicating whether the evaluation form is locked for changes.</p>
|
|
1865
|
+
*/
|
|
1866
|
+
Locked: boolean | undefined;
|
|
1867
|
+
/**
|
|
1868
|
+
* <p>The status of the evaluation form.</p>
|
|
1869
|
+
*/
|
|
1870
|
+
Status: EvaluationFormVersionStatus | string | undefined;
|
|
1871
|
+
/**
|
|
1872
|
+
* <p>The timestamp for when the evaluation form was created.</p>
|
|
1873
|
+
*/
|
|
1874
|
+
CreatedTime: Date | undefined;
|
|
1875
|
+
/**
|
|
1876
|
+
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
1877
|
+
*/
|
|
1878
|
+
CreatedBy: string | undefined;
|
|
1879
|
+
/**
|
|
1880
|
+
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
1881
|
+
*/
|
|
1882
|
+
LastModifiedTime: Date | undefined;
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
1885
|
+
*/
|
|
1886
|
+
LastModifiedBy: string | undefined;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* @public
|
|
1890
|
+
*/
|
|
1891
|
+
export interface ListEvaluationFormVersionsResponse {
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>Provides details about a list of evaluation forms belonging to an instance.</p>
|
|
539
1894
|
*/
|
|
540
|
-
|
|
1895
|
+
EvaluationFormVersionSummaryList: EvaluationFormVersionSummary[] | undefined;
|
|
541
1896
|
/**
|
|
542
1897
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
543
1898
|
*/
|
|
@@ -2711,6 +4066,43 @@ export interface StartChatContactResponse {
|
|
|
2711
4066
|
*/
|
|
2712
4067
|
ContinuedFromContactId?: string;
|
|
2713
4068
|
}
|
|
4069
|
+
/**
|
|
4070
|
+
* @public
|
|
4071
|
+
*/
|
|
4072
|
+
export interface StartContactEvaluationRequest {
|
|
4073
|
+
/**
|
|
4074
|
+
* <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>
|
|
4075
|
+
*/
|
|
4076
|
+
InstanceId: string | undefined;
|
|
4077
|
+
/**
|
|
4078
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
4079
|
+
*/
|
|
4080
|
+
ContactId: string | undefined;
|
|
4081
|
+
/**
|
|
4082
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
4083
|
+
*/
|
|
4084
|
+
EvaluationFormId: string | undefined;
|
|
4085
|
+
/**
|
|
4086
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
4087
|
+
* request. If not provided, the Amazon Web Services
|
|
4088
|
+
* SDK populates this field. For more information about idempotency, see
|
|
4089
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4090
|
+
*/
|
|
4091
|
+
ClientToken?: string;
|
|
4092
|
+
}
|
|
4093
|
+
/**
|
|
4094
|
+
* @public
|
|
4095
|
+
*/
|
|
4096
|
+
export interface StartContactEvaluationResponse {
|
|
4097
|
+
/**
|
|
4098
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
4099
|
+
*/
|
|
4100
|
+
EvaluationId: string | undefined;
|
|
4101
|
+
/**
|
|
4102
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
4103
|
+
*/
|
|
4104
|
+
EvaluationArn: string | undefined;
|
|
4105
|
+
}
|
|
2714
4106
|
/**
|
|
2715
4107
|
* @public
|
|
2716
4108
|
* @enum
|
|
@@ -3093,6 +4485,50 @@ export interface StopContactStreamingRequest {
|
|
|
3093
4485
|
*/
|
|
3094
4486
|
export interface StopContactStreamingResponse {
|
|
3095
4487
|
}
|
|
4488
|
+
/**
|
|
4489
|
+
* @public
|
|
4490
|
+
* <p>Information about input answers for a contact evaluation.</p>
|
|
4491
|
+
*/
|
|
4492
|
+
export interface EvaluationAnswerInput {
|
|
4493
|
+
/**
|
|
4494
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
4495
|
+
*/
|
|
4496
|
+
Value?: EvaluationAnswerData;
|
|
4497
|
+
}
|
|
4498
|
+
/**
|
|
4499
|
+
* @public
|
|
4500
|
+
*/
|
|
4501
|
+
export interface SubmitContactEvaluationRequest {
|
|
4502
|
+
/**
|
|
4503
|
+
* <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>
|
|
4504
|
+
*/
|
|
4505
|
+
InstanceId: string | undefined;
|
|
4506
|
+
/**
|
|
4507
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
4508
|
+
*/
|
|
4509
|
+
EvaluationId: string | undefined;
|
|
4510
|
+
/**
|
|
4511
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
4512
|
+
*/
|
|
4513
|
+
Answers?: Record<string, EvaluationAnswerInput>;
|
|
4514
|
+
/**
|
|
4515
|
+
* <p>A map of question identifiers to note value.</p>
|
|
4516
|
+
*/
|
|
4517
|
+
Notes?: Record<string, EvaluationNote>;
|
|
4518
|
+
}
|
|
4519
|
+
/**
|
|
4520
|
+
* @public
|
|
4521
|
+
*/
|
|
4522
|
+
export interface SubmitContactEvaluationResponse {
|
|
4523
|
+
/**
|
|
4524
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
4525
|
+
*/
|
|
4526
|
+
EvaluationId: string | undefined;
|
|
4527
|
+
/**
|
|
4528
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
4529
|
+
*/
|
|
4530
|
+
EvaluationArn: string | undefined;
|
|
4531
|
+
}
|
|
3096
4532
|
/**
|
|
3097
4533
|
* @public
|
|
3098
4534
|
*/
|
|
@@ -3277,6 +4713,40 @@ export interface UpdateContactAttributesRequest {
|
|
|
3277
4713
|
*/
|
|
3278
4714
|
export interface UpdateContactAttributesResponse {
|
|
3279
4715
|
}
|
|
4716
|
+
/**
|
|
4717
|
+
* @public
|
|
4718
|
+
*/
|
|
4719
|
+
export interface UpdateContactEvaluationRequest {
|
|
4720
|
+
/**
|
|
4721
|
+
* <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>
|
|
4722
|
+
*/
|
|
4723
|
+
InstanceId: string | undefined;
|
|
4724
|
+
/**
|
|
4725
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
4726
|
+
*/
|
|
4727
|
+
EvaluationId: string | undefined;
|
|
4728
|
+
/**
|
|
4729
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
4730
|
+
*/
|
|
4731
|
+
Answers?: Record<string, EvaluationAnswerInput>;
|
|
4732
|
+
/**
|
|
4733
|
+
* <p>A map of question identifiers to note value.</p>
|
|
4734
|
+
*/
|
|
4735
|
+
Notes?: Record<string, EvaluationNote>;
|
|
4736
|
+
}
|
|
4737
|
+
/**
|
|
4738
|
+
* @public
|
|
4739
|
+
*/
|
|
4740
|
+
export interface UpdateContactEvaluationResponse {
|
|
4741
|
+
/**
|
|
4742
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
4743
|
+
*/
|
|
4744
|
+
EvaluationId: string | undefined;
|
|
4745
|
+
/**
|
|
4746
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
4747
|
+
*/
|
|
4748
|
+
EvaluationArn: string | undefined;
|
|
4749
|
+
}
|
|
3280
4750
|
/**
|
|
3281
4751
|
* @public
|
|
3282
4752
|
*/
|
|
@@ -3430,6 +4900,23 @@ export interface UpdateContactScheduleRequest {
|
|
|
3430
4900
|
*/
|
|
3431
4901
|
export interface UpdateContactScheduleResponse {
|
|
3432
4902
|
}
|
|
4903
|
+
/**
|
|
4904
|
+
* @public
|
|
4905
|
+
*/
|
|
4906
|
+
export interface UpdateEvaluationFormResponse {
|
|
4907
|
+
/**
|
|
4908
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
4909
|
+
*/
|
|
4910
|
+
EvaluationFormId: string | undefined;
|
|
4911
|
+
/**
|
|
4912
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
4913
|
+
*/
|
|
4914
|
+
EvaluationFormArn: string | undefined;
|
|
4915
|
+
/**
|
|
4916
|
+
* <p>The version of the updated evaluation form resource.</p>
|
|
4917
|
+
*/
|
|
4918
|
+
EvaluationFormVersion: number | undefined;
|
|
4919
|
+
}
|
|
3433
4920
|
/**
|
|
3434
4921
|
* @public
|
|
3435
4922
|
*/
|
|
@@ -4228,6 +5715,200 @@ export interface UpdateUserSecurityProfilesRequest {
|
|
|
4228
5715
|
*/
|
|
4229
5716
|
InstanceId: string | undefined;
|
|
4230
5717
|
}
|
|
5718
|
+
/**
|
|
5719
|
+
* @public
|
|
5720
|
+
* <p>Information about an item from an evaluation form. The item must be either a section or a
|
|
5721
|
+
* question.</p>
|
|
5722
|
+
*/
|
|
5723
|
+
export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
|
|
5724
|
+
/**
|
|
5725
|
+
* @public
|
|
5726
|
+
*/
|
|
5727
|
+
export declare namespace EvaluationFormItem {
|
|
5728
|
+
/**
|
|
5729
|
+
* <p>The information of the section.</p>
|
|
5730
|
+
*/
|
|
5731
|
+
interface SectionMember {
|
|
5732
|
+
Section: EvaluationFormSection;
|
|
5733
|
+
Question?: never;
|
|
5734
|
+
$unknown?: never;
|
|
5735
|
+
}
|
|
5736
|
+
/**
|
|
5737
|
+
* <p>The information of the question.</p>
|
|
5738
|
+
*/
|
|
5739
|
+
interface QuestionMember {
|
|
5740
|
+
Section?: never;
|
|
5741
|
+
Question: EvaluationFormQuestion;
|
|
5742
|
+
$unknown?: never;
|
|
5743
|
+
}
|
|
5744
|
+
interface $UnknownMember {
|
|
5745
|
+
Section?: never;
|
|
5746
|
+
Question?: never;
|
|
5747
|
+
$unknown: [string, any];
|
|
5748
|
+
}
|
|
5749
|
+
interface Visitor<T> {
|
|
5750
|
+
Section: (value: EvaluationFormSection) => T;
|
|
5751
|
+
Question: (value: EvaluationFormQuestion) => T;
|
|
5752
|
+
_: (name: string, value: any) => T;
|
|
5753
|
+
}
|
|
5754
|
+
const visit: <T>(value: EvaluationFormItem, visitor: Visitor<T>) => T;
|
|
5755
|
+
}
|
|
5756
|
+
/**
|
|
5757
|
+
* @public
|
|
5758
|
+
* <p>Information about a section from an evaluation form. A section can contain sections and/or
|
|
5759
|
+
* questions. Evaluation forms can only contain sections and subsections (two level nesting).</p>
|
|
5760
|
+
*/
|
|
5761
|
+
export interface EvaluationFormSection {
|
|
5762
|
+
/**
|
|
5763
|
+
* <p>The title of the section.</p>
|
|
5764
|
+
*/
|
|
5765
|
+
Title: string | undefined;
|
|
5766
|
+
/**
|
|
5767
|
+
* <p>The identifier of the section. An identifier must be unique within the evaluation
|
|
5768
|
+
* form.</p>
|
|
5769
|
+
*/
|
|
5770
|
+
RefId: string | undefined;
|
|
5771
|
+
/**
|
|
5772
|
+
* <p>The instructions of the section.</p>
|
|
5773
|
+
*/
|
|
5774
|
+
Instructions?: string;
|
|
5775
|
+
/**
|
|
5776
|
+
* <p>The items of the section.</p>
|
|
5777
|
+
*/
|
|
5778
|
+
Items?: EvaluationFormItem[];
|
|
5779
|
+
/**
|
|
5780
|
+
* <p>The scoring weight of the section.</p>
|
|
5781
|
+
*/
|
|
5782
|
+
Weight?: number;
|
|
5783
|
+
}
|
|
5784
|
+
/**
|
|
5785
|
+
* @public
|
|
5786
|
+
*/
|
|
5787
|
+
export interface CreateEvaluationFormRequest {
|
|
5788
|
+
/**
|
|
5789
|
+
* <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>
|
|
5790
|
+
*/
|
|
5791
|
+
InstanceId: string | undefined;
|
|
5792
|
+
/**
|
|
5793
|
+
* <p>A unique title of the evaluation form.</p>
|
|
5794
|
+
*/
|
|
5795
|
+
Title: string | undefined;
|
|
5796
|
+
/**
|
|
5797
|
+
* <p>The description of the evaluation form.</p>
|
|
5798
|
+
*/
|
|
5799
|
+
Description?: string;
|
|
5800
|
+
/**
|
|
5801
|
+
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
5802
|
+
*/
|
|
5803
|
+
Items: EvaluationFormItem[] | undefined;
|
|
5804
|
+
/**
|
|
5805
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
5806
|
+
*/
|
|
5807
|
+
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
5808
|
+
/**
|
|
5809
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
5810
|
+
* request. If not provided, the Amazon Web Services
|
|
5811
|
+
* SDK populates this field. For more information about idempotency, see
|
|
5812
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
5813
|
+
*/
|
|
5814
|
+
ClientToken?: string;
|
|
5815
|
+
}
|
|
5816
|
+
/**
|
|
5817
|
+
* @public
|
|
5818
|
+
* <p>Information about the evaluation form.</p>
|
|
5819
|
+
*/
|
|
5820
|
+
export interface EvaluationForm {
|
|
5821
|
+
/**
|
|
5822
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
5823
|
+
*/
|
|
5824
|
+
EvaluationFormId: string | undefined;
|
|
5825
|
+
/**
|
|
5826
|
+
* <p>A version of the evaluation form.</p>
|
|
5827
|
+
*/
|
|
5828
|
+
EvaluationFormVersion: number | undefined;
|
|
5829
|
+
/**
|
|
5830
|
+
* <p>The flag indicating whether the evaluation form is locked for changes.</p>
|
|
5831
|
+
*/
|
|
5832
|
+
Locked: boolean | undefined;
|
|
5833
|
+
/**
|
|
5834
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
5835
|
+
*/
|
|
5836
|
+
EvaluationFormArn: string | undefined;
|
|
5837
|
+
/**
|
|
5838
|
+
* <p>A unique title of the evaluation form.</p>
|
|
5839
|
+
*/
|
|
5840
|
+
Title: string | undefined;
|
|
5841
|
+
/**
|
|
5842
|
+
* <p>The description of the evaluation form.</p>
|
|
5843
|
+
*/
|
|
5844
|
+
Description?: string;
|
|
5845
|
+
/**
|
|
5846
|
+
* <p>The status of the evaluation form.</p>
|
|
5847
|
+
*/
|
|
5848
|
+
Status: EvaluationFormVersionStatus | string | undefined;
|
|
5849
|
+
/**
|
|
5850
|
+
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
5851
|
+
*/
|
|
5852
|
+
Items: EvaluationFormItem[] | undefined;
|
|
5853
|
+
/**
|
|
5854
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
5855
|
+
*/
|
|
5856
|
+
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
5857
|
+
/**
|
|
5858
|
+
* <p>The timestamp for when the evaluation form was created.</p>
|
|
5859
|
+
*/
|
|
5860
|
+
CreatedTime: Date | undefined;
|
|
5861
|
+
/**
|
|
5862
|
+
* <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
|
|
5863
|
+
*/
|
|
5864
|
+
CreatedBy: string | undefined;
|
|
5865
|
+
/**
|
|
5866
|
+
* <p>The timestamp for when the evaluation form was last updated.</p>
|
|
5867
|
+
*/
|
|
5868
|
+
LastModifiedTime: Date | undefined;
|
|
5869
|
+
/**
|
|
5870
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
|
|
5871
|
+
*/
|
|
5872
|
+
LastModifiedBy: string | undefined;
|
|
5873
|
+
/**
|
|
5874
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
5875
|
+
*/
|
|
5876
|
+
Tags?: Record<string, string>;
|
|
5877
|
+
}
|
|
5878
|
+
/**
|
|
5879
|
+
* @public
|
|
5880
|
+
* <p>Information about an evaluation form used in a contact evaluation.</p>
|
|
5881
|
+
*/
|
|
5882
|
+
export interface EvaluationFormContent {
|
|
5883
|
+
/**
|
|
5884
|
+
* <p>A version of the evaluation form.</p>
|
|
5885
|
+
*/
|
|
5886
|
+
EvaluationFormVersion: number | undefined;
|
|
5887
|
+
/**
|
|
5888
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
5889
|
+
*/
|
|
5890
|
+
EvaluationFormId: string | undefined;
|
|
5891
|
+
/**
|
|
5892
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
5893
|
+
*/
|
|
5894
|
+
EvaluationFormArn: string | undefined;
|
|
5895
|
+
/**
|
|
5896
|
+
* <p>A unique title of the evaluation form.</p>
|
|
5897
|
+
*/
|
|
5898
|
+
Title: string | undefined;
|
|
5899
|
+
/**
|
|
5900
|
+
* <p>The description of the evaluation form.</p>
|
|
5901
|
+
*/
|
|
5902
|
+
Description?: string;
|
|
5903
|
+
/**
|
|
5904
|
+
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
5905
|
+
*/
|
|
5906
|
+
Items: EvaluationFormItem[] | undefined;
|
|
5907
|
+
/**
|
|
5908
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
5909
|
+
*/
|
|
5910
|
+
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
5911
|
+
}
|
|
4231
5912
|
/**
|
|
4232
5913
|
* @public
|
|
4233
5914
|
* <p>The search criteria to be used to return queues.</p>
|
|
@@ -4313,6 +5994,50 @@ export interface SecurityProfileSearchCriteria {
|
|
|
4313
5994
|
*/
|
|
4314
5995
|
StringCondition?: StringCondition;
|
|
4315
5996
|
}
|
|
5997
|
+
/**
|
|
5998
|
+
* @public
|
|
5999
|
+
*/
|
|
6000
|
+
export interface UpdateEvaluationFormRequest {
|
|
6001
|
+
/**
|
|
6002
|
+
* <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>
|
|
6003
|
+
*/
|
|
6004
|
+
InstanceId: string | undefined;
|
|
6005
|
+
/**
|
|
6006
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
6007
|
+
*/
|
|
6008
|
+
EvaluationFormId: string | undefined;
|
|
6009
|
+
/**
|
|
6010
|
+
* <p>A version of the evaluation form to update.</p>
|
|
6011
|
+
*/
|
|
6012
|
+
EvaluationFormVersion: number | undefined;
|
|
6013
|
+
/**
|
|
6014
|
+
* <p>A flag indicating whether the operation must create a new version.</p>
|
|
6015
|
+
*/
|
|
6016
|
+
CreateNewVersion?: boolean;
|
|
6017
|
+
/**
|
|
6018
|
+
* <p>A unique title of the evaluation form.</p>
|
|
6019
|
+
*/
|
|
6020
|
+
Title: string | undefined;
|
|
6021
|
+
/**
|
|
6022
|
+
* <p>The description of the evaluation form.</p>
|
|
6023
|
+
*/
|
|
6024
|
+
Description?: string;
|
|
6025
|
+
/**
|
|
6026
|
+
* <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
|
|
6027
|
+
*/
|
|
6028
|
+
Items: EvaluationFormItem[] | undefined;
|
|
6029
|
+
/**
|
|
6030
|
+
* <p>A scoring strategy of the evaluation form.</p>
|
|
6031
|
+
*/
|
|
6032
|
+
ScoringStrategy?: EvaluationFormScoringStrategy;
|
|
6033
|
+
/**
|
|
6034
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6035
|
+
* request. If not provided, the Amazon Web Services
|
|
6036
|
+
* SDK populates this field. For more information about idempotency, see
|
|
6037
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6038
|
+
*/
|
|
6039
|
+
ClientToken?: string;
|
|
6040
|
+
}
|
|
4316
6041
|
/**
|
|
4317
6042
|
* @public
|
|
4318
6043
|
* <p>The search criteria to be used to return users.</p>
|
|
@@ -4342,6 +6067,28 @@ export interface UserSearchCriteria {
|
|
|
4342
6067
|
*/
|
|
4343
6068
|
HierarchyGroupCondition?: HierarchyGroupCondition;
|
|
4344
6069
|
}
|
|
6070
|
+
/**
|
|
6071
|
+
* @public
|
|
6072
|
+
*/
|
|
6073
|
+
export interface DescribeContactEvaluationResponse {
|
|
6074
|
+
/**
|
|
6075
|
+
* <p>Information about the evaluation form completed for a specific contact.</p>
|
|
6076
|
+
*/
|
|
6077
|
+
Evaluation: Evaluation | undefined;
|
|
6078
|
+
/**
|
|
6079
|
+
* <p>Information about the evaluation form.</p>
|
|
6080
|
+
*/
|
|
6081
|
+
EvaluationForm: EvaluationFormContent | undefined;
|
|
6082
|
+
}
|
|
6083
|
+
/**
|
|
6084
|
+
* @public
|
|
6085
|
+
*/
|
|
6086
|
+
export interface DescribeEvaluationFormResponse {
|
|
6087
|
+
/**
|
|
6088
|
+
* <p>Information about the evaluation form.</p>
|
|
6089
|
+
*/
|
|
6090
|
+
EvaluationForm: EvaluationForm | undefined;
|
|
6091
|
+
}
|
|
4345
6092
|
/**
|
|
4346
6093
|
* @public
|
|
4347
6094
|
*/
|
|
@@ -4470,6 +6217,14 @@ export interface SearchUsersRequest {
|
|
|
4470
6217
|
*/
|
|
4471
6218
|
SearchCriteria?: UserSearchCriteria;
|
|
4472
6219
|
}
|
|
6220
|
+
/**
|
|
6221
|
+
* @internal
|
|
6222
|
+
*/
|
|
6223
|
+
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
6224
|
+
/**
|
|
6225
|
+
* @internal
|
|
6226
|
+
*/
|
|
6227
|
+
export declare const GetFederationTokenResponseFilterSensitiveLog: (obj: GetFederationTokenResponse) => any;
|
|
4473
6228
|
/**
|
|
4474
6229
|
* @internal
|
|
4475
6230
|
*/
|