@aws-sdk/client-connect 3.370.0 → 3.372.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +4 -3
  2. package/dist-types/commands/CreateParticipantCommand.d.ts +1 -1
  3. package/dist-types/commands/CreatePromptCommand.d.ts +3 -1
  4. package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -1
  5. package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +4 -3
  6. package/dist-types/models/models_0.d.ts +4 -4
  7. package/dist-types/models/models_1.d.ts +116 -12
  8. package/package.json +1 -1
package/dist-types/commands/CreateEvaluationFormCommand.d.ts CHANGED
@@ -24,9 +24,10 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
24
24
  }
25
25
  /**
26
26
  * @public
27
- * <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define
28
- * questions related to agent performance, and create sections to organize such questions. Question and section identifiers
29
- * cannot be duplicated within the same evaluation form.</p>
27
+ * <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
28
+ * used to define questions related to agent performance, and create sections to organize such
29
+ * questions. Question and section identifiers cannot be duplicated within the same evaluation
30
+ * form.</p>
30
31
  * @example
31
32
  * Use a bare-bones client and the command you need to make an API call.
32
33
  * ```javascript
package/dist-types/commands/CreateParticipantCommand.d.ts CHANGED
@@ -24,7 +24,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
24
24
  /**
25
25
  * @public
26
26
  * <p>Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat
27
- * flow experiences by integrating custom participants</a>.</p>
27
+ * flow experiences by integrating custom participants</a>.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
package/dist-types/commands/CreatePromptCommand.d.ts CHANGED
@@ -23,7 +23,9 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's Guide</i>.</p>
26
+ * <p>Creates a prompt. For more information about prompts, such as supported file types and
27
+ * maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
28
+ * Guide</i>.</p>
27
29
  * @example
28
30
  * Use a bare-bones client and the command you need to make an API call.
29
31
  * ```javascript
package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts CHANGED
@@ -24,7 +24,8 @@ export interface SearchHoursOfOperationsCommandOutput extends SearchHoursOfOpera
24
24
  }
25
25
  /**
26
26
  * @public
27
- * <p>Searches the hours of operation in an Amazon Connect instance, with optional filtering.</p>
27
+ * <p>Searches the hours of operation in an Amazon Connect instance, with optional
28
+ * filtering.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
30
31
  * ```javascript
package/dist-types/commands/UpdateEvaluationFormCommand.d.ts CHANGED
@@ -25,9 +25,10 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
25
25
  /**
26
26
  * @public
27
27
  * <p>Updates details about a specific evaluation form version in the specified Amazon Connect
28
- * instance. Question and section
29
- * identifiers cannot be duplicated within the same evaluation form.</p>
30
- * <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>
28
+ * instance. Question and section identifiers cannot be duplicated within the same evaluation
29
+ * form.</p>
30
+ * <p>This operation does not support partial updates. Instead it does a full update of evaluation
31
+ * form content.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
package/dist-types/models/models_0.d.ts CHANGED
@@ -50,8 +50,8 @@ export interface ActivateEvaluationFormRequest {
50
50
  */
51
51
  EvaluationFormId: string | undefined;
52
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>
53
+ * <p>The version of the evaluation form to activate. If the version property is not provided, the
54
+ * latest version of the evaluation form is activated.</p>
55
55
  */
56
56
  EvaluationFormVersion: number | undefined;
57
57
  }
