@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
|
@@ -37,6 +37,115 @@ export interface ActionSummary {
|
|
|
37
37
|
*/
|
|
38
38
|
ActionType: ActionType | string | undefined;
|
|
39
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export interface ActivateEvaluationFormRequest {
|
|
44
|
+
/**
|
|
45
|
+
* <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>
|
|
46
|
+
*/
|
|
47
|
+
InstanceId: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
50
|
+
*/
|
|
51
|
+
EvaluationFormId: string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
|
|
54
|
+
* evaluation form is activated.</p>
|
|
55
|
+
*/
|
|
56
|
+
EvaluationFormVersion: number | undefined;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export interface ActivateEvaluationFormResponse {
|
|
62
|
+
/**
|
|
63
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
64
|
+
*/
|
|
65
|
+
EvaluationFormId: string | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
68
|
+
*/
|
|
69
|
+
EvaluationFormArn: string | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>A version of the evaluation form.</p>
|
|
72
|
+
*/
|
|
73
|
+
EvaluationFormVersion: number | undefined;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
78
|
+
*/
|
|
79
|
+
export declare class InternalServiceException extends __BaseException {
|
|
80
|
+
readonly name: "InternalServiceException";
|
|
81
|
+
readonly $fault: "server";
|
|
82
|
+
/**
|
|
83
|
+
* <p>The message.</p>
|
|
84
|
+
*/
|
|
85
|
+
Message?: string;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
94
|
+
*/
|
|
95
|
+
export declare class InvalidParameterException extends __BaseException {
|
|
96
|
+
readonly name: "InvalidParameterException";
|
|
97
|
+
readonly $fault: "client";
|
|
98
|
+
/**
|
|
99
|
+
* <p>The message about the parameters.</p>
|
|
100
|
+
*/
|
|
101
|
+
Message?: string;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
* <p>A resource already has that name.</p>
|
|
110
|
+
*/
|
|
111
|
+
export declare class ResourceConflictException extends __BaseException {
|
|
112
|
+
readonly name: "ResourceConflictException";
|
|
113
|
+
readonly $fault: "client";
|
|
114
|
+
Message?: string;
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>);
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
* <p>The specified resource was not found.</p>
|
|
123
|
+
*/
|
|
124
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
125
|
+
readonly name: "ResourceNotFoundException";
|
|
126
|
+
readonly $fault: "client";
|
|
127
|
+
/**
|
|
128
|
+
* <p>The message about the resource.</p>
|
|
129
|
+
*/
|
|
130
|
+
Message?: string;
|
|
131
|
+
/**
|
|
132
|
+
* @internal
|
|
133
|
+
*/
|
|
134
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* @public
|
|
138
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
139
|
+
*/
|
|
140
|
+
export declare class ThrottlingException extends __BaseException {
|
|
141
|
+
readonly name: "ThrottlingException";
|
|
142
|
+
readonly $fault: "client";
|
|
143
|
+
Message?: string;
|
|
144
|
+
/**
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
147
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
148
|
+
}
|
|
40
149
|
/**
|
|
41
150
|
* @public
|
|
42
151
|
* @enum
|
|
@@ -278,38 +387,6 @@ export interface AssociateApprovedOriginRequest {
|
|
|
278
387
|
*/
|
|
279
388
|
Origin: string | undefined;
|
|
280
389
|
}
|
|
281
|
-
/**
|
|
282
|
-
* @public
|
|
283
|
-
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
284
|
-
*/
|
|
285
|
-
export declare class InternalServiceException extends __BaseException {
|
|
286
|
-
readonly name: "InternalServiceException";
|
|
287
|
-
readonly $fault: "server";
|
|
288
|
-
/**
|
|
289
|
-
* <p>The message.</p>
|
|
290
|
-
*/
|
|
291
|
-
Message?: string;
|
|
292
|
-
/**
|
|
293
|
-
* @internal
|
|
294
|
-
*/
|
|
295
|
-
constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
* @public
|
|
299
|
-
* <p>One or more of the specified parameters are not valid.</p>
|
|
300
|
-
*/
|
|
301
|
-
export declare class InvalidParameterException extends __BaseException {
|
|
302
|
-
readonly name: "InvalidParameterException";
|
|
303
|
-
readonly $fault: "client";
|
|
304
|
-
/**
|
|
305
|
-
* <p>The message about the parameters.</p>
|
|
306
|
-
*/
|
|
307
|
-
Message?: string;
|
|
308
|
-
/**
|
|
309
|
-
* @internal
|
|
310
|
-
*/
|
|
311
|
-
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
312
|
-
}
|
|
313
390
|
/**
|
|
314
391
|
* @public
|
|
315
392
|
* <p>The request is not valid.</p>
|
|
@@ -326,35 +403,6 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
326
403
|
*/
|
|
327
404
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
328
405
|
}
|
|
329
|
-
/**
|
|
330
|
-
* @public
|
|
331
|
-
* <p>A resource already has that name.</p>
|
|
332
|
-
*/
|
|
333
|
-
export declare class ResourceConflictException extends __BaseException {
|
|
334
|
-
readonly name: "ResourceConflictException";
|
|
335
|
-
readonly $fault: "client";
|
|
336
|
-
Message?: string;
|
|
337
|
-
/**
|
|
338
|
-
* @internal
|
|
339
|
-
*/
|
|
340
|
-
constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>);
|
|
341
|
-
}
|
|
342
|
-
/**
|
|
343
|
-
* @public
|
|
344
|
-
* <p>The specified resource was not found.</p>
|
|
345
|
-
*/
|
|
346
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
347
|
-
readonly name: "ResourceNotFoundException";
|
|
348
|
-
readonly $fault: "client";
|
|
349
|
-
/**
|
|
350
|
-
* <p>The message about the resource.</p>
|
|
351
|
-
*/
|
|
352
|
-
Message?: string;
|
|
353
|
-
/**
|
|
354
|
-
* @internal
|
|
355
|
-
*/
|
|
356
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
357
|
-
}
|
|
358
406
|
/**
|
|
359
407
|
* @public
|
|
360
408
|
* <p>The service quota has been exceeded.</p>
|
|
@@ -368,19 +416,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
368
416
|
*/
|
|
369
417
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
370
418
|
}
|
|
371
|
-
/**
|
|
372
|
-
* @public
|
|
373
|
-
* <p>The throttling limit has been exceeded.</p>
|
|
374
|
-
*/
|
|
375
|
-
export declare class ThrottlingException extends __BaseException {
|
|
376
|
-
readonly name: "ThrottlingException";
|
|
377
|
-
readonly $fault: "client";
|
|
378
|
-
Message?: string;
|
|
379
|
-
/**
|
|
380
|
-
* @internal
|
|
381
|
-
*/
|
|
382
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
383
|
-
}
|
|
384
419
|
/**
|
|
385
420
|
* @public
|
|
386
421
|
* <p>Configuration information of an Amazon Lex bot.</p>
|
|
@@ -1075,114 +1110,501 @@ export declare class InvalidContactFlowModuleException extends __BaseException {
|
|
|
1075
1110
|
* @public
|
|
1076
1111
|
* @enum
|
|
1077
1112
|
*/
|
|
1078
|
-
export declare const
|
|
1079
|
-
readonly
|
|
1080
|
-
readonly
|
|
1081
|
-
readonly
|
|
1082
|
-
readonly SUNDAY: "SUNDAY";
|
|
1083
|
-
readonly THURSDAY: "THURSDAY";
|
|
1084
|
-
readonly TUESDAY: "TUESDAY";
|
|
1085
|
-
readonly WEDNESDAY: "WEDNESDAY";
|
|
1113
|
+
export declare const EvaluationFormQuestionType: {
|
|
1114
|
+
readonly NUMERIC: "NUMERIC";
|
|
1115
|
+
readonly SINGLESELECT: "SINGLESELECT";
|
|
1116
|
+
readonly TEXT: "TEXT";
|
|
1086
1117
|
};
|
|
1087
1118
|
/**
|
|
1088
1119
|
* @public
|
|
1089
1120
|
*/
|
|
1090
|
-
export type
|
|
1121
|
+
export type EvaluationFormQuestionType = (typeof EvaluationFormQuestionType)[keyof typeof EvaluationFormQuestionType];
|
|
1091
1122
|
/**
|
|
1092
1123
|
* @public
|
|
1093
|
-
*
|
|
1124
|
+
* @enum
|
|
1094
1125
|
*/
|
|
1095
|
-
export
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1126
|
+
export declare const NumericQuestionPropertyAutomationLabel: {
|
|
1127
|
+
readonly AGENT_INTERACTION_DURATION: "AGENT_INTERACTION_DURATION";
|
|
1128
|
+
readonly CONTACT_DURATION: "CONTACT_DURATION";
|
|
1129
|
+
readonly CUSTOMER_HOLD_TIME: "CUSTOMER_HOLD_TIME";
|
|
1130
|
+
readonly NON_TALK_TIME: "NON_TALK_TIME";
|
|
1131
|
+
readonly NON_TALK_TIME_PERCENTAGE: "NON_TALK_TIME_PERCENTAGE";
|
|
1132
|
+
readonly NUMBER_OF_INTERRUPTIONS: "NUMBER_OF_INTERRUPTIONS";
|
|
1133
|
+
readonly OVERALL_AGENT_SENTIMENT_SCORE: "OVERALL_AGENT_SENTIMENT_SCORE";
|
|
1134
|
+
readonly OVERALL_CUSTOMER_SENTIMENT_SCORE: "OVERALL_CUSTOMER_SENTIMENT_SCORE";
|
|
1135
|
+
};
|
|
1136
|
+
/**
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
export type NumericQuestionPropertyAutomationLabel = (typeof NumericQuestionPropertyAutomationLabel)[keyof typeof NumericQuestionPropertyAutomationLabel];
|
|
1140
|
+
/**
|
|
1141
|
+
* @public
|
|
1142
|
+
* <p>Information about the property value used in automation of a numeric questions. Label values
|
|
1143
|
+
* are associated with minimum and maximum values for the numeric question.</p>
|
|
1144
|
+
* <ul>
|
|
1145
|
+
* <li>
|
|
1146
|
+
* <p>Sentiment scores have a minimum value of -5 and maximum value of 5.</p>
|
|
1147
|
+
* </li>
|
|
1148
|
+
* <li>
|
|
1149
|
+
* <p> Duration labels, such as <code>NON_TALK_TIME</code>, <code>CONTACT_DURATION</code>,
|
|
1150
|
+
* <code>AGENT_INTERACTION_DURATION</code>, <code>CUSTOMER_HOLD_TIME</code> have a minimum value
|
|
1151
|
+
* of 0 and maximum value of 28800.</p>
|
|
1152
|
+
* </li>
|
|
1153
|
+
* <li>
|
|
1154
|
+
* <p>Percantages have a minimum value of 0 and maximum value of 100. </p>
|
|
1155
|
+
* </li>
|
|
1156
|
+
* <li>
|
|
1157
|
+
* <p>
|
|
1158
|
+
* <code>NUMBER_OF_INTERRUPTIONS</code> has a minimum value of 0 and maximum value of
|
|
1159
|
+
* 100.</p>
|
|
1160
|
+
* </li>
|
|
1161
|
+
* </ul>
|
|
1162
|
+
*/
|
|
1163
|
+
export interface NumericQuestionPropertyValueAutomation {
|
|
1100
1164
|
/**
|
|
1101
|
-
* <p>The
|
|
1165
|
+
* <p>The property label of the automation.</p>
|
|
1102
1166
|
*/
|
|
1103
|
-
|
|
1167
|
+
Label: NumericQuestionPropertyAutomationLabel | string | undefined;
|
|
1104
1168
|
}
|
|
1105
1169
|
/**
|
|
1106
1170
|
* @public
|
|
1107
|
-
* <p>
|
|
1171
|
+
* <p>Information about the automation configuration in numeric questions.</p>
|
|
1108
1172
|
*/
|
|
1109
|
-
export
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
/**
|
|
1115
|
-
* <p>The start time that your contact center opens.</p>
|
|
1116
|
-
*/
|
|
1117
|
-
StartTime: HoursOfOperationTimeSlice | undefined;
|
|
1173
|
+
export type EvaluationFormNumericQuestionAutomation = EvaluationFormNumericQuestionAutomation.PropertyValueMember | EvaluationFormNumericQuestionAutomation.$UnknownMember;
|
|
1174
|
+
/**
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
export declare namespace EvaluationFormNumericQuestionAutomation {
|
|
1118
1178
|
/**
|
|
1119
|
-
* <p>The
|
|
1179
|
+
* <p>The property value of the automation.</p>
|
|
1120
1180
|
*/
|
|
1121
|
-
|
|
1181
|
+
interface PropertyValueMember {
|
|
1182
|
+
PropertyValue: NumericQuestionPropertyValueAutomation;
|
|
1183
|
+
$unknown?: never;
|
|
1184
|
+
}
|
|
1185
|
+
interface $UnknownMember {
|
|
1186
|
+
PropertyValue?: never;
|
|
1187
|
+
$unknown: [string, any];
|
|
1188
|
+
}
|
|
1189
|
+
interface Visitor<T> {
|
|
1190
|
+
PropertyValue: (value: NumericQuestionPropertyValueAutomation) => T;
|
|
1191
|
+
_: (name: string, value: any) => T;
|
|
1192
|
+
}
|
|
1193
|
+
const visit: <T>(value: EvaluationFormNumericQuestionAutomation, visitor: Visitor<T>) => T;
|
|
1122
1194
|
}
|
|
1123
1195
|
/**
|
|
1124
1196
|
* @public
|
|
1197
|
+
* <p>Information about the option range used for scoring in numeric questions.</p>
|
|
1125
1198
|
*/
|
|
1126
|
-
export interface
|
|
1127
|
-
/**
|
|
1128
|
-
* <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>
|
|
1129
|
-
*/
|
|
1130
|
-
InstanceId: string | undefined;
|
|
1131
|
-
/**
|
|
1132
|
-
* <p>The name of the hours of operation.</p>
|
|
1133
|
-
*/
|
|
1134
|
-
Name: string | undefined;
|
|
1199
|
+
export interface EvaluationFormNumericQuestionOption {
|
|
1135
1200
|
/**
|
|
1136
|
-
* <p>The
|
|
1201
|
+
* <p>The minimum answer value of the range option.</p>
|
|
1137
1202
|
*/
|
|
1138
|
-
|
|
1203
|
+
MinValue: number | undefined;
|
|
1139
1204
|
/**
|
|
1140
|
-
* <p>The
|
|
1205
|
+
* <p>The maximum answer value of the range option.</p>
|
|
1141
1206
|
*/
|
|
1142
|
-
|
|
1207
|
+
MaxValue: number | undefined;
|
|
1143
1208
|
/**
|
|
1144
|
-
* <p>
|
|
1209
|
+
* <p>The score assigned to answer values within the range option.</p>
|
|
1145
1210
|
*/
|
|
1146
|
-
|
|
1211
|
+
Score?: number;
|
|
1147
1212
|
/**
|
|
1148
|
-
* <p>The
|
|
1213
|
+
* <p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the
|
|
1214
|
+
* overall evaluation gets a score of 0.</p>
|
|
1149
1215
|
*/
|
|
1150
|
-
|
|
1216
|
+
AutomaticFail?: boolean;
|
|
1151
1217
|
}
|
|
1152
1218
|
/**
|
|
1153
1219
|
* @public
|
|
1220
|
+
* <p>Information about properties for a numeric question in an evaluation form.</p>
|
|
1154
1221
|
*/
|
|
1155
|
-
export interface
|
|
1222
|
+
export interface EvaluationFormNumericQuestionProperties {
|
|
1156
1223
|
/**
|
|
1157
|
-
* <p>The
|
|
1224
|
+
* <p>The minimum answer value.</p>
|
|
1158
1225
|
*/
|
|
1159
|
-
|
|
1226
|
+
MinValue: number | undefined;
|
|
1160
1227
|
/**
|
|
1161
|
-
* <p>The
|
|
1228
|
+
* <p>The maximum answer value.</p>
|
|
1162
1229
|
*/
|
|
1163
|
-
|
|
1230
|
+
MaxValue: number | undefined;
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>The scoring options of the numeric question.</p>
|
|
1233
|
+
*/
|
|
1234
|
+
Options?: EvaluationFormNumericQuestionOption[];
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>The automation properties of the numeric question.</p>
|
|
1237
|
+
*/
|
|
1238
|
+
Automation?: EvaluationFormNumericQuestionAutomation;
|
|
1164
1239
|
}
|
|
1165
1240
|
/**
|
|
1166
1241
|
* @public
|
|
1167
1242
|
* @enum
|
|
1168
1243
|
*/
|
|
1169
|
-
export declare const
|
|
1170
|
-
readonly
|
|
1171
|
-
readonly
|
|
1172
|
-
readonly SAML: "SAML";
|
|
1244
|
+
export declare const SingleSelectQuestionRuleCategoryAutomationCondition: {
|
|
1245
|
+
readonly NOT_PRESENT: "NOT_PRESENT";
|
|
1246
|
+
readonly PRESENT: "PRESENT";
|
|
1173
1247
|
};
|
|
1174
1248
|
/**
|
|
1175
1249
|
* @public
|
|
1176
1250
|
*/
|
|
1177
|
-
export type
|
|
1251
|
+
export type SingleSelectQuestionRuleCategoryAutomationCondition = (typeof SingleSelectQuestionRuleCategoryAutomationCondition)[keyof typeof SingleSelectQuestionRuleCategoryAutomationCondition];
|
|
1178
1252
|
/**
|
|
1179
1253
|
* @public
|
|
1254
|
+
* <p>Information about the automation option based on a rule category for a single select
|
|
1255
|
+
* question.</p>
|
|
1180
1256
|
*/
|
|
1181
|
-
export interface
|
|
1257
|
+
export interface SingleSelectQuestionRuleCategoryAutomation {
|
|
1182
1258
|
/**
|
|
1183
|
-
* <p>The
|
|
1259
|
+
* <p> The category name, as defined in Rules.</p>
|
|
1184
1260
|
*/
|
|
1185
|
-
|
|
1261
|
+
Category: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the
|
|
1264
|
+
* option is applied when the contact data includes the category. Similarly, if the condition is
|
|
1265
|
+
* <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the
|
|
1266
|
+
* category.</p>
|
|
1267
|
+
*/
|
|
1268
|
+
Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* <p>The identifier of the answer option tha</p>
|
|
1271
|
+
*/
|
|
1272
|
+
OptionRefId: string | undefined;
|
|
1273
|
+
}
|
|
1274
|
+
/**
|
|
1275
|
+
* @public
|
|
1276
|
+
* <p>Information about the automation option of a single select question.</p>
|
|
1277
|
+
*/
|
|
1278
|
+
export type EvaluationFormSingleSelectQuestionAutomationOption = EvaluationFormSingleSelectQuestionAutomationOption.RuleCategoryMember | EvaluationFormSingleSelectQuestionAutomationOption.$UnknownMember;
|
|
1279
|
+
/**
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
export declare namespace EvaluationFormSingleSelectQuestionAutomationOption {
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>The automation option based on a rule category for the single select question.</p>
|
|
1285
|
+
*/
|
|
1286
|
+
interface RuleCategoryMember {
|
|
1287
|
+
RuleCategory: SingleSelectQuestionRuleCategoryAutomation;
|
|
1288
|
+
$unknown?: never;
|
|
1289
|
+
}
|
|
1290
|
+
interface $UnknownMember {
|
|
1291
|
+
RuleCategory?: never;
|
|
1292
|
+
$unknown: [string, any];
|
|
1293
|
+
}
|
|
1294
|
+
interface Visitor<T> {
|
|
1295
|
+
RuleCategory: (value: SingleSelectQuestionRuleCategoryAutomation) => T;
|
|
1296
|
+
_: (name: string, value: any) => T;
|
|
1297
|
+
}
|
|
1298
|
+
const visit: <T>(value: EvaluationFormSingleSelectQuestionAutomationOption, visitor: Visitor<T>) => T;
|
|
1299
|
+
}
|
|
1300
|
+
/**
|
|
1301
|
+
* @public
|
|
1302
|
+
* <p>Information about the automation configuration in single select questions. Automation
|
|
1303
|
+
* options are evaluated in order, and the first matched option is applied. If no automation option
|
|
1304
|
+
* matches, and there is a default option, then the default option is applied.</p>
|
|
1305
|
+
*/
|
|
1306
|
+
export interface EvaluationFormSingleSelectQuestionAutomation {
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>The automation options of the single select question.</p>
|
|
1309
|
+
*/
|
|
1310
|
+
Options: EvaluationFormSingleSelectQuestionAutomationOption[] | undefined;
|
|
1311
|
+
/**
|
|
1312
|
+
* <p>The identifier of the default answer option, when none of the automation options match the
|
|
1313
|
+
* criteria.</p>
|
|
1314
|
+
*/
|
|
1315
|
+
DefaultOptionRefId?: string;
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* @public
|
|
1319
|
+
* @enum
|
|
1320
|
+
*/
|
|
1321
|
+
export declare const EvaluationFormSingleSelectQuestionDisplayMode: {
|
|
1322
|
+
readonly DROPDOWN: "DROPDOWN";
|
|
1323
|
+
readonly RADIO: "RADIO";
|
|
1324
|
+
};
|
|
1325
|
+
/**
|
|
1326
|
+
* @public
|
|
1327
|
+
*/
|
|
1328
|
+
export type EvaluationFormSingleSelectQuestionDisplayMode = (typeof EvaluationFormSingleSelectQuestionDisplayMode)[keyof typeof EvaluationFormSingleSelectQuestionDisplayMode];
|
|
1329
|
+
/**
|
|
1330
|
+
* @public
|
|
1331
|
+
* <p>Information about the automation configuration in single select questions.</p>
|
|
1332
|
+
*/
|
|
1333
|
+
export interface EvaluationFormSingleSelectQuestionOption {
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>The identifier of the answer option. An identifier must be unique within the
|
|
1336
|
+
* question.</p>
|
|
1337
|
+
*/
|
|
1338
|
+
RefId: string | undefined;
|
|
1339
|
+
/**
|
|
1340
|
+
* <p>The title of the answer option.</p>
|
|
1341
|
+
*/
|
|
1342
|
+
Text: string | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The score assigned to the answer option.</p>
|
|
1345
|
+
*/
|
|
1346
|
+
Score?: number;
|
|
1347
|
+
/**
|
|
1348
|
+
* <p>The flag to mark the option as automatic fail. If an automatic fail answer is provided, the
|
|
1349
|
+
* overall evaluation gets a score of 0.</p>
|
|
1350
|
+
*/
|
|
1351
|
+
AutomaticFail?: boolean;
|
|
1352
|
+
}
|
|
1353
|
+
/**
|
|
1354
|
+
* @public
|
|
1355
|
+
* <p>Information about the options in single select questions.</p>
|
|
1356
|
+
*/
|
|
1357
|
+
export interface EvaluationFormSingleSelectQuestionProperties {
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The answer options of the single select question.</p>
|
|
1360
|
+
*/
|
|
1361
|
+
Options: EvaluationFormSingleSelectQuestionOption[] | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>The display mode of the single select question.</p>
|
|
1364
|
+
*/
|
|
1365
|
+
DisplayAs?: EvaluationFormSingleSelectQuestionDisplayMode | string;
|
|
1366
|
+
/**
|
|
1367
|
+
* <p>The display mode of the single select question.</p>
|
|
1368
|
+
*/
|
|
1369
|
+
Automation?: EvaluationFormSingleSelectQuestionAutomation;
|
|
1370
|
+
}
|
|
1371
|
+
/**
|
|
1372
|
+
* @public
|
|
1373
|
+
* <p>Information about properties for a question in an evaluation form. The question type
|
|
1374
|
+
* properties must be either for a numeric question or a single select question.</p>
|
|
1375
|
+
*/
|
|
1376
|
+
export type EvaluationFormQuestionTypeProperties = EvaluationFormQuestionTypeProperties.NumericMember | EvaluationFormQuestionTypeProperties.SingleSelectMember | EvaluationFormQuestionTypeProperties.$UnknownMember;
|
|
1377
|
+
/**
|
|
1378
|
+
* @public
|
|
1379
|
+
*/
|
|
1380
|
+
export declare namespace EvaluationFormQuestionTypeProperties {
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The properties of the numeric question.</p>
|
|
1383
|
+
*/
|
|
1384
|
+
interface NumericMember {
|
|
1385
|
+
Numeric: EvaluationFormNumericQuestionProperties;
|
|
1386
|
+
SingleSelect?: never;
|
|
1387
|
+
$unknown?: never;
|
|
1388
|
+
}
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The properties of the numeric question.</p>
|
|
1391
|
+
*/
|
|
1392
|
+
interface SingleSelectMember {
|
|
1393
|
+
Numeric?: never;
|
|
1394
|
+
SingleSelect: EvaluationFormSingleSelectQuestionProperties;
|
|
1395
|
+
$unknown?: never;
|
|
1396
|
+
}
|
|
1397
|
+
interface $UnknownMember {
|
|
1398
|
+
Numeric?: never;
|
|
1399
|
+
SingleSelect?: never;
|
|
1400
|
+
$unknown: [string, any];
|
|
1401
|
+
}
|
|
1402
|
+
interface Visitor<T> {
|
|
1403
|
+
Numeric: (value: EvaluationFormNumericQuestionProperties) => T;
|
|
1404
|
+
SingleSelect: (value: EvaluationFormSingleSelectQuestionProperties) => T;
|
|
1405
|
+
_: (name: string, value: any) => T;
|
|
1406
|
+
}
|
|
1407
|
+
const visit: <T>(value: EvaluationFormQuestionTypeProperties, visitor: Visitor<T>) => T;
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* @public
|
|
1411
|
+
* <p>Information about a question from an evaluation form.</p>
|
|
1412
|
+
*/
|
|
1413
|
+
export interface EvaluationFormQuestion {
|
|
1414
|
+
/**
|
|
1415
|
+
* <p>The title of the question.</p>
|
|
1416
|
+
*/
|
|
1417
|
+
Title: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The instructions of the section.</p>
|
|
1420
|
+
*/
|
|
1421
|
+
Instructions?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* <p>The identifier of the question. An identifier must be unique within the evaluation
|
|
1424
|
+
* form.</p>
|
|
1425
|
+
*/
|
|
1426
|
+
RefId: string | undefined;
|
|
1427
|
+
/**
|
|
1428
|
+
* <p>The flag to enable not applicable answers to the question.</p>
|
|
1429
|
+
*/
|
|
1430
|
+
NotApplicableEnabled?: boolean;
|
|
1431
|
+
/**
|
|
1432
|
+
* <p>The type of the question.</p>
|
|
1433
|
+
*/
|
|
1434
|
+
QuestionType: EvaluationFormQuestionType | string | undefined;
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>The properties of the type of question. Text questions do not have to define question type
|
|
1437
|
+
* properties.</p>
|
|
1438
|
+
*/
|
|
1439
|
+
QuestionTypeProperties?: EvaluationFormQuestionTypeProperties;
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>The scoring weight of the section.</p>
|
|
1442
|
+
*/
|
|
1443
|
+
Weight?: number;
|
|
1444
|
+
}
|
|
1445
|
+
/**
|
|
1446
|
+
* @public
|
|
1447
|
+
* @enum
|
|
1448
|
+
*/
|
|
1449
|
+
export declare const EvaluationFormScoringMode: {
|
|
1450
|
+
readonly QUESTION_ONLY: "QUESTION_ONLY";
|
|
1451
|
+
readonly SECTION_ONLY: "SECTION_ONLY";
|
|
1452
|
+
};
|
|
1453
|
+
/**
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
export type EvaluationFormScoringMode = (typeof EvaluationFormScoringMode)[keyof typeof EvaluationFormScoringMode];
|
|
1457
|
+
/**
|
|
1458
|
+
* @public
|
|
1459
|
+
* @enum
|
|
1460
|
+
*/
|
|
1461
|
+
export declare const EvaluationFormScoringStatus: {
|
|
1462
|
+
readonly DISABLED: "DISABLED";
|
|
1463
|
+
readonly ENABLED: "ENABLED";
|
|
1464
|
+
};
|
|
1465
|
+
/**
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
export type EvaluationFormScoringStatus = (typeof EvaluationFormScoringStatus)[keyof typeof EvaluationFormScoringStatus];
|
|
1469
|
+
/**
|
|
1470
|
+
* @public
|
|
1471
|
+
* <p>Information about scoring strategy for an evaluation form.</p>
|
|
1472
|
+
*/
|
|
1473
|
+
export interface EvaluationFormScoringStrategy {
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>The scoring mode of the evaluation form.</p>
|
|
1476
|
+
*/
|
|
1477
|
+
Mode: EvaluationFormScoringMode | string | undefined;
|
|
1478
|
+
/**
|
|
1479
|
+
* <p>The scoring status of the evaluation form.</p>
|
|
1480
|
+
*/
|
|
1481
|
+
Status: EvaluationFormScoringStatus | string | undefined;
|
|
1482
|
+
}
|
|
1483
|
+
/**
|
|
1484
|
+
* @public
|
|
1485
|
+
*/
|
|
1486
|
+
export interface CreateEvaluationFormResponse {
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
1489
|
+
*/
|
|
1490
|
+
EvaluationFormId: string | undefined;
|
|
1491
|
+
/**
|
|
1492
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
1493
|
+
*/
|
|
1494
|
+
EvaluationFormArn: string | undefined;
|
|
1495
|
+
}
|
|
1496
|
+
/**
|
|
1497
|
+
* @public
|
|
1498
|
+
* @enum
|
|
1499
|
+
*/
|
|
1500
|
+
export declare const HoursOfOperationDays: {
|
|
1501
|
+
readonly FRIDAY: "FRIDAY";
|
|
1502
|
+
readonly MONDAY: "MONDAY";
|
|
1503
|
+
readonly SATURDAY: "SATURDAY";
|
|
1504
|
+
readonly SUNDAY: "SUNDAY";
|
|
1505
|
+
readonly THURSDAY: "THURSDAY";
|
|
1506
|
+
readonly TUESDAY: "TUESDAY";
|
|
1507
|
+
readonly WEDNESDAY: "WEDNESDAY";
|
|
1508
|
+
};
|
|
1509
|
+
/**
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
export type HoursOfOperationDays = (typeof HoursOfOperationDays)[keyof typeof HoursOfOperationDays];
|
|
1513
|
+
/**
|
|
1514
|
+
* @public
|
|
1515
|
+
* <p>The start time or end time for an hours of operation.</p>
|
|
1516
|
+
*/
|
|
1517
|
+
export interface HoursOfOperationTimeSlice {
|
|
1518
|
+
/**
|
|
1519
|
+
* <p>The hours.</p>
|
|
1520
|
+
*/
|
|
1521
|
+
Hours: number | undefined;
|
|
1522
|
+
/**
|
|
1523
|
+
* <p>The minutes.</p>
|
|
1524
|
+
*/
|
|
1525
|
+
Minutes: number | undefined;
|
|
1526
|
+
}
|
|
1527
|
+
/**
|
|
1528
|
+
* @public
|
|
1529
|
+
* <p>Contains information about the hours of operation.</p>
|
|
1530
|
+
*/
|
|
1531
|
+
export interface HoursOfOperationConfig {
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>The day that the hours of operation applies to.</p>
|
|
1534
|
+
*/
|
|
1535
|
+
Day: HoursOfOperationDays | string | undefined;
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The start time that your contact center opens.</p>
|
|
1538
|
+
*/
|
|
1539
|
+
StartTime: HoursOfOperationTimeSlice | undefined;
|
|
1540
|
+
/**
|
|
1541
|
+
* <p>The end time that your contact center closes.</p>
|
|
1542
|
+
*/
|
|
1543
|
+
EndTime: HoursOfOperationTimeSlice | undefined;
|
|
1544
|
+
}
|
|
1545
|
+
/**
|
|
1546
|
+
* @public
|
|
1547
|
+
*/
|
|
1548
|
+
export interface CreateHoursOfOperationRequest {
|
|
1549
|
+
/**
|
|
1550
|
+
* <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>
|
|
1551
|
+
*/
|
|
1552
|
+
InstanceId: string | undefined;
|
|
1553
|
+
/**
|
|
1554
|
+
* <p>The name of the hours of operation.</p>
|
|
1555
|
+
*/
|
|
1556
|
+
Name: string | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The description of the hours of operation.</p>
|
|
1559
|
+
*/
|
|
1560
|
+
Description?: string;
|
|
1561
|
+
/**
|
|
1562
|
+
* <p>The time zone of the hours of operation.</p>
|
|
1563
|
+
*/
|
|
1564
|
+
TimeZone: string | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* <p>Configuration information for the hours of operation: day, start time, and end time.</p>
|
|
1567
|
+
*/
|
|
1568
|
+
Config: HoursOfOperationConfig[] | undefined;
|
|
1569
|
+
/**
|
|
1570
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1571
|
+
*/
|
|
1572
|
+
Tags?: Record<string, string>;
|
|
1573
|
+
}
|
|
1574
|
+
/**
|
|
1575
|
+
* @public
|
|
1576
|
+
*/
|
|
1577
|
+
export interface CreateHoursOfOperationResponse {
|
|
1578
|
+
/**
|
|
1579
|
+
* <p>The identifier for the hours of operation.</p>
|
|
1580
|
+
*/
|
|
1581
|
+
HoursOfOperationId?: string;
|
|
1582
|
+
/**
|
|
1583
|
+
* <p>The Amazon Resource Name (ARN) for the hours of operation.</p>
|
|
1584
|
+
*/
|
|
1585
|
+
HoursOfOperationArn?: string;
|
|
1586
|
+
}
|
|
1587
|
+
/**
|
|
1588
|
+
* @public
|
|
1589
|
+
* @enum
|
|
1590
|
+
*/
|
|
1591
|
+
export declare const DirectoryType: {
|
|
1592
|
+
readonly CONNECT_MANAGED: "CONNECT_MANAGED";
|
|
1593
|
+
readonly EXISTING_DIRECTORY: "EXISTING_DIRECTORY";
|
|
1594
|
+
readonly SAML: "SAML";
|
|
1595
|
+
};
|
|
1596
|
+
/**
|
|
1597
|
+
* @public
|
|
1598
|
+
*/
|
|
1599
|
+
export type DirectoryType = (typeof DirectoryType)[keyof typeof DirectoryType];
|
|
1600
|
+
/**
|
|
1601
|
+
* @public
|
|
1602
|
+
*/
|
|
1603
|
+
export interface CreateInstanceRequest {
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The idempotency token.</p>
|
|
1606
|
+
*/
|
|
1607
|
+
ClientToken?: string;
|
|
1186
1608
|
/**
|
|
1187
1609
|
* <p>The type of identity management for your Amazon Connect users.</p>
|
|
1188
1610
|
*/
|
|
@@ -2579,58 +3001,123 @@ export interface CreateVocabularyResponse {
|
|
|
2579
3001
|
/**
|
|
2580
3002
|
* @public
|
|
2581
3003
|
*/
|
|
2582
|
-
export interface
|
|
3004
|
+
export interface DeactivateEvaluationFormRequest {
|
|
2583
3005
|
/**
|
|
2584
3006
|
* <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>
|
|
2585
3007
|
*/
|
|
2586
3008
|
InstanceId: string | undefined;
|
|
2587
3009
|
/**
|
|
2588
|
-
* <p>The identifier
|
|
3010
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
2589
3011
|
*/
|
|
2590
|
-
|
|
3012
|
+
EvaluationFormId: string | undefined;
|
|
3013
|
+
/**
|
|
3014
|
+
* <p>A version of the evaluation form. If the version property is not provided, the latest version of the
|
|
3015
|
+
* evaluation form is deactivated.</p>
|
|
3016
|
+
*/
|
|
3017
|
+
EvaluationFormVersion: number | undefined;
|
|
2591
3018
|
}
|
|
2592
3019
|
/**
|
|
2593
3020
|
* @public
|
|
2594
3021
|
*/
|
|
2595
|
-
export interface
|
|
3022
|
+
export interface DeactivateEvaluationFormResponse {
|
|
3023
|
+
/**
|
|
3024
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
3025
|
+
*/
|
|
3026
|
+
EvaluationFormId: string | undefined;
|
|
3027
|
+
/**
|
|
3028
|
+
* <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
|
|
3029
|
+
*/
|
|
3030
|
+
EvaluationFormArn: string | undefined;
|
|
3031
|
+
/**
|
|
3032
|
+
* <p>The version of the deactivated evaluation form resource.</p>
|
|
3033
|
+
*/
|
|
3034
|
+
EvaluationFormVersion: number | undefined;
|
|
2596
3035
|
}
|
|
2597
3036
|
/**
|
|
2598
3037
|
* @public
|
|
2599
3038
|
*/
|
|
2600
|
-
export interface
|
|
3039
|
+
export interface DeleteContactEvaluationRequest {
|
|
2601
3040
|
/**
|
|
2602
3041
|
* <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>
|
|
2603
3042
|
*/
|
|
2604
3043
|
InstanceId: string | undefined;
|
|
2605
3044
|
/**
|
|
2606
|
-
* <p>
|
|
3045
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
2607
3046
|
*/
|
|
2608
|
-
|
|
2609
|
-
}
|
|
2610
|
-
/**
|
|
2611
|
-
* @public
|
|
2612
|
-
*/
|
|
2613
|
-
export interface DeleteContactFlowModuleResponse {
|
|
3047
|
+
EvaluationId: string | undefined;
|
|
2614
3048
|
}
|
|
2615
3049
|
/**
|
|
2616
3050
|
* @public
|
|
2617
3051
|
*/
|
|
2618
|
-
export interface
|
|
3052
|
+
export interface DeleteContactFlowRequest {
|
|
2619
3053
|
/**
|
|
2620
3054
|
* <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>
|
|
2621
3055
|
*/
|
|
2622
3056
|
InstanceId: string | undefined;
|
|
2623
3057
|
/**
|
|
2624
|
-
* <p>The identifier
|
|
3058
|
+
* <p>The identifier of the flow.</p>
|
|
2625
3059
|
*/
|
|
2626
|
-
|
|
3060
|
+
ContactFlowId: string | undefined;
|
|
2627
3061
|
}
|
|
2628
3062
|
/**
|
|
2629
3063
|
* @public
|
|
2630
3064
|
*/
|
|
2631
|
-
export interface
|
|
2632
|
-
|
|
2633
|
-
|
|
3065
|
+
export interface DeleteContactFlowResponse {
|
|
3066
|
+
}
|
|
3067
|
+
/**
|
|
3068
|
+
* @public
|
|
3069
|
+
*/
|
|
3070
|
+
export interface DeleteContactFlowModuleRequest {
|
|
3071
|
+
/**
|
|
3072
|
+
* <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>
|
|
3073
|
+
*/
|
|
3074
|
+
InstanceId: string | undefined;
|
|
3075
|
+
/**
|
|
3076
|
+
* <p>The identifier of the flow module.</p>
|
|
3077
|
+
*/
|
|
3078
|
+
ContactFlowModuleId: string | undefined;
|
|
3079
|
+
}
|
|
3080
|
+
/**
|
|
3081
|
+
* @public
|
|
3082
|
+
*/
|
|
3083
|
+
export interface DeleteContactFlowModuleResponse {
|
|
3084
|
+
}
|
|
3085
|
+
/**
|
|
3086
|
+
* @public
|
|
3087
|
+
*/
|
|
3088
|
+
export interface DeleteEvaluationFormRequest {
|
|
3089
|
+
/**
|
|
3090
|
+
* <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>
|
|
3091
|
+
*/
|
|
3092
|
+
InstanceId: string | undefined;
|
|
3093
|
+
/**
|
|
3094
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
3095
|
+
*/
|
|
3096
|
+
EvaluationFormId: string | undefined;
|
|
3097
|
+
/**
|
|
3098
|
+
* <p>The unique identifier for the evaluation form.</p>
|
|
3099
|
+
*/
|
|
3100
|
+
EvaluationFormVersion?: number;
|
|
3101
|
+
}
|
|
3102
|
+
/**
|
|
3103
|
+
* @public
|
|
3104
|
+
*/
|
|
3105
|
+
export interface DeleteHoursOfOperationRequest {
|
|
3106
|
+
/**
|
|
3107
|
+
* <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>
|
|
3108
|
+
*/
|
|
3109
|
+
InstanceId: string | undefined;
|
|
3110
|
+
/**
|
|
3111
|
+
* <p>The identifier for the hours of operation.</p>
|
|
3112
|
+
*/
|
|
3113
|
+
HoursOfOperationId: string | undefined;
|
|
3114
|
+
}
|
|
3115
|
+
/**
|
|
3116
|
+
* @public
|
|
3117
|
+
*/
|
|
3118
|
+
export interface DeleteInstanceRequest {
|
|
3119
|
+
/**
|
|
3120
|
+
* <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>
|
|
2634
3121
|
*/
|
|
2635
3122
|
InstanceId: string | undefined;
|
|
2636
3123
|
}
|
|
@@ -2975,6 +3462,193 @@ export interface DescribeContactResponse {
|
|
|
2975
3462
|
*/
|
|
2976
3463
|
Contact?: Contact;
|
|
2977
3464
|
}
|
|
3465
|
+
/**
|
|
3466
|
+
* @public
|
|
3467
|
+
*/
|
|
3468
|
+
export interface DescribeContactEvaluationRequest {
|
|
3469
|
+
/**
|
|
3470
|
+
* <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>
|
|
3471
|
+
*/
|
|
3472
|
+
InstanceId: string | undefined;
|
|
3473
|
+
/**
|
|
3474
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
3475
|
+
*/
|
|
3476
|
+
EvaluationId: string | undefined;
|
|
3477
|
+
}
|
|
3478
|
+
/**
|
|
3479
|
+
* @public
|
|
3480
|
+
* <p>Information about answer data for a contact evaluation. Answer data must be either string,
|
|
3481
|
+
* numeric, or not applicable.</p>
|
|
3482
|
+
*/
|
|
3483
|
+
export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
|
|
3484
|
+
/**
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
export declare namespace EvaluationAnswerData {
|
|
3488
|
+
/**
|
|
3489
|
+
* <p>The string value for an answer in a contact evaluation.</p>
|
|
3490
|
+
*/
|
|
3491
|
+
interface StringValueMember {
|
|
3492
|
+
StringValue: string;
|
|
3493
|
+
NumericValue?: never;
|
|
3494
|
+
NotApplicable?: never;
|
|
3495
|
+
$unknown?: never;
|
|
3496
|
+
}
|
|
3497
|
+
/**
|
|
3498
|
+
* <p>The numeric value for an answer in a contact evaluation.</p>
|
|
3499
|
+
*/
|
|
3500
|
+
interface NumericValueMember {
|
|
3501
|
+
StringValue?: never;
|
|
3502
|
+
NumericValue: number;
|
|
3503
|
+
NotApplicable?: never;
|
|
3504
|
+
$unknown?: never;
|
|
3505
|
+
}
|
|
3506
|
+
/**
|
|
3507
|
+
* <p>The flag to mark the question as not applicable.</p>
|
|
3508
|
+
*/
|
|
3509
|
+
interface NotApplicableMember {
|
|
3510
|
+
StringValue?: never;
|
|
3511
|
+
NumericValue?: never;
|
|
3512
|
+
NotApplicable: boolean;
|
|
3513
|
+
$unknown?: never;
|
|
3514
|
+
}
|
|
3515
|
+
interface $UnknownMember {
|
|
3516
|
+
StringValue?: never;
|
|
3517
|
+
NumericValue?: never;
|
|
3518
|
+
NotApplicable?: never;
|
|
3519
|
+
$unknown: [string, any];
|
|
3520
|
+
}
|
|
3521
|
+
interface Visitor<T> {
|
|
3522
|
+
StringValue: (value: string) => T;
|
|
3523
|
+
NumericValue: (value: number) => T;
|
|
3524
|
+
NotApplicable: (value: boolean) => T;
|
|
3525
|
+
_: (name: string, value: any) => T;
|
|
3526
|
+
}
|
|
3527
|
+
const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
|
|
3528
|
+
}
|
|
3529
|
+
/**
|
|
3530
|
+
* @public
|
|
3531
|
+
* <p>Information about output answers for a contact evaluation.</p>
|
|
3532
|
+
*/
|
|
3533
|
+
export interface EvaluationAnswerOutput {
|
|
3534
|
+
/**
|
|
3535
|
+
* <p>The value for an answer in a contact evaluation.</p>
|
|
3536
|
+
*/
|
|
3537
|
+
Value?: EvaluationAnswerData;
|
|
3538
|
+
/**
|
|
3539
|
+
* <p>The system suggested value for an answer in a contact evaluation.</p>
|
|
3540
|
+
*/
|
|
3541
|
+
SystemSuggestedValue?: EvaluationAnswerData;
|
|
3542
|
+
}
|
|
3543
|
+
/**
|
|
3544
|
+
* @public
|
|
3545
|
+
* <p>Information about scores of a contact evaluation item (section or question).</p>
|
|
3546
|
+
*/
|
|
3547
|
+
export interface EvaluationScore {
|
|
3548
|
+
/**
|
|
3549
|
+
* <p>The score percentage for an item in a contact evaluation.</p>
|
|
3550
|
+
*/
|
|
3551
|
+
Percentage?: number;
|
|
3552
|
+
/**
|
|
3553
|
+
* <p>The flag to mark the item as not applicable for scoring.</p>
|
|
3554
|
+
*/
|
|
3555
|
+
NotApplicable?: boolean;
|
|
3556
|
+
/**
|
|
3557
|
+
* <p>The flag that marks the item as automatic fail. If the item or a child item gets an
|
|
3558
|
+
* automatic fail answer, this flag will be true.</p>
|
|
3559
|
+
*/
|
|
3560
|
+
AutomaticFail?: boolean;
|
|
3561
|
+
}
|
|
3562
|
+
/**
|
|
3563
|
+
* @public
|
|
3564
|
+
* <p>Metadata information about a contact evaluation.</p>
|
|
3565
|
+
*/
|
|
3566
|
+
export interface EvaluationMetadata {
|
|
3567
|
+
/**
|
|
3568
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
3569
|
+
*/
|
|
3570
|
+
ContactId: string | undefined;
|
|
3571
|
+
/**
|
|
3572
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation.</p>
|
|
3573
|
+
*/
|
|
3574
|
+
EvaluatorArn: string | undefined;
|
|
3575
|
+
/**
|
|
3576
|
+
* <p>The identifier of the agent who performed the contact.</p>
|
|
3577
|
+
*/
|
|
3578
|
+
ContactAgentId?: string;
|
|
3579
|
+
/**
|
|
3580
|
+
* <p>The overall score of the contact evaluation.</p>
|
|
3581
|
+
*/
|
|
3582
|
+
Score?: EvaluationScore;
|
|
3583
|
+
}
|
|
3584
|
+
/**
|
|
3585
|
+
* @public
|
|
3586
|
+
* <p>Information about notes for a contact evaluation.</p>
|
|
3587
|
+
*/
|
|
3588
|
+
export interface EvaluationNote {
|
|
3589
|
+
/**
|
|
3590
|
+
* <p>The note for an item (section or question) in a contact evaluation.</p>
|
|
3591
|
+
*/
|
|
3592
|
+
Value?: string;
|
|
3593
|
+
}
|
|
3594
|
+
/**
|
|
3595
|
+
* @public
|
|
3596
|
+
* @enum
|
|
3597
|
+
*/
|
|
3598
|
+
export declare const EvaluationStatus: {
|
|
3599
|
+
readonly DRAFT: "DRAFT";
|
|
3600
|
+
readonly SUBMITTED: "SUBMITTED";
|
|
3601
|
+
};
|
|
3602
|
+
/**
|
|
3603
|
+
* @public
|
|
3604
|
+
*/
|
|
3605
|
+
export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof EvaluationStatus];
|
|
3606
|
+
/**
|
|
3607
|
+
* @public
|
|
3608
|
+
* <p>Information about a contact evaluation.</p>
|
|
3609
|
+
*/
|
|
3610
|
+
export interface Evaluation {
|
|
3611
|
+
/**
|
|
3612
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
3613
|
+
*/
|
|
3614
|
+
EvaluationId: string | undefined;
|
|
3615
|
+
/**
|
|
3616
|
+
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
|
|
3617
|
+
*/
|
|
3618
|
+
EvaluationArn: string | undefined;
|
|
3619
|
+
/**
|
|
3620
|
+
* <p>Metadata about the contact evaluation.</p>
|
|
3621
|
+
*/
|
|
3622
|
+
Metadata: EvaluationMetadata | undefined;
|
|
3623
|
+
/**
|
|
3624
|
+
* <p>A map of question identifiers to answer value.</p>
|
|
3625
|
+
*/
|
|
3626
|
+
Answers: Record<string, EvaluationAnswerOutput> | undefined;
|
|
3627
|
+
/**
|
|
3628
|
+
* <p>A map of question identifiers to note value.</p>
|
|
3629
|
+
*/
|
|
3630
|
+
Notes: Record<string, EvaluationNote> | undefined;
|
|
3631
|
+
/**
|
|
3632
|
+
* <p>The status of the contact evaluation.</p>
|
|
3633
|
+
*/
|
|
3634
|
+
Status: EvaluationStatus | string | undefined;
|
|
3635
|
+
/**
|
|
3636
|
+
* <p>A map of item (section or question) identifiers to score value.</p>
|
|
3637
|
+
*/
|
|
3638
|
+
Scores?: Record<string, EvaluationScore>;
|
|
3639
|
+
/**
|
|
3640
|
+
* <p>The timestamp for when the evaluation was created.</p>
|
|
3641
|
+
*/
|
|
3642
|
+
CreatedTime: Date | undefined;
|
|
3643
|
+
/**
|
|
3644
|
+
* <p>The timestamp for when the evaluation was last updated.</p>
|
|
3645
|
+
*/
|
|
3646
|
+
LastModifiedTime: Date | undefined;
|
|
3647
|
+
/**
|
|
3648
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
3649
|
+
*/
|
|
3650
|
+
Tags?: Record<string, string>;
|
|
3651
|
+
}
|
|
2978
3652
|
/**
|
|
2979
3653
|
* @public
|
|
2980
3654
|
* <p>The flow has not been published.</p>
|
|
@@ -3145,6 +3819,35 @@ export interface DescribeContactFlowModuleResponse {
|
|
|
3145
3819
|
*/
|
|
3146
3820
|
ContactFlowModule?: ContactFlowModule;
|
|
3147
3821
|
}
|
|
3822
|
+
/**
|
|
3823
|
+
* @public
|
|
3824
|
+
*/
|
|
3825
|
+
export interface DescribeEvaluationFormRequest {
|
|
3826
|
+
/**
|
|
3827
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
3828
|
+
*/
|
|
3829
|
+
InstanceId: string | undefined;
|
|
3830
|
+
/**
|
|
3831
|
+
* <p>A unique identifier for the contact evaluation.</p>
|
|
3832
|
+
*/
|
|
3833
|
+
EvaluationFormId: string | undefined;
|
|
3834
|
+
/**
|
|
3835
|
+
* <p>A version of the evaluation form.</p>
|
|
3836
|
+
*/
|
|
3837
|
+
EvaluationFormVersion?: number;
|
|
3838
|
+
}
|
|
3839
|
+
/**
|
|
3840
|
+
* @public
|
|
3841
|
+
* @enum
|
|
3842
|
+
*/
|
|
3843
|
+
export declare const EvaluationFormVersionStatus: {
|
|
3844
|
+
readonly ACTIVE: "ACTIVE";
|
|
3845
|
+
readonly DRAFT: "DRAFT";
|
|
3846
|
+
};
|
|
3847
|
+
/**
|
|
3848
|
+
* @public
|
|
3849
|
+
*/
|
|
3850
|
+
export type EvaluationFormVersionStatus = (typeof EvaluationFormVersionStatus)[keyof typeof EvaluationFormVersionStatus];
|
|
3148
3851
|
/**
|
|
3149
3852
|
* @public
|
|
3150
3853
|
*/
|
|
@@ -5062,1139 +5765,14 @@ export interface ContactFilter {
|
|
|
5062
5765
|
ContactStates?: (ContactState | string)[];
|
|
5063
5766
|
}
|
|
5064
5767
|
/**
|
|
5065
|
-
* @
|
|
5066
|
-
* <p>A filter for the user data.</p>
|
|
5067
|
-
*/
|
|
5068
|
-
export interface UserDataFilters {
|
|
5069
|
-
/**
|
|
5070
|
-
* <p>A list of up to 100 queues or ARNs.</p>
|
|
5071
|
-
*/
|
|
5072
|
-
Queues?: string[];
|
|
5073
|
-
/**
|
|
5074
|
-
* <p>A filter for the user data based on the contact information that is associated to the user.
|
|
5075
|
-
* It contains a list of contact states. </p>
|
|
5076
|
-
*/
|
|
5077
|
-
ContactFilter?: ContactFilter;
|
|
5078
|
-
/**
|
|
5079
|
-
* <p>A list of up to 100 routing profile IDs or ARNs.</p>
|
|
5080
|
-
*/
|
|
5081
|
-
RoutingProfiles?: string[];
|
|
5082
|
-
/**
|
|
5083
|
-
* <p>A list of up to 100 agent IDs or ARNs.</p>
|
|
5084
|
-
*/
|
|
5085
|
-
Agents?: string[];
|
|
5086
|
-
/**
|
|
5087
|
-
* <p>A UserHierarchyGroup ID or ARN.</p>
|
|
5088
|
-
*/
|
|
5089
|
-
UserHierarchyGroups?: string[];
|
|
5090
|
-
}
|
|
5091
|
-
/**
|
|
5092
|
-
* @public
|
|
5093
|
-
*/
|
|
5094
|
-
export interface GetCurrentUserDataRequest {
|
|
5095
|
-
/**
|
|
5096
|
-
* <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>
|
|
5097
|
-
*/
|
|
5098
|
-
InstanceId: string | undefined;
|
|
5099
|
-
/**
|
|
5100
|
-
* <p>The filters to apply to returned user data. You can filter up to the following
|
|
5101
|
-
* limits:</p>
|
|
5102
|
-
* <ul>
|
|
5103
|
-
* <li>
|
|
5104
|
-
* <p>Queues: 100</p>
|
|
5105
|
-
* </li>
|
|
5106
|
-
* <li>
|
|
5107
|
-
* <p>Routing profiles: 100</p>
|
|
5108
|
-
* </li>
|
|
5109
|
-
* <li>
|
|
5110
|
-
* <p>Agents: 100</p>
|
|
5111
|
-
* </li>
|
|
5112
|
-
* <li>
|
|
5113
|
-
* <p>Contact states: 9</p>
|
|
5114
|
-
* </li>
|
|
5115
|
-
* <li>
|
|
5116
|
-
* <p>User hierarchy groups: 1</p>
|
|
5117
|
-
* </li>
|
|
5118
|
-
* </ul>
|
|
5119
|
-
* <p> The user data is retrieved for only the specified values/resources in the filter. A maximum
|
|
5120
|
-
* of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups. </p>
|
|
5121
|
-
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
5122
|
-
*/
|
|
5123
|
-
Filters: UserDataFilters | undefined;
|
|
5124
|
-
/**
|
|
5125
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5126
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
5127
|
-
*/
|
|
5128
|
-
NextToken?: string;
|
|
5129
|
-
/**
|
|
5130
|
-
* <p>The maximum number of results to return per page.</p>
|
|
5131
|
-
*/
|
|
5132
|
-
MaxResults?: number;
|
|
5133
|
-
}
|
|
5134
|
-
/**
|
|
5135
|
-
* @public
|
|
5136
|
-
* <p>Information about the hierarchy group.</p>
|
|
5768
|
+
* @internal
|
|
5137
5769
|
*/
|
|
5138
|
-
export
|
|
5139
|
-
/**
|
|
5140
|
-
* <p>The unique identifier for the hierarchy group.</p>
|
|
5141
|
-
*/
|
|
5142
|
-
Id?: string;
|
|
5143
|
-
/**
|
|
5144
|
-
* <p>The Amazon Resource Name (ARN) for the hierarchy group. </p>
|
|
5145
|
-
*/
|
|
5146
|
-
Arn?: string;
|
|
5147
|
-
}
|
|
5770
|
+
export declare const CreateInstanceRequestFilterSensitiveLog: (obj: CreateInstanceRequest) => any;
|
|
5148
5771
|
/**
|
|
5149
|
-
* @
|
|
5150
|
-
* <p>Information about the levels in the hierarchy group.</p>
|
|
5772
|
+
* @internal
|
|
5151
5773
|
*/
|
|
5152
|
-
export
|
|
5153
|
-
/**
|
|
5154
|
-
* <p>Information about level one.</p>
|
|
5155
|
-
*/
|
|
5156
|
-
LevelOne?: HierarchyGroupSummaryReference;
|
|
5157
|
-
/**
|
|
5158
|
-
* <p>Information about level two.</p>
|
|
5159
|
-
*/
|
|
5160
|
-
LevelTwo?: HierarchyGroupSummaryReference;
|
|
5161
|
-
/**
|
|
5162
|
-
* <p>Information about level three.</p>
|
|
5163
|
-
*/
|
|
5164
|
-
LevelThree?: HierarchyGroupSummaryReference;
|
|
5165
|
-
/**
|
|
5166
|
-
* <p>Information about level four.</p>
|
|
5167
|
-
*/
|
|
5168
|
-
LevelFour?: HierarchyGroupSummaryReference;
|
|
5169
|
-
/**
|
|
5170
|
-
* <p>Information about level five.</p>
|
|
5171
|
-
*/
|
|
5172
|
-
LevelFive?: HierarchyGroupSummaryReference;
|
|
5173
|
-
}
|
|
5774
|
+
export declare const InstanceFilterSensitiveLog: (obj: Instance) => any;
|
|
5174
5775
|
/**
|
|
5175
|
-
* @
|
|
5176
|
-
* <p>Information about the user.</p>
|
|
5177
|
-
*/
|
|
5178
|
-
export interface UserReference {
|
|
5179
|
-
/**
|
|
5180
|
-
* <p>The unique identifier for the user.</p>
|
|
5181
|
-
*/
|
|
5182
|
-
Id?: string;
|
|
5183
|
-
/**
|
|
5184
|
-
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
5185
|
-
*/
|
|
5186
|
-
Arn?: string;
|
|
5187
|
-
}
|
|
5188
|
-
/**
|
|
5189
|
-
* @public
|
|
5190
|
-
* <p>Data for a user.</p>
|
|
5191
|
-
*/
|
|
5192
|
-
export interface UserData {
|
|
5193
|
-
/**
|
|
5194
|
-
* <p>Information about the user for the data that is returned. It contains the
|
|
5195
|
-
* <code>resourceId</code> and ARN of the user. </p>
|
|
5196
|
-
*/
|
|
5197
|
-
User?: UserReference;
|
|
5198
|
-
/**
|
|
5199
|
-
* <p>Information about the routing profile that is assigned to the user.</p>
|
|
5200
|
-
*/
|
|
5201
|
-
RoutingProfile?: RoutingProfileReference;
|
|
5202
|
-
/**
|
|
5203
|
-
* <p>Contains information about the levels of a hierarchy group assigned to a user.</p>
|
|
5204
|
-
*/
|
|
5205
|
-
HierarchyPath?: HierarchyPathReference;
|
|
5206
|
-
/**
|
|
5207
|
-
* <p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that
|
|
5208
|
-
* the supervisor manually changes in the real-time metrics report.</p>
|
|
5209
|
-
*/
|
|
5210
|
-
Status?: AgentStatusReference;
|
|
5211
|
-
/**
|
|
5212
|
-
* <p>A map of available slots by channel. The key is a channel name. The value is an integer: the
|
|
5213
|
-
* available number of slots. </p>
|
|
5214
|
-
*/
|
|
5215
|
-
AvailableSlotsByChannel?: Record<string, number>;
|
|
5216
|
-
/**
|
|
5217
|
-
* <p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the
|
|
5218
|
-
* 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
|
|
5219
|
-
* <code>RoutingProfile</code> assigned to the agent. </p>
|
|
5220
|
-
*/
|
|
5221
|
-
MaxSlotsByChannel?: Record<string, number>;
|
|
5222
|
-
/**
|
|
5223
|
-
* <p> A map of active slots by channel. The key is a channel name. The value is an integer: the
|
|
5224
|
-
* number of active slots. </p>
|
|
5225
|
-
*/
|
|
5226
|
-
ActiveSlotsByChannel?: Record<string, number>;
|
|
5227
|
-
/**
|
|
5228
|
-
* <p>A list of contact reference information.</p>
|
|
5229
|
-
*/
|
|
5230
|
-
Contacts?: AgentContactReference[];
|
|
5231
|
-
/**
|
|
5232
|
-
* <p>The Next status of the agent.</p>
|
|
5233
|
-
*/
|
|
5234
|
-
NextStatus?: string;
|
|
5235
|
-
}
|
|
5236
|
-
/**
|
|
5237
|
-
* @public
|
|
5238
|
-
*/
|
|
5239
|
-
export interface GetCurrentUserDataResponse {
|
|
5240
|
-
/**
|
|
5241
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5242
|
-
*/
|
|
5243
|
-
NextToken?: string;
|
|
5244
|
-
/**
|
|
5245
|
-
* <p>A list of the user data that is returned.</p>
|
|
5246
|
-
*/
|
|
5247
|
-
UserDataList?: UserData[];
|
|
5248
|
-
/**
|
|
5249
|
-
* <p>The total count of the result, regardless of the current page size.</p>
|
|
5250
|
-
*/
|
|
5251
|
-
ApproximateTotalCount?: number;
|
|
5252
|
-
}
|
|
5253
|
-
/**
|
|
5254
|
-
* @public
|
|
5255
|
-
*/
|
|
5256
|
-
export interface GetFederationTokenRequest {
|
|
5257
|
-
/**
|
|
5258
|
-
* <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>
|
|
5259
|
-
*/
|
|
5260
|
-
InstanceId: string | undefined;
|
|
5261
|
-
}
|
|
5262
|
-
/**
|
|
5263
|
-
* @public
|
|
5264
|
-
* <p>Contains credentials to use for federation.</p>
|
|
5265
|
-
*/
|
|
5266
|
-
export interface Credentials {
|
|
5267
|
-
/**
|
|
5268
|
-
* <p>An access token generated for a federated user to access Amazon Connect.</p>
|
|
5269
|
-
*/
|
|
5270
|
-
AccessToken?: string;
|
|
5271
|
-
/**
|
|
5272
|
-
* <p>A token generated with an expiration time for the session a user is logged in to Amazon Connect.</p>
|
|
5273
|
-
*/
|
|
5274
|
-
AccessTokenExpiration?: Date;
|
|
5275
|
-
/**
|
|
5276
|
-
* <p>Renews a token generated for a user to access the Amazon Connect instance.</p>
|
|
5277
|
-
*/
|
|
5278
|
-
RefreshToken?: string;
|
|
5279
|
-
/**
|
|
5280
|
-
* <p>Renews the expiration timer for a generated token.</p>
|
|
5281
|
-
*/
|
|
5282
|
-
RefreshTokenExpiration?: Date;
|
|
5283
|
-
}
|
|
5284
|
-
/**
|
|
5285
|
-
* @public
|
|
5286
|
-
*/
|
|
5287
|
-
export interface GetFederationTokenResponse {
|
|
5288
|
-
/**
|
|
5289
|
-
* <p>The credentials to use for federation.</p>
|
|
5290
|
-
*/
|
|
5291
|
-
Credentials?: Credentials;
|
|
5292
|
-
/**
|
|
5293
|
-
* <p>The URL to sign into the user's instance. </p>
|
|
5294
|
-
*/
|
|
5295
|
-
SignInUrl?: string;
|
|
5296
|
-
/**
|
|
5297
|
-
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
5298
|
-
*/
|
|
5299
|
-
UserArn?: string;
|
|
5300
|
-
/**
|
|
5301
|
-
* <p>The identifier for the user.</p>
|
|
5302
|
-
*/
|
|
5303
|
-
UserId?: string;
|
|
5304
|
-
}
|
|
5305
|
-
/**
|
|
5306
|
-
* @public
|
|
5307
|
-
* <p>No user with the specified credentials was found in the Amazon Connect instance.</p>
|
|
5308
|
-
*/
|
|
5309
|
-
export declare class UserNotFoundException extends __BaseException {
|
|
5310
|
-
readonly name: "UserNotFoundException";
|
|
5311
|
-
readonly $fault: "client";
|
|
5312
|
-
Message?: string;
|
|
5313
|
-
/**
|
|
5314
|
-
* @internal
|
|
5315
|
-
*/
|
|
5316
|
-
constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
|
|
5317
|
-
}
|
|
5318
|
-
/**
|
|
5319
|
-
* @public
|
|
5320
|
-
* @enum
|
|
5321
|
-
*/
|
|
5322
|
-
export declare const HistoricalMetricName: {
|
|
5323
|
-
readonly ABANDON_TIME: "ABANDON_TIME";
|
|
5324
|
-
readonly AFTER_CONTACT_WORK_TIME: "AFTER_CONTACT_WORK_TIME";
|
|
5325
|
-
readonly API_CONTACTS_HANDLED: "API_CONTACTS_HANDLED";
|
|
5326
|
-
readonly CALLBACK_CONTACTS_HANDLED: "CALLBACK_CONTACTS_HANDLED";
|
|
5327
|
-
readonly CONTACTS_ABANDONED: "CONTACTS_ABANDONED";
|
|
5328
|
-
readonly CONTACTS_AGENT_HUNG_UP_FIRST: "CONTACTS_AGENT_HUNG_UP_FIRST";
|
|
5329
|
-
readonly CONTACTS_CONSULTED: "CONTACTS_CONSULTED";
|
|
5330
|
-
readonly CONTACTS_HANDLED: "CONTACTS_HANDLED";
|
|
5331
|
-
readonly CONTACTS_HANDLED_INCOMING: "CONTACTS_HANDLED_INCOMING";
|
|
5332
|
-
readonly CONTACTS_HANDLED_OUTBOUND: "CONTACTS_HANDLED_OUTBOUND";
|
|
5333
|
-
readonly CONTACTS_HOLD_ABANDONS: "CONTACTS_HOLD_ABANDONS";
|
|
5334
|
-
readonly CONTACTS_MISSED: "CONTACTS_MISSED";
|
|
5335
|
-
readonly CONTACTS_QUEUED: "CONTACTS_QUEUED";
|
|
5336
|
-
readonly CONTACTS_TRANSFERRED_IN: "CONTACTS_TRANSFERRED_IN";
|
|
5337
|
-
readonly CONTACTS_TRANSFERRED_IN_FROM_QUEUE: "CONTACTS_TRANSFERRED_IN_FROM_QUEUE";
|
|
5338
|
-
readonly CONTACTS_TRANSFERRED_OUT: "CONTACTS_TRANSFERRED_OUT";
|
|
5339
|
-
readonly CONTACTS_TRANSFERRED_OUT_FROM_QUEUE: "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE";
|
|
5340
|
-
readonly HANDLE_TIME: "HANDLE_TIME";
|
|
5341
|
-
readonly HOLD_TIME: "HOLD_TIME";
|
|
5342
|
-
readonly INTERACTION_AND_HOLD_TIME: "INTERACTION_AND_HOLD_TIME";
|
|
5343
|
-
readonly INTERACTION_TIME: "INTERACTION_TIME";
|
|
5344
|
-
readonly OCCUPANCY: "OCCUPANCY";
|
|
5345
|
-
readonly QUEUED_TIME: "QUEUED_TIME";
|
|
5346
|
-
readonly QUEUE_ANSWER_TIME: "QUEUE_ANSWER_TIME";
|
|
5347
|
-
readonly SERVICE_LEVEL: "SERVICE_LEVEL";
|
|
5348
|
-
};
|
|
5349
|
-
/**
|
|
5350
|
-
* @public
|
|
5351
|
-
*/
|
|
5352
|
-
export type HistoricalMetricName = (typeof HistoricalMetricName)[keyof typeof HistoricalMetricName];
|
|
5353
|
-
/**
|
|
5354
|
-
* @public
|
|
5355
|
-
* @enum
|
|
5356
|
-
*/
|
|
5357
|
-
export declare const Statistic: {
|
|
5358
|
-
readonly AVG: "AVG";
|
|
5359
|
-
readonly MAX: "MAX";
|
|
5360
|
-
readonly SUM: "SUM";
|
|
5361
|
-
};
|
|
5362
|
-
/**
|
|
5363
|
-
* @public
|
|
5364
|
-
*/
|
|
5365
|
-
export type Statistic = (typeof Statistic)[keyof typeof Statistic];
|
|
5366
|
-
/**
|
|
5367
|
-
* @public
|
|
5368
|
-
* @enum
|
|
5369
|
-
*/
|
|
5370
|
-
export declare const Comparison: {
|
|
5371
|
-
readonly LT: "LT";
|
|
5372
|
-
};
|
|
5373
|
-
/**
|
|
5374
|
-
* @public
|
|
5375
|
-
*/
|
|
5376
|
-
export type Comparison = (typeof Comparison)[keyof typeof Comparison];
|
|
5377
|
-
/**
|
|
5378
|
-
* @public
|
|
5379
|
-
* <p>Contains information about the threshold for service level metrics.</p>
|
|
5380
|
-
*/
|
|
5381
|
-
export interface Threshold {
|
|
5382
|
-
/**
|
|
5383
|
-
* <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
|
|
5384
|
-
*/
|
|
5385
|
-
Comparison?: Comparison | string;
|
|
5386
|
-
/**
|
|
5387
|
-
* <p>The threshold value to compare.</p>
|
|
5388
|
-
*/
|
|
5389
|
-
ThresholdValue?: number;
|
|
5390
|
-
}
|
|
5391
|
-
/**
|
|
5392
|
-
* @public
|
|
5393
|
-
* <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
|
|
5394
|
-
* Guide</i>.</p>
|
|
5395
|
-
*/
|
|
5396
|
-
export interface HistoricalMetric {
|
|
5397
|
-
/**
|
|
5398
|
-
* <p>The name of the metric.</p>
|
|
5399
|
-
*/
|
|
5400
|
-
Name?: HistoricalMetricName | string;
|
|
5401
|
-
/**
|
|
5402
|
-
* <p>The threshold for the metric, used with service level metrics.</p>
|
|
5403
|
-
*/
|
|
5404
|
-
Threshold?: Threshold;
|
|
5405
|
-
/**
|
|
5406
|
-
* <p>The statistic for the metric.</p>
|
|
5407
|
-
*/
|
|
5408
|
-
Statistic?: Statistic | string;
|
|
5409
|
-
/**
|
|
5410
|
-
* <p>The unit for the metric.</p>
|
|
5411
|
-
*/
|
|
5412
|
-
Unit?: Unit | string;
|
|
5413
|
-
}
|
|
5414
|
-
/**
|
|
5415
|
-
* @public
|
|
5416
|
-
*/
|
|
5417
|
-
export interface GetMetricDataRequest {
|
|
5418
|
-
/**
|
|
5419
|
-
* <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>
|
|
5420
|
-
*/
|
|
5421
|
-
InstanceId: string | undefined;
|
|
5422
|
-
/**
|
|
5423
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
5424
|
-
* retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,
|
|
5425
|
-
* such as 10:05, 10:10, 10:15.</p>
|
|
5426
|
-
* <p>The start time cannot be earlier than 24 hours before the time of the request. Historical
|
|
5427
|
-
* metrics are available only for 24 hours.</p>
|
|
5428
|
-
*/
|
|
5429
|
-
StartTime: Date | undefined;
|
|
5430
|
-
/**
|
|
5431
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
5432
|
-
* retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,
|
|
5433
|
-
* such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
|
|
5434
|
-
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
5435
|
-
*/
|
|
5436
|
-
EndTime: Date | undefined;
|
|
5437
|
-
/**
|
|
5438
|
-
* <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is
|
|
5439
|
-
* retrieved only for the resources associated with the queues or channels included in the filter.
|
|
5440
|
-
* You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
|
|
5441
|
-
* <note>
|
|
5442
|
-
* <p>To filter by <code>Queues</code>, enter the queue
|
|
5443
|
-
* ID/ARN, not the name of the queue.</p>
|
|
5444
|
-
* </note>
|
|
5445
|
-
*/
|
|
5446
|
-
Filters: Filters | undefined;
|
|
5447
|
-
/**
|
|
5448
|
-
* <p>The grouping applied to the metrics returned. For example, when results are grouped by
|
|
5449
|
-
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
|
|
5450
|
-
* each queue rather than aggregated for all queues.</p>
|
|
5451
|
-
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
|
|
5452
|
-
*/
|
|
5453
|
-
Groupings?: (Grouping | string)[];
|
|
5454
|
-
/**
|
|
5455
|
-
* <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The
|
|
5456
|
-
* 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
|
|
5457
|
-
* Guide</i>.</p>
|
|
5458
|
-
* <note>
|
|
5459
|
-
* <p>This API does not support a contacts
|
|
5460
|
-
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
5461
|
-
* </note>
|
|
5462
|
-
* <dl>
|
|
5463
|
-
* <dt>ABANDON_TIME</dt>
|
|
5464
|
-
* <dd>
|
|
5465
|
-
* <p>Unit: SECONDS</p>
|
|
5466
|
-
* <p>Statistic: AVG</p>
|
|
5467
|
-
* </dd>
|
|
5468
|
-
* <dt>AFTER_CONTACT_WORK_TIME</dt>
|
|
5469
|
-
* <dd>
|
|
5470
|
-
* <p>Unit: SECONDS</p>
|
|
5471
|
-
* <p>Statistic: AVG</p>
|
|
5472
|
-
* </dd>
|
|
5473
|
-
* <dt>API_CONTACTS_HANDLED</dt>
|
|
5474
|
-
* <dd>
|
|
5475
|
-
* <p>Unit: COUNT</p>
|
|
5476
|
-
* <p>Statistic: SUM</p>
|
|
5477
|
-
* </dd>
|
|
5478
|
-
* <dt>CALLBACK_CONTACTS_HANDLED</dt>
|
|
5479
|
-
* <dd>
|
|
5480
|
-
* <p>Unit: COUNT</p>
|
|
5481
|
-
* <p>Statistic: SUM</p>
|
|
5482
|
-
* </dd>
|
|
5483
|
-
* <dt>CONTACTS_ABANDONED</dt>
|
|
5484
|
-
* <dd>
|
|
5485
|
-
* <p>Unit: COUNT</p>
|
|
5486
|
-
* <p>Statistic: SUM</p>
|
|
5487
|
-
* </dd>
|
|
5488
|
-
* <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
|
|
5489
|
-
* <dd>
|
|
5490
|
-
* <p>Unit: COUNT</p>
|
|
5491
|
-
* <p>Statistic: SUM</p>
|
|
5492
|
-
* </dd>
|
|
5493
|
-
* <dt>CONTACTS_CONSULTED</dt>
|
|
5494
|
-
* <dd>
|
|
5495
|
-
* <p>Unit: COUNT</p>
|
|
5496
|
-
* <p>Statistic: SUM</p>
|
|
5497
|
-
* </dd>
|
|
5498
|
-
* <dt>CONTACTS_HANDLED</dt>
|
|
5499
|
-
* <dd>
|
|
5500
|
-
* <p>Unit: COUNT</p>
|
|
5501
|
-
* <p>Statistic: SUM</p>
|
|
5502
|
-
* </dd>
|
|
5503
|
-
* <dt>CONTACTS_HANDLED_INCOMING</dt>
|
|
5504
|
-
* <dd>
|
|
5505
|
-
* <p>Unit: COUNT</p>
|
|
5506
|
-
* <p>Statistic: SUM</p>
|
|
5507
|
-
* </dd>
|
|
5508
|
-
* <dt>CONTACTS_HANDLED_OUTBOUND</dt>
|
|
5509
|
-
* <dd>
|
|
5510
|
-
* <p>Unit: COUNT</p>
|
|
5511
|
-
* <p>Statistic: SUM</p>
|
|
5512
|
-
* </dd>
|
|
5513
|
-
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
5514
|
-
* <dd>
|
|
5515
|
-
* <p>Unit: COUNT</p>
|
|
5516
|
-
* <p>Statistic: SUM</p>
|
|
5517
|
-
* </dd>
|
|
5518
|
-
* <dt>CONTACTS_MISSED</dt>
|
|
5519
|
-
* <dd>
|
|
5520
|
-
* <p>Unit: COUNT</p>
|
|
5521
|
-
* <p>Statistic: SUM</p>
|
|
5522
|
-
* </dd>
|
|
5523
|
-
* <dt>CONTACTS_QUEUED</dt>
|
|
5524
|
-
* <dd>
|
|
5525
|
-
* <p>Unit: COUNT</p>
|
|
5526
|
-
* <p>Statistic: SUM</p>
|
|
5527
|
-
* </dd>
|
|
5528
|
-
* <dt>CONTACTS_TRANSFERRED_IN</dt>
|
|
5529
|
-
* <dd>
|
|
5530
|
-
* <p>Unit: COUNT</p>
|
|
5531
|
-
* <p>Statistic: SUM</p>
|
|
5532
|
-
* </dd>
|
|
5533
|
-
* <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
|
|
5534
|
-
* <dd>
|
|
5535
|
-
* <p>Unit: COUNT</p>
|
|
5536
|
-
* <p>Statistic: SUM</p>
|
|
5537
|
-
* </dd>
|
|
5538
|
-
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
5539
|
-
* <dd>
|
|
5540
|
-
* <p>Unit: COUNT</p>
|
|
5541
|
-
* <p>Statistic: SUM</p>
|
|
5542
|
-
* </dd>
|
|
5543
|
-
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
5544
|
-
* <dd>
|
|
5545
|
-
* <p>Unit: COUNT</p>
|
|
5546
|
-
* <p>Statistic: SUM</p>
|
|
5547
|
-
* </dd>
|
|
5548
|
-
* <dt>HANDLE_TIME</dt>
|
|
5549
|
-
* <dd>
|
|
5550
|
-
* <p>Unit: SECONDS</p>
|
|
5551
|
-
* <p>Statistic: AVG</p>
|
|
5552
|
-
* </dd>
|
|
5553
|
-
* <dt>HOLD_TIME</dt>
|
|
5554
|
-
* <dd>
|
|
5555
|
-
* <p>Unit: SECONDS</p>
|
|
5556
|
-
* <p>Statistic: AVG</p>
|
|
5557
|
-
* </dd>
|
|
5558
|
-
* <dt>INTERACTION_AND_HOLD_TIME</dt>
|
|
5559
|
-
* <dd>
|
|
5560
|
-
* <p>Unit: SECONDS</p>
|
|
5561
|
-
* <p>Statistic: AVG</p>
|
|
5562
|
-
* </dd>
|
|
5563
|
-
* <dt>INTERACTION_TIME</dt>
|
|
5564
|
-
* <dd>
|
|
5565
|
-
* <p>Unit: SECONDS</p>
|
|
5566
|
-
* <p>Statistic: AVG</p>
|
|
5567
|
-
* </dd>
|
|
5568
|
-
* <dt>OCCUPANCY</dt>
|
|
5569
|
-
* <dd>
|
|
5570
|
-
* <p>Unit: PERCENT</p>
|
|
5571
|
-
* <p>Statistic: AVG</p>
|
|
5572
|
-
* </dd>
|
|
5573
|
-
* <dt>QUEUE_ANSWER_TIME</dt>
|
|
5574
|
-
* <dd>
|
|
5575
|
-
* <p>Unit: SECONDS</p>
|
|
5576
|
-
* <p>Statistic: AVG</p>
|
|
5577
|
-
* </dd>
|
|
5578
|
-
* <dt>QUEUED_TIME</dt>
|
|
5579
|
-
* <dd>
|
|
5580
|
-
* <p>Unit: SECONDS</p>
|
|
5581
|
-
* <p>Statistic: MAX</p>
|
|
5582
|
-
* </dd>
|
|
5583
|
-
* <dt>SERVICE_LEVEL</dt>
|
|
5584
|
-
* <dd>
|
|
5585
|
-
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
5586
|
-
* <p>Unit: PERCENT</p>
|
|
5587
|
-
* <p>Statistic: AVG</p>
|
|
5588
|
-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5589
|
-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5590
|
-
* "Less than"). </p>
|
|
5591
|
-
* </dd>
|
|
5592
|
-
* </dl>
|
|
5593
|
-
*/
|
|
5594
|
-
HistoricalMetrics: HistoricalMetric[] | undefined;
|
|
5595
|
-
/**
|
|
5596
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5597
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
5598
|
-
*/
|
|
5599
|
-
NextToken?: string;
|
|
5600
|
-
/**
|
|
5601
|
-
* <p>The maximum number of results to return per page.</p>
|
|
5602
|
-
*/
|
|
5603
|
-
MaxResults?: number;
|
|
5604
|
-
}
|
|
5605
|
-
/**
|
|
5606
|
-
* @public
|
|
5607
|
-
* <p>Contains the data for a historical metric.</p>
|
|
5608
|
-
*/
|
|
5609
|
-
export interface HistoricalMetricData {
|
|
5610
|
-
/**
|
|
5611
|
-
* <p>Information about the metric.</p>
|
|
5612
|
-
*/
|
|
5613
|
-
Metric?: HistoricalMetric;
|
|
5614
|
-
/**
|
|
5615
|
-
* <p>The value of the metric.</p>
|
|
5616
|
-
*/
|
|
5617
|
-
Value?: number;
|
|
5618
|
-
}
|
|
5619
|
-
/**
|
|
5620
|
-
* @public
|
|
5621
|
-
* <p>Contains information about the historical metrics retrieved.</p>
|
|
5622
|
-
*/
|
|
5623
|
-
export interface HistoricalMetricResult {
|
|
5624
|
-
/**
|
|
5625
|
-
* <p>The dimension for the metrics.</p>
|
|
5626
|
-
*/
|
|
5627
|
-
Dimensions?: Dimensions;
|
|
5628
|
-
/**
|
|
5629
|
-
* <p>The set of metrics.</p>
|
|
5630
|
-
*/
|
|
5631
|
-
Collections?: HistoricalMetricData[];
|
|
5632
|
-
}
|
|
5633
|
-
/**
|
|
5634
|
-
* @public
|
|
5635
|
-
*/
|
|
5636
|
-
export interface GetMetricDataResponse {
|
|
5637
|
-
/**
|
|
5638
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5639
|
-
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
5640
|
-
* the token must use the same request parameters as the request that generated the token.</p>
|
|
5641
|
-
*/
|
|
5642
|
-
NextToken?: string;
|
|
5643
|
-
/**
|
|
5644
|
-
* <p>Information about the historical metrics.</p>
|
|
5645
|
-
* <p>If no grouping is specified, a summary of metric data is returned.</p>
|
|
5646
|
-
*/
|
|
5647
|
-
MetricResults?: HistoricalMetricResult[];
|
|
5648
|
-
}
|
|
5649
|
-
/**
|
|
5650
|
-
* @public
|
|
5651
|
-
* <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>
|
|
5652
|
-
*/
|
|
5653
|
-
export interface FilterV2 {
|
|
5654
|
-
/**
|
|
5655
|
-
* <p>The key to use for filtering data. For example, <code>QUEUE</code>, <code>ROUTING_PROFILE,
|
|
5656
|
-
* AGENT</code>, <code>CHANNEL</code>, <code>AGENT_HIERARCHY_LEVEL_ONE</code>,
|
|
5657
|
-
* <code>AGENT_HIERARCHY_LEVEL_TWO</code>, <code>AGENT_HIERARCHY_LEVEL_THREE</code>,
|
|
5658
|
-
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code>, <code>AGENT_HIERARCHY_LEVEL_FIVE</code>. There must be
|
|
5659
|
-
* at least 1 key and a maximum 5 keys. </p>
|
|
5660
|
-
*/
|
|
5661
|
-
FilterKey?: string;
|
|
5662
|
-
/**
|
|
5663
|
-
* <p>The identifiers to use for filtering data. For example, if you have a filter key of
|
|
5664
|
-
* <code>QUEUE</code>, you would add queue IDs or ARNs in <code>FilterValues</code>. </p>
|
|
5665
|
-
*/
|
|
5666
|
-
FilterValues?: string[];
|
|
5667
|
-
}
|
|
5668
|
-
/**
|
|
5669
|
-
* @public
|
|
5670
|
-
* <p>Contains information about the filter used when retrieving metrics.
|
|
5671
|
-
* <code>MetricFiltersV2</code> can be used on the following metrics:
|
|
5672
|
-
* <code>AVG_AGENT_CONNECTING_TIME</code>, <code>CONTACTS_CREATED</code>,
|
|
5673
|
-
* <code>CONTACTS_HANDLED</code>, <code>SUM_CONTACTS_DISCONNECTED</code>.</p>
|
|
5674
|
-
*/
|
|
5675
|
-
export interface MetricFilterV2 {
|
|
5676
|
-
/**
|
|
5677
|
-
* <p>The key to use for filtering data. </p>
|
|
5678
|
-
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
|
|
5679
|
-
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
|
|
5680
|
-
* 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>
|
|
5681
|
-
*/
|
|
5682
|
-
MetricFilterKey?: string;
|
|
5683
|
-
/**
|
|
5684
|
-
* <p>The values to use for filtering data. </p>
|
|
5685
|
-
* <p>Valid metric filter values for <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
|
|
5686
|
-
* <code>OUTBOUND</code> | <code>TRANSFER</code> | <code>QUEUE_TRANSFER</code> |
|
|
5687
|
-
* <code>CALLBACK</code> | <code>API</code>
|
|
5688
|
-
* </p>
|
|
5689
|
-
* <p>Valid metric filter values for <code>DISCONNECT_REASON</code>:
|
|
5690
|
-
* <code>CUSTOMER_DISCONNECT</code> | <code>AGENT_DISCONNECT</code> |
|
|
5691
|
-
* <code>THIRD_PARTY_DISCONNECT</code> | <code>TELECOM_PROBLEM</code> | <code>BARGED</code> |
|
|
5692
|
-
* <code>CONTACT_FLOW_DISCONNECT</code> | <code>OTHER</code> | <code>EXPIRED</code> |
|
|
5693
|
-
* <code>API</code>
|
|
5694
|
-
* </p>
|
|
5695
|
-
*/
|
|
5696
|
-
MetricFilterValues?: string[];
|
|
5697
|
-
}
|
|
5698
|
-
/**
|
|
5699
|
-
* @public
|
|
5700
|
-
* <p>Contains information about the threshold for service level metrics.</p>
|
|
5701
|
-
*/
|
|
5702
|
-
export interface ThresholdV2 {
|
|
5703
|
-
/**
|
|
5704
|
-
* <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
|
|
5705
|
-
*/
|
|
5706
|
-
Comparison?: string;
|
|
5707
|
-
/**
|
|
5708
|
-
* <p>The threshold value to compare.</p>
|
|
5709
|
-
*/
|
|
5710
|
-
ThresholdValue?: number;
|
|
5711
|
-
}
|
|
5712
|
-
/**
|
|
5713
|
-
* @public
|
|
5714
|
-
* <p>Contains information about the metric.</p>
|
|
5715
|
-
*/
|
|
5716
|
-
export interface MetricV2 {
|
|
5717
|
-
/**
|
|
5718
|
-
* <p>The name of the metric.</p>
|
|
5719
|
-
*/
|
|
5720
|
-
Name?: string;
|
|
5721
|
-
/**
|
|
5722
|
-
* <p>Contains information about the threshold for service level metrics.</p>
|
|
5723
|
-
*/
|
|
5724
|
-
Threshold?: ThresholdV2[];
|
|
5725
|
-
/**
|
|
5726
|
-
* <p>Contains the filters to be used when returning data.</p>
|
|
5727
|
-
*/
|
|
5728
|
-
MetricFilters?: MetricFilterV2[];
|
|
5729
|
-
}
|
|
5730
|
-
/**
|
|
5731
|
-
* @public
|
|
5732
|
-
*/
|
|
5733
|
-
export interface GetMetricDataV2Request {
|
|
5734
|
-
/**
|
|
5735
|
-
* <p>The Amazon Resource Name (ARN) of the resource. This includes the <code>instanceId</code> an Amazon Connect
|
|
5736
|
-
* instance.</p>
|
|
5737
|
-
*/
|
|
5738
|
-
ResourceArn: string | undefined;
|
|
5739
|
-
/**
|
|
5740
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
5741
|
-
* retrieval of historical metrics data. The time must be before the end time timestamp. The time
|
|
5742
|
-
* range between the start and end time must be less than 24 hours. The start time cannot be earlier
|
|
5743
|
-
* than 14 days before the time of the request. Historical metrics are available for 14 days.</p>
|
|
5744
|
-
*/
|
|
5745
|
-
StartTime: Date | undefined;
|
|
5746
|
-
/**
|
|
5747
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
5748
|
-
* retrieval of historical metrics data. The time must be later than the start time timestamp. It
|
|
5749
|
-
* cannot be later than the current timestamp.</p>
|
|
5750
|
-
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
5751
|
-
*/
|
|
5752
|
-
EndTime: Date | undefined;
|
|
5753
|
-
/**
|
|
5754
|
-
* <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
|
|
5755
|
-
* <ul>
|
|
5756
|
-
* <li>
|
|
5757
|
-
* <p>Queues</p>
|
|
5758
|
-
* </li>
|
|
5759
|
-
* <li>
|
|
5760
|
-
* <p>Routing profiles</p>
|
|
5761
|
-
* </li>
|
|
5762
|
-
* <li>
|
|
5763
|
-
* <p>Agents</p>
|
|
5764
|
-
* </li>
|
|
5765
|
-
* <li>
|
|
5766
|
-
* <p>Channels</p>
|
|
5767
|
-
* </li>
|
|
5768
|
-
* <li>
|
|
5769
|
-
* <p>User hierarchy groups</p>
|
|
5770
|
-
* </li>
|
|
5771
|
-
* </ul>
|
|
5772
|
-
* <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
|
|
5773
|
-
* groups.</p>
|
|
5774
|
-
* <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
|
|
5775
|
-
* metrics report</a> in the <i>Amazon Connect Administrator's
|
|
5776
|
-
* Guide</i>.</p>
|
|
5777
|
-
* <p>Note the following limits:</p>
|
|
5778
|
-
* <ul>
|
|
5779
|
-
* <li>
|
|
5780
|
-
* <p>
|
|
5781
|
-
* <b>Filter keys</b>: A maximum of 5 filter keys are supported in
|
|
5782
|
-
* a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
|
|
5783
|
-
* <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
5784
|
-
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
5785
|
-
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
|
|
5786
|
-
* </p>
|
|
5787
|
-
* </li>
|
|
5788
|
-
* <li>
|
|
5789
|
-
* <p>
|
|
5790
|
-
* <b>Filter values</b>: A maximum of 100 filter values are
|
|
5791
|
-
* supported in a single request. For example, a <code>GetMetricDataV2</code> request can filter
|
|
5792
|
-
* by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values.
|
|
5793
|
-
* <code>VOICE</code>, <code>CHAT</code>, and <code>TASK</code> are valid
|
|
5794
|
-
* <code>filterValue</code> for the <code>CHANNEL</code> filter key.</p>
|
|
5795
|
-
* </li>
|
|
5796
|
-
* </ul>
|
|
5797
|
-
*/
|
|
5798
|
-
Filters: FilterV2[] | undefined;
|
|
5799
|
-
/**
|
|
5800
|
-
* <p>The grouping applied to the metrics that are returned. For example, when results are grouped
|
|
5801
|
-
* by queue, the metrics returned are grouped by queue. The values that are returned apply to the
|
|
5802
|
-
* metrics for each queue. They are not aggregated for all queues.</p>
|
|
5803
|
-
* <p>If no grouping is specified, a summary of all metrics is returned.</p>
|
|
5804
|
-
* <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
|
|
5805
|
-
* | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
|
|
5806
|
-
* <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
|
|
5807
|
-
* <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
|
|
5808
|
-
* </p>
|
|
5809
|
-
*/
|
|
5810
|
-
Groupings?: string[];
|
|
5811
|
-
/**
|
|
5812
|
-
* <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
|
|
5813
|
-
* 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
|
|
5814
|
-
* Guide</i>.</p>
|
|
5815
|
-
* <dl>
|
|
5816
|
-
* <dt>AGENT_ADHERENT_TIME</dt>
|
|
5817
|
-
* <dd>
|
|
5818
|
-
* <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>
|
|
5819
|
-
* <p>Unit: Seconds</p>
|
|
5820
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
5821
|
-
* </dd>
|
|
5822
|
-
* <dt>AGENT_NON_RESPONSE</dt>
|
|
5823
|
-
* <dd>
|
|
5824
|
-
* <p>Unit: Count</p>
|
|
5825
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
5826
|
-
* </dd>
|
|
5827
|
-
* <dt>AGENT_OCCUPANCY</dt>
|
|
5828
|
-
* <dd>
|
|
5829
|
-
* <p>Unit: Percentage</p>
|
|
5830
|
-
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p>
|
|
5831
|
-
* </dd>
|
|
5832
|
-
* <dt>AGENT_SCHEDULE_ADHERENCE</dt>
|
|
5833
|
-
* <dd>
|
|
5834
|
-
* <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>
|
|
5835
|
-
* <p>Unit: Percent</p>
|
|
5836
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5837
|
-
* </dd>
|
|
5838
|
-
* <dt>AGENT_SCHEDULED_TIME</dt>
|
|
5839
|
-
* <dd>
|
|
5840
|
-
* <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>
|
|
5841
|
-
* <p>Unit: Seconds</p>
|
|
5842
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5843
|
-
* </dd>
|
|
5844
|
-
* <dt>AVG_ABANDON_TIME</dt>
|
|
5845
|
-
* <dd>
|
|
5846
|
-
* <p>Unit: Seconds</p>
|
|
5847
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5848
|
-
* </dd>
|
|
5849
|
-
* <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
|
|
5850
|
-
* <dd>
|
|
5851
|
-
* <p>Unit: Seconds</p>
|
|
5852
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5853
|
-
* </dd>
|
|
5854
|
-
* <dt>AVG_AGENT_CONNECTING_TIME</dt>
|
|
5855
|
-
* <dd>
|
|
5856
|
-
* <p>Unit: Seconds</p>
|
|
5857
|
-
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
|
|
5858
|
-
* supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
|
|
5859
|
-
* <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
|
|
5860
|
-
* </p>
|
|
5861
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5862
|
-
* </dd>
|
|
5863
|
-
* <dt>AVG_HANDLE_TIME</dt>
|
|
5864
|
-
* <dd>
|
|
5865
|
-
* <p>Unit: Seconds</p>
|
|
5866
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5867
|
-
* </dd>
|
|
5868
|
-
* <dt>AVG_HOLD_TIME</dt>
|
|
5869
|
-
* <dd>
|
|
5870
|
-
* <p>Unit: Seconds</p>
|
|
5871
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5872
|
-
* </dd>
|
|
5873
|
-
* <dt>AVG_INTERACTION_AND_HOLD_TIME</dt>
|
|
5874
|
-
* <dd>
|
|
5875
|
-
* <p>Unit: Seconds</p>
|
|
5876
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5877
|
-
* </dd>
|
|
5878
|
-
* <dt>AVG_INTERACTION_TIME</dt>
|
|
5879
|
-
* <dd>
|
|
5880
|
-
* <p>Unit: Seconds</p>
|
|
5881
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5882
|
-
* </dd>
|
|
5883
|
-
* <dt>AVG_QUEUE_ANSWER_TIME</dt>
|
|
5884
|
-
* <dd>
|
|
5885
|
-
* <p>Unit: Seconds</p>
|
|
5886
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5887
|
-
* </dd>
|
|
5888
|
-
* <dt>CONTACTS_ABANDONED</dt>
|
|
5889
|
-
* <dd>
|
|
5890
|
-
* <p>Unit: Count</p>
|
|
5891
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5892
|
-
* </dd>
|
|
5893
|
-
* <dt>CONTACTS_CREATED</dt>
|
|
5894
|
-
* <dd>
|
|
5895
|
-
* <p>Unit: Count</p>
|
|
5896
|
-
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>
|
|
5897
|
-
* </p>
|
|
5898
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5899
|
-
* </dd>
|
|
5900
|
-
* <dt>CONTACTS_HANDLED</dt>
|
|
5901
|
-
* <dd>
|
|
5902
|
-
* <p>Unit: Count</p>
|
|
5903
|
-
* <p>Valid metric filter key: <code>INITIATION_METHOD</code>,
|
|
5904
|
-
* <code>DISCONNECT_REASON</code>
|
|
5905
|
-
* </p>
|
|
5906
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5907
|
-
* </dd>
|
|
5908
|
-
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
5909
|
-
* <dd>
|
|
5910
|
-
* <p>Unit: Count</p>
|
|
5911
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5912
|
-
* </dd>
|
|
5913
|
-
* <dt>CONTACTS_QUEUED</dt>
|
|
5914
|
-
* <dd>
|
|
5915
|
-
* <p>Unit: Count</p>
|
|
5916
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5917
|
-
* </dd>
|
|
5918
|
-
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
5919
|
-
* <dd>
|
|
5920
|
-
* <p>Unit: Count</p>
|
|
5921
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5922
|
-
* </dd>
|
|
5923
|
-
* <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt>
|
|
5924
|
-
* <dd>
|
|
5925
|
-
* <p>Unit: Count</p>
|
|
5926
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5927
|
-
* </dd>
|
|
5928
|
-
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
5929
|
-
* <dd>
|
|
5930
|
-
* <p>Unit: Count</p>
|
|
5931
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5932
|
-
* </dd>
|
|
5933
|
-
* <dt>MAX_QUEUED_TIME</dt>
|
|
5934
|
-
* <dd>
|
|
5935
|
-
* <p>Unit: Seconds</p>
|
|
5936
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5937
|
-
* </dd>
|
|
5938
|
-
* <dt>SERVICE_LEVEL</dt>
|
|
5939
|
-
* <dd>
|
|
5940
|
-
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
5941
|
-
* <p>Unit: Percent</p>
|
|
5942
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5943
|
-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5944
|
-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5945
|
-
* "Less than"). </p>
|
|
5946
|
-
* </dd>
|
|
5947
|
-
* <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
|
|
5948
|
-
* <dd>
|
|
5949
|
-
* <p>Unit: Count</p>
|
|
5950
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5951
|
-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5952
|
-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5953
|
-
* "Less than"). </p>
|
|
5954
|
-
* </dd>
|
|
5955
|
-
* <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
|
|
5956
|
-
* <dd>
|
|
5957
|
-
* <p>Unit: Count</p>
|
|
5958
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5959
|
-
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5960
|
-
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5961
|
-
* "Less than"). </p>
|
|
5962
|
-
* </dd>
|
|
5963
|
-
* <dt>SUM_CONTACTS_DISCONNECTED </dt>
|
|
5964
|
-
* <dd>
|
|
5965
|
-
* <p>Valid metric filter key: <code>DISCONNECT_REASON</code>
|
|
5966
|
-
* </p>
|
|
5967
|
-
* <p>Unit: Count</p>
|
|
5968
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5969
|
-
* </dd>
|
|
5970
|
-
* <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt>
|
|
5971
|
-
* <dd>
|
|
5972
|
-
* <p>Unit: Count</p>
|
|
5973
|
-
* <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
|
|
5974
|
-
* </dd>
|
|
5975
|
-
* </dl>
|
|
5976
|
-
*/
|
|
5977
|
-
Metrics: MetricV2[] | undefined;
|
|
5978
|
-
/**
|
|
5979
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5980
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
5981
|
-
*/
|
|
5982
|
-
NextToken?: string;
|
|
5983
|
-
/**
|
|
5984
|
-
* <p>The maximum number of results to return per page.</p>
|
|
5985
|
-
*/
|
|
5986
|
-
MaxResults?: number;
|
|
5987
|
-
}
|
|
5988
|
-
/**
|
|
5989
|
-
* @public
|
|
5990
|
-
* <p>Contains the name, thresholds, and metric filters.</p>
|
|
5991
|
-
*/
|
|
5992
|
-
export interface MetricDataV2 {
|
|
5993
|
-
/**
|
|
5994
|
-
* <p>The metric name, thresholds, and metric filters of the returned metric.</p>
|
|
5995
|
-
*/
|
|
5996
|
-
Metric?: MetricV2;
|
|
5997
|
-
/**
|
|
5998
|
-
* <p>The corresponding value of the metric returned in the response.</p>
|
|
5999
|
-
*/
|
|
6000
|
-
Value?: number;
|
|
6001
|
-
}
|
|
6002
|
-
/**
|
|
6003
|
-
* @public
|
|
6004
|
-
* <p>Contains information about the metric results.</p>
|
|
6005
|
-
*/
|
|
6006
|
-
export interface MetricResultV2 {
|
|
6007
|
-
/**
|
|
6008
|
-
* <p>The dimension for the metrics.</p>
|
|
6009
|
-
*/
|
|
6010
|
-
Dimensions?: Record<string, string>;
|
|
6011
|
-
/**
|
|
6012
|
-
* <p>The set of metrics.</p>
|
|
6013
|
-
*/
|
|
6014
|
-
Collections?: MetricDataV2[];
|
|
6015
|
-
}
|
|
6016
|
-
/**
|
|
6017
|
-
* @public
|
|
6018
|
-
*/
|
|
6019
|
-
export interface GetMetricDataV2Response {
|
|
6020
|
-
/**
|
|
6021
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6022
|
-
*/
|
|
6023
|
-
NextToken?: string;
|
|
6024
|
-
/**
|
|
6025
|
-
* <p>Information about the metrics requested in the API request If no grouping is specified, a
|
|
6026
|
-
* summary of metric data is returned. </p>
|
|
6027
|
-
*/
|
|
6028
|
-
MetricResults?: MetricResultV2[];
|
|
6029
|
-
}
|
|
6030
|
-
/**
|
|
6031
|
-
* @public
|
|
6032
|
-
*/
|
|
6033
|
-
export interface GetTaskTemplateRequest {
|
|
6034
|
-
/**
|
|
6035
|
-
* <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>
|
|
6036
|
-
*/
|
|
6037
|
-
InstanceId: string | undefined;
|
|
6038
|
-
/**
|
|
6039
|
-
* <p>A unique identifier for the task template.</p>
|
|
6040
|
-
*/
|
|
6041
|
-
TaskTemplateId: string | undefined;
|
|
6042
|
-
/**
|
|
6043
|
-
* <p>The system generated version of a task template that is associated with a task, when the
|
|
6044
|
-
* task is created.</p>
|
|
6045
|
-
*/
|
|
6046
|
-
SnapshotVersion?: string;
|
|
6047
|
-
}
|
|
6048
|
-
/**
|
|
6049
|
-
* @public
|
|
6050
|
-
*/
|
|
6051
|
-
export interface GetTaskTemplateResponse {
|
|
6052
|
-
/**
|
|
6053
|
-
* <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>
|
|
6054
|
-
*/
|
|
6055
|
-
InstanceId?: string;
|
|
6056
|
-
/**
|
|
6057
|
-
* <p>A unique identifier for the task template.</p>
|
|
6058
|
-
*/
|
|
6059
|
-
Id: string | undefined;
|
|
6060
|
-
/**
|
|
6061
|
-
* <p>The Amazon Resource Name (ARN).</p>
|
|
6062
|
-
*/
|
|
6063
|
-
Arn: string | undefined;
|
|
6064
|
-
/**
|
|
6065
|
-
* <p>The name of the task template.</p>
|
|
6066
|
-
*/
|
|
6067
|
-
Name: string | undefined;
|
|
6068
|
-
/**
|
|
6069
|
-
* <p>The description of the task template.</p>
|
|
6070
|
-
*/
|
|
6071
|
-
Description?: string;
|
|
6072
|
-
/**
|
|
6073
|
-
* <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
|
|
6074
|
-
*/
|
|
6075
|
-
ContactFlowId?: string;
|
|
6076
|
-
/**
|
|
6077
|
-
* <p>Constraints that are applicable to the fields listed.</p>
|
|
6078
|
-
*/
|
|
6079
|
-
Constraints?: TaskTemplateConstraints;
|
|
6080
|
-
/**
|
|
6081
|
-
* <p>The default values for fields when a task is created by referencing this template.</p>
|
|
6082
|
-
*/
|
|
6083
|
-
Defaults?: TaskTemplateDefaults;
|
|
6084
|
-
/**
|
|
6085
|
-
* <p>Fields that are part of the template.</p>
|
|
6086
|
-
*/
|
|
6087
|
-
Fields?: TaskTemplateField[];
|
|
6088
|
-
/**
|
|
6089
|
-
* <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
|
|
6090
|
-
* Tasks can only be created from <code>ACTIVE</code> templates.
|
|
6091
|
-
* If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
|
|
6092
|
-
*/
|
|
6093
|
-
Status?: TaskTemplateStatus | string;
|
|
6094
|
-
/**
|
|
6095
|
-
* <p>The timestamp when the task template was last modified.</p>
|
|
6096
|
-
*/
|
|
6097
|
-
LastModifiedTime?: Date;
|
|
6098
|
-
/**
|
|
6099
|
-
* <p>The timestamp when the task template was created.</p>
|
|
6100
|
-
*/
|
|
6101
|
-
CreatedTime?: Date;
|
|
6102
|
-
/**
|
|
6103
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
6104
|
-
*/
|
|
6105
|
-
Tags?: Record<string, string>;
|
|
6106
|
-
}
|
|
6107
|
-
/**
|
|
6108
|
-
* @public
|
|
6109
|
-
*/
|
|
6110
|
-
export interface GetTrafficDistributionRequest {
|
|
6111
|
-
/**
|
|
6112
|
-
* <p>The identifier of the traffic distribution group.</p>
|
|
6113
|
-
*/
|
|
6114
|
-
Id: string | undefined;
|
|
6115
|
-
}
|
|
6116
|
-
/**
|
|
6117
|
-
* @public
|
|
6118
|
-
* <p>Information about a traffic distribution.</p>
|
|
6119
|
-
*/
|
|
6120
|
-
export interface Distribution {
|
|
6121
|
-
/**
|
|
6122
|
-
* <p>The Amazon Web Services Region where the traffic is distributed.</p>
|
|
6123
|
-
*/
|
|
6124
|
-
Region: string | undefined;
|
|
6125
|
-
/**
|
|
6126
|
-
* <p>The percentage of the traffic that is distributed, in increments of 10.</p>
|
|
6127
|
-
*/
|
|
6128
|
-
Percentage: number | undefined;
|
|
6129
|
-
}
|
|
6130
|
-
/**
|
|
6131
|
-
* @public
|
|
6132
|
-
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
6133
|
-
*/
|
|
6134
|
-
export interface TelephonyConfig {
|
|
6135
|
-
/**
|
|
6136
|
-
* <p>Information about traffic distributions.</p>
|
|
6137
|
-
*/
|
|
6138
|
-
Distributions: Distribution[] | undefined;
|
|
6139
|
-
}
|
|
6140
|
-
/**
|
|
6141
|
-
* @public
|
|
6142
|
-
*/
|
|
6143
|
-
export interface GetTrafficDistributionResponse {
|
|
6144
|
-
/**
|
|
6145
|
-
* <p>The distribution of traffic between the instance and its replicas.</p>
|
|
6146
|
-
*/
|
|
6147
|
-
TelephonyConfig?: TelephonyConfig;
|
|
6148
|
-
/**
|
|
6149
|
-
* <p>The identifier of the traffic distribution group.
|
|
6150
|
-
* This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.
|
|
6151
|
-
* The ARN must be provided if the call is from the replicated Region.</p>
|
|
6152
|
-
*/
|
|
6153
|
-
Id?: string;
|
|
6154
|
-
/**
|
|
6155
|
-
* <p>The Amazon Resource Name (ARN) of the traffic distribution group.</p>
|
|
6156
|
-
*/
|
|
6157
|
-
Arn?: string;
|
|
6158
|
-
}
|
|
6159
|
-
/**
|
|
6160
|
-
* @public
|
|
6161
|
-
*/
|
|
6162
|
-
export interface ListAgentStatusRequest {
|
|
6163
|
-
/**
|
|
6164
|
-
* <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>
|
|
6165
|
-
*/
|
|
6166
|
-
InstanceId: string | undefined;
|
|
6167
|
-
/**
|
|
6168
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
6169
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
6170
|
-
*/
|
|
6171
|
-
NextToken?: string;
|
|
6172
|
-
/**
|
|
6173
|
-
* <p>The maximum number of results to return per page.</p>
|
|
6174
|
-
*/
|
|
6175
|
-
MaxResults?: number;
|
|
6176
|
-
/**
|
|
6177
|
-
* <p>Available agent status types.</p>
|
|
6178
|
-
*/
|
|
6179
|
-
AgentStatusTypes?: (AgentStatusType | string)[];
|
|
6180
|
-
}
|
|
6181
|
-
/**
|
|
6182
|
-
* @internal
|
|
6183
|
-
*/
|
|
6184
|
-
export declare const CreateInstanceRequestFilterSensitiveLog: (obj: CreateInstanceRequest) => any;
|
|
6185
|
-
/**
|
|
6186
|
-
* @internal
|
|
6187
|
-
*/
|
|
6188
|
-
export declare const InstanceFilterSensitiveLog: (obj: Instance) => any;
|
|
6189
|
-
/**
|
|
6190
|
-
* @internal
|
|
5776
|
+
* @internal
|
|
6191
5777
|
*/
|
|
6192
5778
|
export declare const DescribeInstanceResponseFilterSensitiveLog: (obj: DescribeInstanceResponse) => any;
|
|
6193
|
-
/**
|
|
6194
|
-
* @internal
|
|
6195
|
-
*/
|
|
6196
|
-
export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
|
|
6197
|
-
/**
|
|
6198
|
-
* @internal
|
|
6199
|
-
*/
|
|
6200
|
-
export declare const GetFederationTokenResponseFilterSensitiveLog: (obj: GetFederationTokenResponse) => any;
|