@aws-sdk/client-connect 3.231.0 → 3.232.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -4
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-es/models/models_0.js +2 -0
- package/dist-types/Connect.d.ts +9 -24
- package/dist-types/ConnectClient.d.ts +0 -4
- package/dist-types/commands/CreateContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +2 -0
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +0 -1
- package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetMetricDataCommand.d.ts +0 -1
- package/dist-types/commands/ListContactFlowsCommand.d.ts +1 -1
- package/dist-types/commands/ListInstanceStorageConfigsCommand.d.ts +0 -1
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +0 -1
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +0 -1
- package/dist-types/commands/SearchUsersCommand.d.ts +0 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +0 -3
- package/dist-types/commands/StartContactRecordingCommand.d.ts +0 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +0 -2
- package/dist-types/commands/StopContactCommand.d.ts +0 -1
- package/dist-types/commands/StopContactRecordingCommand.d.ts +0 -1
- package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContactFlowNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRuleCommand.d.ts +2 -0
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +6 -8
- package/dist-types/models/models_1.d.ts +2 -9
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,10 +20,6 @@ are also limits to the number of requests that you can make per second. For more
|
|
|
20
20
|
Guide</i>.</p>
|
|
21
21
|
<p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
|
|
22
22
|
a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
|
|
23
|
-
<note>
|
|
24
|
-
<p>Working with flows? Check out the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html">Amazon Connect Flow
|
|
25
|
-
language</a>.</p>
|
|
26
|
-
</note>
|
|
27
23
|
|
|
28
24
|
## Installing
|
|
29
25
|
|
|
@@ -194,8 +194,10 @@ var VocabularyLanguageCode;
|
|
|
194
194
|
VocabularyLanguageCode["EN_GB"] = "en-GB";
|
|
195
195
|
VocabularyLanguageCode["EN_IE"] = "en-IE";
|
|
196
196
|
VocabularyLanguageCode["EN_IN"] = "en-IN";
|
|
197
|
+
VocabularyLanguageCode["EN_NZ"] = "en-NZ";
|
|
197
198
|
VocabularyLanguageCode["EN_US"] = "en-US";
|
|
198
199
|
VocabularyLanguageCode["EN_WL"] = "en-WL";
|
|
200
|
+
VocabularyLanguageCode["EN_ZA"] = "en-ZA";
|
|
199
201
|
VocabularyLanguageCode["ES_ES"] = "es-ES";
|
|
200
202
|
VocabularyLanguageCode["ES_US"] = "es-US";
|
|
201
203
|
VocabularyLanguageCode["FR_CA"] = "fr-CA";
|
|
@@ -177,8 +177,10 @@ export var VocabularyLanguageCode;
|
|
|
177
177
|
VocabularyLanguageCode["EN_GB"] = "en-GB";
|
|
178
178
|
VocabularyLanguageCode["EN_IE"] = "en-IE";
|
|
179
179
|
VocabularyLanguageCode["EN_IN"] = "en-IN";
|
|
180
|
+
VocabularyLanguageCode["EN_NZ"] = "en-NZ";
|
|
180
181
|
VocabularyLanguageCode["EN_US"] = "en-US";
|
|
181
182
|
VocabularyLanguageCode["EN_WL"] = "en-WL";
|
|
183
|
+
VocabularyLanguageCode["EN_ZA"] = "en-ZA";
|
|
182
184
|
VocabularyLanguageCode["ES_ES"] = "es-ES";
|
|
183
185
|
VocabularyLanguageCode["ES_US"] = "es-US";
|
|
184
186
|
VocabularyLanguageCode["FR_CA"] = "fr-CA";
|
package/dist-types/Connect.d.ts
CHANGED
|
@@ -180,10 +180,6 @@ import { ConnectClient } from "./ConnectClient";
|
|
|
180
180
|
* Guide</i>.</p>
|
|
181
181
|
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
|
|
182
182
|
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
|
|
183
|
-
* <note>
|
|
184
|
-
* <p>Working with flows? Check out the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html">Amazon Connect Flow
|
|
185
|
-
* language</a>.</p>
|
|
186
|
-
* </note>
|
|
187
183
|
*/
|
|
188
184
|
export declare class Connect extends ConnectClient {
|
|
189
185
|
/**
|
|
@@ -297,7 +293,7 @@ export declare class Connect extends ConnectClient {
|
|
|
297
293
|
createAgentStatus(args: CreateAgentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAgentStatusCommandOutput) => void): void;
|
|
298
294
|
/**
|
|
299
295
|
* <p>Creates a flow for the specified Amazon Connect instance.</p>
|
|
300
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
296
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
301
297
|
* Flow language</a>.</p>
|
|
302
298
|
*/
|
|
303
299
|
createContactFlow(args: CreateContactFlowCommandInput, options?: __HttpHandlerOptions): Promise<CreateContactFlowCommandOutput>;
|
|
@@ -367,6 +363,8 @@ export declare class Connect extends ConnectClient {
|
|
|
367
363
|
createRoutingProfile(args: CreateRoutingProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRoutingProfileCommandOutput) => void): void;
|
|
368
364
|
/**
|
|
369
365
|
* <p>Creates a rule for the specified Amazon Connect instance.</p>
|
|
366
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
367
|
+
* </p>
|
|
370
368
|
*/
|
|
371
369
|
createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise<CreateRuleCommandOutput>;
|
|
372
370
|
createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void;
|
|
@@ -485,7 +483,6 @@ export declare class Connect extends ConnectClient {
|
|
|
485
483
|
/**
|
|
486
484
|
* <p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is
|
|
487
485
|
* created.</p>
|
|
488
|
-
*
|
|
489
486
|
* <p>For more information about deleting traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html">Delete traffic distribution groups</a> in
|
|
490
487
|
* the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
491
488
|
*/
|
|
@@ -543,7 +540,7 @@ export declare class Connect extends ConnectClient {
|
|
|
543
540
|
describeContact(args: DescribeContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeContactCommandOutput) => void): void;
|
|
544
541
|
/**
|
|
545
542
|
* <p>Describes the specified flow.</p>
|
|
546
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
543
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
547
544
|
* Flow language</a>.</p>
|
|
548
545
|
*/
|
|
549
546
|
describeContactFlow(args: DescribeContactFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeContactFlowCommandOutput>;
|
|
@@ -789,7 +786,6 @@ export declare class Connect extends ConnectClient {
|
|
|
789
786
|
getFederationToken(args: GetFederationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFederationTokenCommandOutput) => void): void;
|
|
790
787
|
/**
|
|
791
788
|
* <p>Gets historical metric data from the specified Amazon Connect instance.</p>
|
|
792
|
-
*
|
|
793
789
|
* <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics
|
|
794
790
|
* Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
795
791
|
*/
|
|
@@ -841,7 +837,7 @@ export declare class Connect extends ConnectClient {
|
|
|
841
837
|
listContactFlowModules(args: ListContactFlowModulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContactFlowModulesCommandOutput) => void): void;
|
|
842
838
|
/**
|
|
843
839
|
* <p>Provides information about the flows for the specified Amazon Connect instance.</p>
|
|
844
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
840
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
845
841
|
* Flow language</a>.</p>
|
|
846
842
|
* <p>For more information about flows, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html">Flows</a> in the
|
|
847
843
|
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
@@ -890,7 +886,6 @@ export declare class Connect extends ConnectClient {
|
|
|
890
886
|
listInstances(args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void): void;
|
|
891
887
|
/**
|
|
892
888
|
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
|
|
893
|
-
*
|
|
894
889
|
* <p>Returns a paginated list of storage configs for the identified instance and resource
|
|
895
890
|
* type.</p>
|
|
896
891
|
*/
|
|
@@ -926,7 +921,6 @@ export declare class Connect extends ConnectClient {
|
|
|
926
921
|
* <p>For more information about phone numbers, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html">Set Up Phone Numbers for Your
|
|
927
922
|
* Contact Center</a> in the <i>Amazon Connect Administrator
|
|
928
923
|
* Guide</i>.</p>
|
|
929
|
-
*
|
|
930
924
|
* <important>
|
|
931
925
|
* <p>The phone number <code>Arn</code> value that is returned from each of the items in the
|
|
932
926
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList">PhoneNumberSummaryList</a> cannot be used to tag phone number resources. It will fail with
|
|
@@ -1109,7 +1103,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1109
1103
|
/**
|
|
1110
1104
|
* <p>When a contact is being recorded, and the recording has been suspended using
|
|
1111
1105
|
* SuspendContactRecording, this API resumes recording the call.</p>
|
|
1112
|
-
*
|
|
1113
1106
|
* <p>Only voice recordings are supported at this time.</p>
|
|
1114
1107
|
*/
|
|
1115
1108
|
resumeContactRecording(args: ResumeContactRecordingCommandInput, options?: __HttpHandlerOptions): Promise<ResumeContactRecordingCommandOutput>;
|
|
@@ -1147,7 +1140,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1147
1140
|
searchSecurityProfiles(args: SearchSecurityProfilesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSecurityProfilesCommandOutput) => void): void;
|
|
1148
1141
|
/**
|
|
1149
1142
|
* <p>Searches users in an Amazon Connect instance, with optional filtering.</p>
|
|
1150
|
-
*
|
|
1151
1143
|
* <note>
|
|
1152
1144
|
* <p>
|
|
1153
1145
|
* <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p>
|
|
@@ -1166,10 +1158,8 @@ export declare class Connect extends ConnectClient {
|
|
|
1166
1158
|
/**
|
|
1167
1159
|
* <p>Initiates a flow to start a new chat for the customer. Response of this API provides a token
|
|
1168
1160
|
* required to obtain credentials from the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p>
|
|
1169
|
-
*
|
|
1170
1161
|
* <p>When a new chat contact is successfully created, clients must subscribe to the participant’s
|
|
1171
1162
|
* connection for the created chat within 5 minutes. This is achieved by invoking <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p>
|
|
1172
|
-
*
|
|
1173
1163
|
* <p>A 429 error occurs in the following situations:</p>
|
|
1174
1164
|
* <ul>
|
|
1175
1165
|
* <li>
|
|
@@ -1185,7 +1175,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1185
1175
|
* <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your
|
|
1186
1176
|
* account may not support the ability to configure custom chat durations. For more information,
|
|
1187
1177
|
* contact Amazon Web Services Support. </p>
|
|
1188
|
-
*
|
|
1189
1178
|
* <p>For more information about chat, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat.html">Chat</a> in the <i>Amazon Connect
|
|
1190
1179
|
* Administrator Guide</i>.</p>
|
|
1191
1180
|
*/
|
|
@@ -1204,7 +1193,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1204
1193
|
* at the time of the API call.</p>
|
|
1205
1194
|
* </li>
|
|
1206
1195
|
* </ul>
|
|
1207
|
-
*
|
|
1208
1196
|
* <p>StartContactRecording is a one-time action. For example, if you use StopContactRecording to
|
|
1209
1197
|
* stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios
|
|
1210
1198
|
* where the recording has started and you want to suspend and resume it, such as when collecting
|
|
@@ -1228,11 +1216,9 @@ export declare class Connect extends ConnectClient {
|
|
|
1228
1216
|
/**
|
|
1229
1217
|
* <p>Places an outbound call to a contact, and then initiates the flow. It performs the actions
|
|
1230
1218
|
* in the flow that's specified (in <code>ContactFlowId</code>).</p>
|
|
1231
|
-
*
|
|
1232
1219
|
* <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If
|
|
1233
1220
|
* the flow places an outbound call to a contact, and then puts the contact in queue, the call is
|
|
1234
1221
|
* then routed to the agent, like any other inbound case.</p>
|
|
1235
|
-
*
|
|
1236
1222
|
* <p>There is a 60-second dialing timeout for this operation. If the call is not connected after
|
|
1237
1223
|
* 60 seconds, it fails.</p>
|
|
1238
1224
|
* <note>
|
|
@@ -1259,7 +1245,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1259
1245
|
/**
|
|
1260
1246
|
* <p>Ends the specified contact. This call does not work for the following initiation
|
|
1261
1247
|
* methods:</p>
|
|
1262
|
-
*
|
|
1263
1248
|
* <ul>
|
|
1264
1249
|
* <li>
|
|
1265
1250
|
* <p>DISCONNECT</p>
|
|
@@ -1281,7 +1266,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1281
1266
|
* StartContactRecording to restart it. For scenarios where the recording has started and you want
|
|
1282
1267
|
* to suspend it for sensitive information (for example, to collect a credit card number), and then
|
|
1283
1268
|
* restart it, use SuspendContactRecording and ResumeContactRecording.</p>
|
|
1284
|
-
*
|
|
1285
1269
|
* <p>Only voice recordings are supported at this time.</p>
|
|
1286
1270
|
*/
|
|
1287
1271
|
stopContactRecording(args: StopContactRecordingCommandInput, options?: __HttpHandlerOptions): Promise<StopContactRecordingCommandOutput>;
|
|
@@ -1393,7 +1377,7 @@ export declare class Connect extends ConnectClient {
|
|
|
1393
1377
|
updateContactAttributes(args: UpdateContactAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactAttributesCommandOutput) => void): void;
|
|
1394
1378
|
/**
|
|
1395
1379
|
* <p>Updates the specified flow.</p>
|
|
1396
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
1380
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
1397
1381
|
* Flow language</a>.</p>
|
|
1398
1382
|
*/
|
|
1399
1383
|
updateContactFlowContent(args: UpdateContactFlowContentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactFlowContentCommandOutput>;
|
|
@@ -1419,7 +1403,7 @@ export declare class Connect extends ConnectClient {
|
|
|
1419
1403
|
updateContactFlowModuleMetadata(args: UpdateContactFlowModuleMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContactFlowModuleMetadataCommandOutput) => void): void;
|
|
1420
1404
|
/**
|
|
1421
1405
|
* <p>The name of the flow.</p>
|
|
1422
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
1406
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
1423
1407
|
* Flow language</a>.</p>
|
|
1424
1408
|
*/
|
|
1425
1409
|
updateContactFlowName(args: UpdateContactFlowNameCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContactFlowNameCommandOutput>;
|
|
@@ -1552,6 +1536,8 @@ export declare class Connect extends ConnectClient {
|
|
|
1552
1536
|
updateRoutingProfileQueues(args: UpdateRoutingProfileQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRoutingProfileQueuesCommandOutput) => void): void;
|
|
1553
1537
|
/**
|
|
1554
1538
|
* <p>Updates a rule for the specified Amazon Connect instance.</p>
|
|
1539
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
1540
|
+
* </p>
|
|
1555
1541
|
*/
|
|
1556
1542
|
updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRuleCommandOutput>;
|
|
1557
1543
|
updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void;
|
|
@@ -1573,7 +1559,6 @@ export declare class Connect extends ConnectClient {
|
|
|
1573
1559
|
updateTaskTemplate(args: UpdateTaskTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTaskTemplateCommandOutput) => void): void;
|
|
1574
1560
|
/**
|
|
1575
1561
|
* <p>Updates the traffic distribution for a given traffic distribution group. </p>
|
|
1576
|
-
*
|
|
1577
1562
|
* <p>For more information about updating a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html">Update telephony
|
|
1578
1563
|
* traffic distribution across Amazon Web Services Regions
|
|
1579
1564
|
* </a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
@@ -302,10 +302,6 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
|
|
|
302
302
|
* Guide</i>.</p>
|
|
303
303
|
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
|
|
304
304
|
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
|
|
305
|
-
* <note>
|
|
306
|
-
* <p>Working with flows? Check out the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html">Amazon Connect Flow
|
|
307
|
-
* language</a>.</p>
|
|
308
|
-
* </note>
|
|
309
305
|
*/
|
|
310
306
|
export declare class ConnectClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectClientResolvedConfig> {
|
|
311
307
|
/**
|
|
@@ -9,7 +9,7 @@ export interface CreateContactFlowCommandOutput extends CreateContactFlowRespons
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a flow for the specified Amazon Connect instance.</p>
|
|
12
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
12
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
13
13
|
* Flow language</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,6 +9,8 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a rule for the specified Amazon Connect instance.</p>
|
|
12
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
13
|
+
* </p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -10,7 +10,6 @@ export interface DeleteTrafficDistributionGroupCommandOutput extends DeleteTraff
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is
|
|
12
12
|
* created.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>For more information about deleting traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html">Delete traffic distribution groups</a> in
|
|
15
14
|
* the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
16
15
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface DescribeContactFlowCommandOutput extends DescribeContactFlowRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes the specified flow.</p>
|
|
12
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
12
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
13
13
|
* Flow language</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,6 @@ export interface GetMetricDataCommandOutput extends GetMetricDataResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets historical metric data from the specified Amazon Connect instance.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics
|
|
14
13
|
* Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
15
14
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface ListContactFlowsCommandOutput extends ListContactFlowsResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the flows for the specified Amazon Connect instance.</p>
|
|
12
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
12
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
13
13
|
* Flow language</a>.</p>
|
|
14
14
|
* <p>For more information about flows, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html">Flows</a> in the
|
|
15
15
|
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
@@ -9,7 +9,6 @@ export interface ListInstanceStorageConfigsCommandOutput extends ListInstanceSto
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
|
|
12
|
-
*
|
|
13
12
|
* <p>Returns a paginated list of storage configs for the identified instance and resource
|
|
14
13
|
* type.</p>
|
|
15
14
|
* @example
|
|
@@ -12,7 +12,6 @@ export interface ListPhoneNumbersCommandOutput extends ListPhoneNumbersResponse,
|
|
|
12
12
|
* <p>For more information about phone numbers, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html">Set Up Phone Numbers for Your
|
|
13
13
|
* Contact Center</a> in the <i>Amazon Connect Administrator
|
|
14
14
|
* Guide</i>.</p>
|
|
15
|
-
*
|
|
16
15
|
* <important>
|
|
17
16
|
* <p>The phone number <code>Arn</code> value that is returned from each of the items in the
|
|
18
17
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList">PhoneNumberSummaryList</a> cannot be used to tag phone number resources. It will fail with
|
|
@@ -10,7 +10,6 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>When a contact is being recorded, and the recording has been suspended using
|
|
12
12
|
* SuspendContactRecording, this API resumes recording the call.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>Only voice recordings are supported at this time.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,6 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Searches users in an Amazon Connect instance, with optional filtering.</p>
|
|
12
|
-
*
|
|
13
12
|
* <note>
|
|
14
13
|
* <p>
|
|
15
14
|
* <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p>
|
|
@@ -10,10 +10,8 @@ export interface StartChatContactCommandOutput extends StartChatContactResponse,
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Initiates a flow to start a new chat for the customer. Response of this API provides a token
|
|
12
12
|
* required to obtain credentials from the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>When a new chat contact is successfully created, clients must subscribe to the participant’s
|
|
15
14
|
* connection for the created chat within 5 minutes. This is achieved by invoking <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p>
|
|
16
|
-
*
|
|
17
15
|
* <p>A 429 error occurs in the following situations:</p>
|
|
18
16
|
* <ul>
|
|
19
17
|
* <li>
|
|
@@ -29,7 +27,6 @@ export interface StartChatContactCommandOutput extends StartChatContactResponse,
|
|
|
29
27
|
* <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your
|
|
30
28
|
* account may not support the ability to configure custom chat durations. For more information,
|
|
31
29
|
* contact Amazon Web Services Support. </p>
|
|
32
|
-
*
|
|
33
30
|
* <p>For more information about chat, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat.html">Chat</a> in the <i>Amazon Connect
|
|
34
31
|
* Administrator Guide</i>.</p>
|
|
35
32
|
* @example
|
|
@@ -19,7 +19,6 @@ export interface StartContactRecordingCommandOutput extends StartContactRecordin
|
|
|
19
19
|
* at the time of the API call.</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* </ul>
|
|
22
|
-
*
|
|
23
22
|
* <p>StartContactRecording is a one-time action. For example, if you use StopContactRecording to
|
|
24
23
|
* stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios
|
|
25
24
|
* where the recording has started and you want to suspend and resume it, such as when collecting
|
|
@@ -10,11 +10,9 @@ export interface StartOutboundVoiceContactCommandOutput extends StartOutboundVoi
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Places an outbound call to a contact, and then initiates the flow. It performs the actions
|
|
12
12
|
* in the flow that's specified (in <code>ContactFlowId</code>).</p>
|
|
13
|
-
*
|
|
14
13
|
* <p>Agents do not initiate the outbound API, which means that they do not dial the contact. If
|
|
15
14
|
* the flow places an outbound call to a contact, and then puts the contact in queue, the call is
|
|
16
15
|
* then routed to the agent, like any other inbound case.</p>
|
|
17
|
-
*
|
|
18
16
|
* <p>There is a 60-second dialing timeout for this operation. If the call is not connected after
|
|
19
17
|
* 60 seconds, it fails.</p>
|
|
20
18
|
* <note>
|
|
@@ -13,7 +13,6 @@ export interface StopContactRecordingCommandOutput extends StopContactRecordingR
|
|
|
13
13
|
* StartContactRecording to restart it. For scenarios where the recording has started and you want
|
|
14
14
|
* to suspend it for sensitive information (for example, to collect a credit card number), and then
|
|
15
15
|
* restart it, use SuspendContactRecording and ResumeContactRecording.</p>
|
|
16
|
-
*
|
|
17
16
|
* <p>Only voice recordings are supported at this time.</p>
|
|
18
17
|
* @example
|
|
19
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface UpdateContactFlowContentCommandOutput extends __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the specified flow.</p>
|
|
12
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
12
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
13
13
|
* Flow language</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface UpdateContactFlowNameCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>The name of the flow.</p>
|
|
12
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
12
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
13
13
|
* Flow language</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,6 +9,8 @@ export interface UpdateRuleCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates a rule for the specified Amazon Connect instance.</p>
|
|
12
|
+
* <p>Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule.
|
|
13
|
+
* </p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -9,7 +9,6 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Updates the traffic distribution for a given traffic distribution group. </p>
|
|
12
|
-
*
|
|
13
12
|
* <p>For more information about updating a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html">Update telephony
|
|
14
13
|
* traffic distribution across Amazon Web Services Regions
|
|
15
14
|
* </a> in the <i>Amazon Connect Administrator Guide</i>. </p>
|
|
@@ -361,8 +361,10 @@ export declare enum VocabularyLanguageCode {
|
|
|
361
361
|
EN_GB = "en-GB",
|
|
362
362
|
EN_IE = "en-IE",
|
|
363
363
|
EN_IN = "en-IN",
|
|
364
|
+
EN_NZ = "en-NZ",
|
|
364
365
|
EN_US = "en-US",
|
|
365
366
|
EN_WL = "en-WL",
|
|
367
|
+
EN_ZA = "en-ZA",
|
|
366
368
|
ES_ES = "es-ES",
|
|
367
369
|
ES_US = "es-US",
|
|
368
370
|
FR_CA = "fr-CA",
|
|
@@ -669,7 +671,6 @@ export interface ClaimPhoneNumberRequest {
|
|
|
669
671
|
* request. If not provided, the Amazon Web Services
|
|
670
672
|
* SDK populates this field. For more information about idempotency, see
|
|
671
673
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
672
|
-
*
|
|
673
674
|
* <p>Pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>
|
|
674
675
|
* </p>
|
|
675
676
|
*/
|
|
@@ -1499,7 +1500,9 @@ export interface CreateSecurityProfileRequest {
|
|
|
1499
1500
|
*/
|
|
1500
1501
|
AllowedAccessControlTags?: Record<string, string>;
|
|
1501
1502
|
/**
|
|
1502
|
-
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect
|
|
1503
|
+
* <p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> | <code>SecurityProfile</code> | <code>Queue</code> |
|
|
1504
|
+
* <code>RoutingProfile</code>
|
|
1505
|
+
* </p>
|
|
1503
1506
|
*/
|
|
1504
1507
|
TagRestrictedResources?: string[];
|
|
1505
1508
|
}
|
|
@@ -1851,7 +1854,6 @@ export interface UserPhoneConfig {
|
|
|
1851
1854
|
AutoAccept?: boolean;
|
|
1852
1855
|
/**
|
|
1853
1856
|
* <p>The After Call Work (ACW) timeout setting, in seconds.</p>
|
|
1854
|
-
*
|
|
1855
1857
|
* <note>
|
|
1856
1858
|
* <p>When returned by a <code>SearchUsers</code> call, <code>AfterContactWorkTimeLimit</code> is
|
|
1857
1859
|
* returned in milliseconds. </p>
|
|
@@ -3867,7 +3869,6 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3867
3869
|
* <p>Unit: COUNT</p>
|
|
3868
3870
|
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time">ACW</a>
|
|
3869
3871
|
* </p>
|
|
3870
|
-
*
|
|
3871
3872
|
* </dd>
|
|
3872
3873
|
* <dt>AGENTS_AVAILABLE</dt>
|
|
3873
3874
|
* <dd>
|
|
@@ -3936,7 +3937,6 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3936
3937
|
* <code>{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
|
|
3937
3938
|
* </code>}</p>
|
|
3938
3939
|
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
|
|
3939
|
-
*
|
|
3940
3940
|
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
3941
3941
|
* </p>
|
|
3942
3942
|
* </dd>
|
|
@@ -4345,7 +4345,6 @@ export interface GetMetricDataRequest {
|
|
|
4345
4345
|
* <p>The grouping applied to the metrics returned. For example, when results are grouped by
|
|
4346
4346
|
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
|
|
4347
4347
|
* each queue rather than aggregated for all queues.</p>
|
|
4348
|
-
*
|
|
4349
4348
|
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
|
|
4350
4349
|
*/
|
|
4351
4350
|
Groupings?: (Grouping | string)[];
|
|
@@ -4357,7 +4356,6 @@ export interface GetMetricDataRequest {
|
|
|
4357
4356
|
* <p>This API does not support a contacts
|
|
4358
4357
|
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
4359
4358
|
* </note>
|
|
4360
|
-
*
|
|
4361
4359
|
* <dl>
|
|
4362
4360
|
* <dt>ABANDON_TIME</dt>
|
|
4363
4361
|
* <dd>
|
|
@@ -4827,7 +4825,7 @@ export interface ListContactFlowsRequest {
|
|
|
4827
4825
|
}
|
|
4828
4826
|
/**
|
|
4829
4827
|
* <p>Contains summary information about a flow.</p>
|
|
4830
|
-
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/
|
|
4828
|
+
* <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
|
|
4831
4829
|
* Flow language</a>.</p>
|
|
4832
4830
|
*/
|
|
4833
4831
|
export interface ContactFlowSummary {
|
|
@@ -1544,7 +1544,6 @@ export declare enum StringComparisonType {
|
|
|
1544
1544
|
* <note>
|
|
1545
1545
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
1546
1546
|
* </p>
|
|
1547
|
-
*
|
|
1548
1547
|
* </note>
|
|
1549
1548
|
*/
|
|
1550
1549
|
export interface StringCondition {
|
|
@@ -2482,9 +2481,8 @@ export interface UpdateContactFlowContentRequest {
|
|
|
2482
2481
|
*/
|
|
2483
2482
|
ContactFlowId: string | undefined;
|
|
2484
2483
|
/**
|
|
2485
|
-
* <p>The JSON string that represents flow's content. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/
|
|
2486
|
-
* flow in Amazon Connect Flow language</a
|
|
2487
|
-
* Administrator Guide</i>. </p>
|
|
2484
|
+
* <p>The JSON string that represents flow's content. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example contact
|
|
2485
|
+
* flow in Amazon Connect Flow language</a>. </p>
|
|
2488
2486
|
*/
|
|
2489
2487
|
Content: string | undefined;
|
|
2490
2488
|
}
|
|
@@ -3155,7 +3153,6 @@ export interface QueueSearchCriteria {
|
|
|
3155
3153
|
* <note>
|
|
3156
3154
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
3157
3155
|
* </p>
|
|
3158
|
-
*
|
|
3159
3156
|
* </note>
|
|
3160
3157
|
*/
|
|
3161
3158
|
StringCondition?: StringCondition;
|
|
@@ -3170,7 +3167,6 @@ export interface QueueSearchCriteria {
|
|
|
3170
3167
|
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
3171
3168
|
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
3172
3169
|
* outside of this range will throw invalid results. </p>
|
|
3173
|
-
*
|
|
3174
3170
|
* </note>
|
|
3175
3171
|
*/
|
|
3176
3172
|
export interface RoutingProfileSearchCriteria {
|
|
@@ -3187,7 +3183,6 @@ export interface RoutingProfileSearchCriteria {
|
|
|
3187
3183
|
* <note>
|
|
3188
3184
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
3189
3185
|
* </p>
|
|
3190
|
-
*
|
|
3191
3186
|
* </note>
|
|
3192
3187
|
*/
|
|
3193
3188
|
StringCondition?: StringCondition;
|
|
@@ -3214,7 +3209,6 @@ export interface SecurityProfileSearchCriteria {
|
|
|
3214
3209
|
* <note>
|
|
3215
3210
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
3216
3211
|
* </p>
|
|
3217
|
-
*
|
|
3218
3212
|
* </note>
|
|
3219
3213
|
*/
|
|
3220
3214
|
StringCondition?: StringCondition;
|
|
@@ -3327,7 +3321,6 @@ export interface SearchSecurityProfilesRequest {
|
|
|
3327
3321
|
* <note>
|
|
3328
3322
|
* <p>The currently supported value for <code>FieldName</code>: <code>name</code>
|
|
3329
3323
|
* </p>
|
|
3330
|
-
*
|
|
3331
3324
|
* </note>
|
|
3332
3325
|
*/
|
|
3333
3326
|
SearchCriteria?: SecurityProfileSearchCriteria;
|
|
@@ -180,8 +180,10 @@ export declare enum VocabularyLanguageCode {
|
|
|
180
180
|
EN_GB = "en-GB",
|
|
181
181
|
EN_IE = "en-IE",
|
|
182
182
|
EN_IN = "en-IN",
|
|
183
|
+
EN_NZ = "en-NZ",
|
|
183
184
|
EN_US = "en-US",
|
|
184
185
|
EN_WL = "en-WL",
|
|
186
|
+
EN_ZA = "en-ZA",
|
|
185
187
|
ES_ES = "es-ES",
|
|
186
188
|
ES_US = "es-US",
|
|
187
189
|
FR_CA = "fr-CA",
|
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.
|
|
4
|
+
"version": "3.232.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",
|