@@ -1797,8 +1797,8 @@ export interface ParticipantTokenCredentials {
1797
1797
  */
1798
1798
  export interface CreateParticipantResponse {
1799
1799
  /**
1800
- * <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
1801
- * token is valid for the lifetime of a chat participant.</p>
1800
+ * <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
1801
+ * participant token is valid for the lifetime of a chat participant.</p>
1802
1802
  */
1803
1803
  ParticipantCredentials?: ParticipantTokenCredentials;
1804
1804
  /**
package/dist-types/models/models_1.d.ts CHANGED
@@ -992,6 +992,9 @@ export interface GetMetricDataV2Request {
992
992
  * <li>
993
993
  * <p>User hierarchy groups</p>
994
994
  * </li>
995
+ * <li>
996
+ * <p>Feature</p>
997
+ * </li>
995
998
  * </ul>
996
999
  * <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
997
1000
  * groups.</p>
@@ -1006,16 +1009,21 @@ export interface GetMetricDataV2Request {
1006
1009
  * a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
1007
1010
  * <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
1008
1011
  * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
1009
- * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
1012
+ * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
1013
+ * <code>FEATURE</code>
1010
1014
  * </p>
1011
1015
  * </li>
1012
1016
  * <li>
1013
1017
  * <p>
1014
1018
  * <b>Filter values</b>: A maximum of 100 filter values are
1015
- * supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL
1016
- * filter key. They do not count towards limitation of 100 filter values. For example, a
1019
+ * supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the
1020
+ * CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a
1017
1021
  * GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total
1018
- * of 100 filter values, along with 3 channel filters.</p>
1022
+ * of 100 filter values, along with 3 channel filters. </p>
1023
+ * <p>
1024
+ * <code>contact_lens_conversational_analytics</code> is a valid filterValue for the
1025
+ * <code>FEATURE</code> filter key. It is available only to contacts analyzed by Contact Lens
1026
+ * conversational analytics.</p>
1019
1027
  * </li>
1020
1028
  * </ul>
1021
1029
  */
@@ -1073,7 +1081,10 @@ export interface GetMetricDataV2Request {
1073
1081
  * <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
1074
1082
  * <dd>
1075
1083
  * <p>Unit: Seconds</p>
1076
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1084
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1085
+ * <note>
1086
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1087
+ * </note>
1077
1088
  * </dd>
1078
1089
  * <dt>AVG_AGENT_CONNECTING_TIME</dt>
1079
1090
  * <dd>
@@ -1084,16 +1095,58 @@ export interface GetMetricDataV2Request {
1084
1095
  * </p>
1085
1096
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1086
1097
  * </dd>
1087
- * <dt>AVG_HANDLE_TIME</dt>
1098
+ * <dt>AVG_AGENT_CONNECTING_TIME</dt>
1088
1099
  * <dd>
1089
1100
  * <p>Unit: Seconds</p>
1101
+ * <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
1102
+ * supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
1103
+ * <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
1104
+ * </p>
1090
1105
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1091
1106
  * </dd>
1092
- * <dt>AVG_HOLD_TIME</dt>
1107
+ * <dt>AVG_CONTACT_DURATION</dt>
1108
+ * <dd>
1109
+ * <p>Unit: Seconds</p>
1110
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1111
+ * <note>
1112
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1113
+ * </note>
1114
+ * </dd>
1115
+ * <dt>AVG_CONVERSATION_DURATION</dt>
1093
1116
  * <dd>
1094
1117
  * <p>Unit: Seconds</p>
1095
1118
  * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1096
1119
  * </dd>
1120
+ * <dt>AVG_GREETING_TIME_AGENT</dt>
1121
+ * <dd>
1122
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1123
+ * <p>Unit: Seconds</p>
1124
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1125
+ * </dd>
1126
+ * <dt>AVG_HANDLE_TIME</dt>
1127
+ * <dd>
1128
+ * <p>Unit: Seconds</p>
1129
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1130
+ * <note>
1131
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1132
+ * </note>
1133
+ * </dd>
1134
+ * <dt>AVG_HOLD_TIME</dt>
1135
+ * <dd>
1136
+ * <p>Unit: Seconds</p>
1137
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1138
+ * <note>
1139
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1140
+ * </note>
1141
+ * </dd>
1142
+ * <dt>AVG_HOLDS</dt>
1143
+ * <dd>
1144
+ * <p>Unit: Count</p>
1145
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1146
+ * <note>
1147
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1148
+ * </note>
1149
+ * </dd>
1097
1150
  * <dt>AVG_INTERACTION_AND_HOLD_TIME</dt>
1098
1151
  * <dd>
1099
1152
  * <p>Unit: Seconds</p>
@@ -1102,12 +1155,54 @@ export interface GetMetricDataV2Request {
1102
1155
  * <dt>AVG_INTERACTION_TIME</dt>
1103
1156
  * <dd>
1104
1157
  * <p>Unit: Seconds</p>
1105
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
1158
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
1159
+ * <note>
1160
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1161
+ * </note>
1162
+ * </dd>
1163
+ * <dt>AVG_INTERRUPTIONS_AGENT</dt>
1164
+ * <dd>
1165
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1166
+ * <p>Unit: Count</p>
1167
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1168
+ * </dd>
1169
+ * <dt>AVG_INTERRUPTION_TIME_AGENT</dt>
1170
+ * <dd>
1171
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1172
+ * <p>Unit: Seconds</p>
1173
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1174
+ * </dd>
1175
+ * <dt>AVG_NON_TALK_TIME</dt>
1176
+ * <dd>
1177
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1178
+ * <p>Unit: Seconds</p>
1179
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1106
1180
  * </dd>
1107
1181
  * <dt>AVG_QUEUE_ANSWER_TIME</dt>
1108
1182
  * <dd>
1109
1183
  * <p>Unit: Seconds</p>
1110
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
1184
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
1185
+ * <note>
1186
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1187
+ * </note>
1188
+ * </dd>
1189
+ * <dt>AVG_TALK_TIME</dt>
1190
+ * <dd>
1191
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1192
+ * <p>Unit: Seconds</p>
1193
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1194
+ * </dd>
1195
+ * <dt>AVG_TALK_TIME_AGENT</dt>
1196
+ * <dd>
1197
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1198
+ * <p>Unit: Seconds</p>
1199
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1200
+ * </dd>
1201
+ * <dt>AVG_TALK_TIME_CUSTOMER</dt>
1202
+ * <dd>
1203
+ * <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p>
1204
+ * <p>Unit: Seconds</p>
1205
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1111
1206
  * </dd>
1112
1207
  * <dt>CONTACTS_ABANDONED</dt>
1113
1208
  * <dd>
@@ -1119,7 +1214,10 @@ export interface GetMetricDataV2Request {
1119
1214
  * <p>Unit: Count</p>
1120
1215
  * <p>Valid metric filter key: <code>INITIATION_METHOD</code>
1121
1216
  * </p>
1122
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
1217
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature</p>
1218
+ * <note>
1219
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1220
+ * </note>
1123
1221
  * </dd>
1124
1222
  * <dt>CONTACTS_HANDLED</dt>
1125
1223
  * <dd>
@@ -1127,7 +1225,10 @@ export interface GetMetricDataV2Request {
1127
1225
  * <p>Valid metric filter key: <code>INITIATION_METHOD</code>,
1128
1226
  * <code>DISCONNECT_REASON</code>
1129
1227
  * </p>
1130
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1228
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1229
+ * <note>
1230
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1231
+ * </note>
1131
1232
  * </dd>
1132
1233
  * <dt>CONTACTS_HOLD_ABANDONS</dt>
1133
1234
  * <dd>
@@ -1142,7 +1243,10 @@ export interface GetMetricDataV2Request {
1142
1243
  * <dt>CONTACTS_TRANSFERRED_OUT</dt>
1143
1244
  * <dd>
1144
1245
  * <p>Unit: Count</p>
1145
- * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
1246
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature</p>
1247
+ * <note>
1248
+ * <p>Feature is a valid filter but not a valid grouping.</p>
1249
+ * </note>
1146
1250
  * </dd>
1147
1251
  * <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt>
1148
1252
  * <dd>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connect",
3
3
  "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
4
- "version": "3.370.0",
4
+ "version": "3.372.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",