@aws-sdk/client-connect 3.316.0 → 3.319.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 +8 -0
- package/dist-cjs/Connect.js +2 -0
- package/dist-cjs/commands/CreateParticipantCommand.js +45 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +8 -6
- package/dist-cjs/models/models_1.js +5 -1
- package/dist-cjs/protocols/Aws_restJson1.js +81 -7
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/CreateParticipantCommand.js +41 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +6 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +72 -0
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/CreateParticipantCommand.d.ts +88 -0
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +2 -1
- package/dist-types/commands/ListApprovedOriginsCommand.d.ts +1 -1
- package/dist-types/commands/ListBotsCommand.d.ts +1 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +97 -86
- package/dist-types/models/models_1.d.ts +91 -14
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateParticipantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAgentStatusesCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListApprovedOriginsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +26 -24
- package/dist-types/ts3.4/models/models_1.d.ts +25 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
5
|
+
import { CreateParticipantRequest, CreateParticipantResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link CreateParticipantCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateParticipantCommandInput extends CreateParticipantRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link CreateParticipantCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateParticipantCommandOutput extends CreateParticipantResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <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
|
|
23
|
+
* flow experiences by integrating custom participants</a>.</p>
|
|
24
|
+
* @example
|
|
25
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
26
|
+
* ```javascript
|
|
27
|
+
* import { ConnectClient, CreateParticipantCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
28
|
+
* // const { ConnectClient, CreateParticipantCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
29
|
+
* const client = new ConnectClient(config);
|
|
30
|
+
* const input = { // CreateParticipantRequest
|
|
31
|
+
* InstanceId: "STRING_VALUE", // required
|
|
32
|
+
* ContactId: "STRING_VALUE", // required
|
|
33
|
+
* ClientToken: "STRING_VALUE",
|
|
34
|
+
* ParticipantDetails: { // ParticipantDetailsToAdd
|
|
35
|
+
* ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT",
|
|
36
|
+
* DisplayName: "STRING_VALUE",
|
|
37
|
+
* },
|
|
38
|
+
* };
|
|
39
|
+
* const command = new CreateParticipantCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @param CreateParticipantCommandInput - {@link CreateParticipantCommandInput}
|
|
44
|
+
* @returns {@link CreateParticipantCommandOutput}
|
|
45
|
+
* @see {@link CreateParticipantCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link CreateParticipantCommandOutput} for command's `response` shape.
|
|
47
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
50
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
53
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
56
|
+
* <p>The request is not valid.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
|
+
* <p>The specified resource was not found.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
62
|
+
* <p>The service quota has been exceeded.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
65
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
66
|
+
*
|
|
67
|
+
*
|
|
68
|
+
*/
|
|
69
|
+
export declare class CreateParticipantCommand extends $Command<CreateParticipantCommandInput, CreateParticipantCommandOutput, ConnectClientResolvedConfig> {
|
|
70
|
+
readonly input: CreateParticipantCommandInput;
|
|
71
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
constructor(input: CreateParticipantCommandInput);
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateParticipantCommandInput, CreateParticipantCommandOutput>;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
83
|
+
private serialize;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
87
|
+
private deserialize;
|
|
88
|
+
}
|
|
@@ -2,7 +2,8 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
5
|
-
import { ListAgentStatusRequest
|
|
5
|
+
import { ListAgentStatusRequest } from "../models/models_0";
|
|
6
|
+
import { ListAgentStatusResponse } from "../models/models_1";
|
|
6
7
|
/**
|
|
7
8
|
* @public
|
|
8
9
|
*
|
|
@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
5
|
-
import { ListApprovedOriginsRequest, ListApprovedOriginsResponse } from "../models/
|
|
5
|
+
import { ListApprovedOriginsRequest, ListApprovedOriginsResponse } from "../models/models_1";
|
|
6
6
|
/**
|
|
7
7
|
* @public
|
|
8
8
|
*
|
|
@@ -2,8 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
|
2
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
5
|
-
import { ListBotsRequest } from "../models/
|
|
6
|
-
import { ListBotsResponse } from "../models/models_1";
|
|
5
|
+
import { ListBotsRequest, ListBotsResponse } from "../models/models_1";
|
|
7
6
|
/**
|
|
8
7
|
* @public
|
|
9
8
|
*
|
|
@@ -15,6 +15,7 @@ export * from "./CreateContactFlowModuleCommand";
|
|
|
15
15
|
export * from "./CreateHoursOfOperationCommand";
|
|
16
16
|
export * from "./CreateInstanceCommand";
|
|
17
17
|
export * from "./CreateIntegrationAssociationCommand";
|
|
18
|
+
export * from "./CreateParticipantCommand";
|
|
18
19
|
export * from "./CreateQueueCommand";
|
|
19
20
|
export * from "./CreateQuickConnectCommand";
|
|
20
21
|
export * from "./CreateRoutingProfileCommand";
|
|
@@ -1295,6 +1295,94 @@ export interface CreateIntegrationAssociationResponse {
|
|
|
1295
1295
|
*/
|
|
1296
1296
|
IntegrationAssociationArn?: string;
|
|
1297
1297
|
}
|
|
1298
|
+
/**
|
|
1299
|
+
* @public
|
|
1300
|
+
* @enum
|
|
1301
|
+
*/
|
|
1302
|
+
export declare const ParticipantRole: {
|
|
1303
|
+
readonly AGENT: "AGENT";
|
|
1304
|
+
readonly CUSTOMER: "CUSTOMER";
|
|
1305
|
+
readonly CUSTOM_BOT: "CUSTOM_BOT";
|
|
1306
|
+
readonly SYSTEM: "SYSTEM";
|
|
1307
|
+
};
|
|
1308
|
+
/**
|
|
1309
|
+
* @public
|
|
1310
|
+
*/
|
|
1311
|
+
export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantRole];
|
|
1312
|
+
/**
|
|
1313
|
+
* @public
|
|
1314
|
+
* <p>The details to add for the participant.</p>
|
|
1315
|
+
*/
|
|
1316
|
+
export interface ParticipantDetailsToAdd {
|
|
1317
|
+
/**
|
|
1318
|
+
* <p>The role of the participant being added.</p>
|
|
1319
|
+
*/
|
|
1320
|
+
ParticipantRole?: ParticipantRole | string;
|
|
1321
|
+
/**
|
|
1322
|
+
* <p>The display name of the participant.</p>
|
|
1323
|
+
*/
|
|
1324
|
+
DisplayName?: string;
|
|
1325
|
+
}
|
|
1326
|
+
/**
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
export interface CreateParticipantRequest {
|
|
1330
|
+
/**
|
|
1331
|
+
* <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>
|
|
1332
|
+
*/
|
|
1333
|
+
InstanceId: string | undefined;
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.</p>
|
|
1336
|
+
*/
|
|
1337
|
+
ContactId: string | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1340
|
+
* request. If not provided, the Amazon Web Services
|
|
1341
|
+
* SDK populates this field. For more information about idempotency, see
|
|
1342
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1343
|
+
*/
|
|
1344
|
+
ClientToken?: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* <p>Information identifying the participant.</p>
|
|
1347
|
+
* <important>
|
|
1348
|
+
* <p>The only Valid value for <code>ParticipantRole</code> is <code>CUSTOM_BOT</code>. </p>
|
|
1349
|
+
* <p>
|
|
1350
|
+
* <code>DisplayName</code> is <b>Required</b>.</p>
|
|
1351
|
+
* </important>
|
|
1352
|
+
*/
|
|
1353
|
+
ParticipantDetails: ParticipantDetailsToAdd | undefined;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* @public
|
|
1357
|
+
* <p>The credentials used by the participant.</p>
|
|
1358
|
+
*/
|
|
1359
|
+
export interface ParticipantTokenCredentials {
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat
|
|
1362
|
+
* participant. </p>
|
|
1363
|
+
*/
|
|
1364
|
+
ParticipantToken?: string;
|
|
1365
|
+
/**
|
|
1366
|
+
* <p>The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ.
|
|
1367
|
+
* For example, 2019-11-08T02:41:28.172Z.</p>
|
|
1368
|
+
*/
|
|
1369
|
+
Expiry?: string;
|
|
1370
|
+
}
|
|
1371
|
+
/**
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1374
|
+
export interface CreateParticipantResponse {
|
|
1375
|
+
/**
|
|
1376
|
+
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
|
|
1377
|
+
* token is valid for the lifetime of a chat participant.</p>
|
|
1378
|
+
*/
|
|
1379
|
+
ParticipantCredentials?: ParticipantTokenCredentials;
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>The identifier for a chat participant. The participantId for a chat participant is the same
|
|
1382
|
+
* throughout the chat lifecycle.</p>
|
|
1383
|
+
*/
|
|
1384
|
+
ParticipantId?: string;
|
|
1385
|
+
}
|
|
1298
1386
|
/**
|
|
1299
1387
|
* @public
|
|
1300
1388
|
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
@@ -1491,12 +1579,13 @@ export declare const BehaviorType: {
|
|
|
1491
1579
|
export type BehaviorType = (typeof BehaviorType)[keyof typeof BehaviorType];
|
|
1492
1580
|
/**
|
|
1493
1581
|
* @public
|
|
1494
|
-
* <p>Defines the cross-channel routing behavior that allows an agent working on a contact in
|
|
1495
|
-
*
|
|
1582
|
+
* <p>Defines the cross-channel routing behavior that allows an agent working on a contact in one
|
|
1583
|
+
* channel to be offered a contact from a different channel.</p>
|
|
1496
1584
|
*/
|
|
1497
1585
|
export interface CrossChannelBehavior {
|
|
1498
1586
|
/**
|
|
1499
|
-
* <p>Specifies the other channels that can be routed to an agent handling their current
|
|
1587
|
+
* <p>Specifies the other channels that can be routed to an agent handling their current
|
|
1588
|
+
* channel.</p>
|
|
1500
1589
|
*/
|
|
1501
1590
|
BehaviorType: BehaviorType | string | undefined;
|
|
1502
1591
|
}
|
|
@@ -5586,9 +5675,9 @@ export interface FilterV2 {
|
|
|
5586
5675
|
export interface MetricFilterV2 {
|
|
5587
5676
|
/**
|
|
5588
5677
|
* <p>The key to use for filtering data. </p>
|
|
5589
|
-
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>,
|
|
5590
|
-
* <code>
|
|
5591
|
-
*
|
|
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>
|
|
5592
5681
|
*/
|
|
5593
5682
|
MetricFilterKey?: string;
|
|
5594
5683
|
/**
|
|
@@ -5656,8 +5745,8 @@ export interface GetMetricDataV2Request {
|
|
|
5656
5745
|
StartTime: Date | undefined;
|
|
5657
5746
|
/**
|
|
5658
5747
|
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
5659
|
-
* retrieval of historical metrics data. The time must be later than the start time
|
|
5660
|
-
*
|
|
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>
|
|
5661
5750
|
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
5662
5751
|
*/
|
|
5663
5752
|
EndTime: Date | undefined;
|
|
@@ -6089,84 +6178,6 @@ export interface ListAgentStatusRequest {
|
|
|
6089
6178
|
*/
|
|
6090
6179
|
AgentStatusTypes?: (AgentStatusType | string)[];
|
|
6091
6180
|
}
|
|
6092
|
-
/**
|
|
6093
|
-
* @public
|
|
6094
|
-
*/
|
|
6095
|
-
export interface ListAgentStatusResponse {
|
|
6096
|
-
/**
|
|
6097
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6098
|
-
*/
|
|
6099
|
-
NextToken?: string;
|
|
6100
|
-
/**
|
|
6101
|
-
* <p>A summary of agent statuses.</p>
|
|
6102
|
-
*/
|
|
6103
|
-
AgentStatusSummaryList?: AgentStatusSummary[];
|
|
6104
|
-
}
|
|
6105
|
-
/**
|
|
6106
|
-
* @public
|
|
6107
|
-
*/
|
|
6108
|
-
export interface ListApprovedOriginsRequest {
|
|
6109
|
-
/**
|
|
6110
|
-
* <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>
|
|
6111
|
-
*/
|
|
6112
|
-
InstanceId: string | undefined;
|
|
6113
|
-
/**
|
|
6114
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
6115
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
6116
|
-
*/
|
|
6117
|
-
NextToken?: string;
|
|
6118
|
-
/**
|
|
6119
|
-
* <p>The maximum number of results to return per page.</p>
|
|
6120
|
-
*/
|
|
6121
|
-
MaxResults?: number;
|
|
6122
|
-
}
|
|
6123
|
-
/**
|
|
6124
|
-
* @public
|
|
6125
|
-
*/
|
|
6126
|
-
export interface ListApprovedOriginsResponse {
|
|
6127
|
-
/**
|
|
6128
|
-
* <p>The approved origins.</p>
|
|
6129
|
-
*/
|
|
6130
|
-
Origins?: string[];
|
|
6131
|
-
/**
|
|
6132
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6133
|
-
*/
|
|
6134
|
-
NextToken?: string;
|
|
6135
|
-
}
|
|
6136
|
-
/**
|
|
6137
|
-
* @public
|
|
6138
|
-
* @enum
|
|
6139
|
-
*/
|
|
6140
|
-
export declare const LexVersion: {
|
|
6141
|
-
readonly V1: "V1";
|
|
6142
|
-
readonly V2: "V2";
|
|
6143
|
-
};
|
|
6144
|
-
/**
|
|
6145
|
-
* @public
|
|
6146
|
-
*/
|
|
6147
|
-
export type LexVersion = (typeof LexVersion)[keyof typeof LexVersion];
|
|
6148
|
-
/**
|
|
6149
|
-
* @public
|
|
6150
|
-
*/
|
|
6151
|
-
export interface ListBotsRequest {
|
|
6152
|
-
/**
|
|
6153
|
-
* <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>
|
|
6154
|
-
*/
|
|
6155
|
-
InstanceId: string | undefined;
|
|
6156
|
-
/**
|
|
6157
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
6158
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
6159
|
-
*/
|
|
6160
|
-
NextToken?: string;
|
|
6161
|
-
/**
|
|
6162
|
-
* <p>The maximum number of results to return per page.</p>
|
|
6163
|
-
*/
|
|
6164
|
-
MaxResults?: number;
|
|
6165
|
-
/**
|
|
6166
|
-
* <p>The version of Amazon Lex or Amazon Lex V2.</p>
|
|
6167
|
-
*/
|
|
6168
|
-
LexVersion: LexVersion | string | undefined;
|
|
6169
|
-
}
|
|
6170
6181
|
/**
|
|
6171
6182
|
* @internal
|
|
6172
6183
|
*/
|
|
@@ -1,6 +1,84 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentStatusState, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, DirectoryType, EventSourceName, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TelephonyConfig, TrafficDistributionGroupStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
3
|
+
import { ActionSummary, AgentStatusState, AgentStatusSummary, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, DirectoryType, EventSourceName, HierarchyGroupSummary, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Queue, QueueStatus, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TelephonyConfig, TrafficDistributionGroupStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface ListAgentStatusResponse {
|
|
8
|
+
/**
|
|
9
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
10
|
+
*/
|
|
11
|
+
NextToken?: string;
|
|
12
|
+
/**
|
|
13
|
+
* <p>A summary of agent statuses.</p>
|
|
14
|
+
*/
|
|
15
|
+
AgentStatusSummaryList?: AgentStatusSummary[];
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface ListApprovedOriginsRequest {
|
|
21
|
+
/**
|
|
22
|
+
* <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>
|
|
23
|
+
*/
|
|
24
|
+
InstanceId: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
27
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
28
|
+
*/
|
|
29
|
+
NextToken?: string;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The maximum number of results to return per page.</p>
|
|
32
|
+
*/
|
|
33
|
+
MaxResults?: number;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export interface ListApprovedOriginsResponse {
|
|
39
|
+
/**
|
|
40
|
+
* <p>The approved origins.</p>
|
|
41
|
+
*/
|
|
42
|
+
Origins?: string[];
|
|
43
|
+
/**
|
|
44
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
45
|
+
*/
|
|
46
|
+
NextToken?: string;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* @public
|
|
50
|
+
* @enum
|
|
51
|
+
*/
|
|
52
|
+
export declare const LexVersion: {
|
|
53
|
+
readonly V1: "V1";
|
|
54
|
+
readonly V2: "V2";
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export type LexVersion = (typeof LexVersion)[keyof typeof LexVersion];
|
|
60
|
+
/**
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export interface ListBotsRequest {
|
|
64
|
+
/**
|
|
65
|
+
* <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>
|
|
66
|
+
*/
|
|
67
|
+
InstanceId: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
70
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
71
|
+
*/
|
|
72
|
+
NextToken?: string;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The maximum number of results to return per page.</p>
|
|
75
|
+
*/
|
|
76
|
+
MaxResults?: number;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The version of Amazon Lex or Amazon Lex V2.</p>
|
|
79
|
+
*/
|
|
80
|
+
LexVersion: LexVersion | string | undefined;
|
|
81
|
+
}
|
|
4
82
|
/**
|
|
5
83
|
* @public
|
|
6
84
|
* <p>Configuration information of an Amazon Lex or Amazon Lex V2 bot.</p>
|
|
@@ -2453,8 +2531,8 @@ export interface SearchVocabulariesResponse {
|
|
|
2453
2531
|
export interface ChatMessage {
|
|
2454
2532
|
/**
|
|
2455
2533
|
* <p>The type of the content. Supported types are <code>text/plain</code>,
|
|
2456
|
-
*
|
|
2457
|
-
*
|
|
2534
|
+
* <code>text/markdown</code>, <code>application/json</code>, and
|
|
2535
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
|
|
2458
2536
|
*/
|
|
2459
2537
|
ContentType: string | undefined;
|
|
2460
2538
|
/**
|
|
@@ -2469,8 +2547,8 @@ export interface ChatMessage {
|
|
|
2469
2547
|
* 12000. </p>
|
|
2470
2548
|
* </li>
|
|
2471
2549
|
* <li>
|
|
2472
|
-
* <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the
|
|
2473
|
-
* Constraints are Minimum of 1, Maximum of 12288.</p>
|
|
2550
|
+
* <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the
|
|
2551
|
+
* Length Constraints are Minimum of 1, Maximum of 12288.</p>
|
|
2474
2552
|
* </li>
|
|
2475
2553
|
* </ul>
|
|
2476
2554
|
*/
|
|
@@ -2579,15 +2657,14 @@ export interface StartChatContactRequest {
|
|
|
2579
2657
|
*/
|
|
2580
2658
|
ChatDurationInMinutes?: number;
|
|
2581
2659
|
/**
|
|
2582
|
-
* <p>The supported chat message content types.
|
|
2583
|
-
*
|
|
2584
|
-
*
|
|
2585
|
-
*
|
|
2586
|
-
* <p>Content types must always contain
|
|
2587
|
-
*
|
|
2588
|
-
*
|
|
2589
|
-
* text/markdown,
|
|
2590
|
-
* <code>[text/plain, application/json,
|
|
2660
|
+
* <p>The supported chat message content types. Supported types are <code>text/plain</code>,
|
|
2661
|
+
* <code>text/markdown</code>, <code>application/json</code>,
|
|
2662
|
+
* <code>application/vnd.amazonaws.connect.message.interactive</code>, and
|
|
2663
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
|
|
2664
|
+
* <p>Content types must always contain <code>text/plain</code>. You can then put any other
|
|
2665
|
+
* supported type in the list. For example, all the following lists are valid because they contain
|
|
2666
|
+
* <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
|
|
2667
|
+
* <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
|
|
2591
2668
|
* application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
|
|
2592
2669
|
* <note>
|
|
2593
2670
|
* <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
|
|
@@ -17,6 +17,7 @@ import { CreateContactFlowModuleCommandInput, CreateContactFlowModuleCommandOutp
|
|
|
17
17
|
import { CreateHoursOfOperationCommandInput, CreateHoursOfOperationCommandOutput } from "../commands/CreateHoursOfOperationCommand";
|
|
18
18
|
import { CreateInstanceCommandInput, CreateInstanceCommandOutput } from "../commands/CreateInstanceCommand";
|
|
19
19
|
import { CreateIntegrationAssociationCommandInput, CreateIntegrationAssociationCommandOutput } from "../commands/CreateIntegrationAssociationCommand";
|
|
20
|
+
import { CreateParticipantCommandInput, CreateParticipantCommandOutput } from "../commands/CreateParticipantCommand";
|
|
20
21
|
import { CreateQueueCommandInput, CreateQueueCommandOutput } from "../commands/CreateQueueCommand";
|
|
21
22
|
import { CreateQuickConnectCommandInput, CreateQuickConnectCommandOutput } from "../commands/CreateQuickConnectCommand";
|
|
22
23
|
import { CreateRoutingProfileCommandInput, CreateRoutingProfileCommandOutput } from "../commands/CreateRoutingProfileCommand";
|
|
@@ -238,6 +239,10 @@ export declare const se_CreateInstanceCommand: (input: CreateInstanceCommandInpu
|
|
|
238
239
|
* serializeAws_restJson1CreateIntegrationAssociationCommand
|
|
239
240
|
*/
|
|
240
241
|
export declare const se_CreateIntegrationAssociationCommand: (input: CreateIntegrationAssociationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
242
|
+
/**
|
|
243
|
+
* serializeAws_restJson1CreateParticipantCommand
|
|
244
|
+
*/
|
|
245
|
+
export declare const se_CreateParticipantCommand: (input: CreateParticipantCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
241
246
|
/**
|
|
242
247
|
* serializeAws_restJson1CreateQueueCommand
|
|
243
248
|
*/
|
|
@@ -918,6 +923,10 @@ export declare const de_CreateInstanceCommand: (output: __HttpResponse, context:
|
|
|
918
923
|
* deserializeAws_restJson1CreateIntegrationAssociationCommand
|
|
919
924
|
*/
|
|
920
925
|
export declare const de_CreateIntegrationAssociationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateIntegrationAssociationCommandOutput>;
|
|
926
|
+
/**
|
|
927
|
+
* deserializeAws_restJson1CreateParticipantCommand
|
|
928
|
+
*/
|
|
929
|
+
export declare const de_CreateParticipantCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateParticipantCommandOutput>;
|
|
921
930
|
/**
|
|
922
931
|
* deserializeAws_restJson1CreateQueueCommand
|
|
923
932
|
*/
|
|
@@ -67,6 +67,10 @@ import {
|
|
|
67
67
|
CreateIntegrationAssociationCommandInput,
|
|
68
68
|
CreateIntegrationAssociationCommandOutput,
|
|
69
69
|
} from "./commands/CreateIntegrationAssociationCommand";
|
|
70
|
+
import {
|
|
71
|
+
CreateParticipantCommandInput,
|
|
72
|
+
CreateParticipantCommandOutput,
|
|
73
|
+
} from "./commands/CreateParticipantCommand";
|
|
70
74
|
import {
|
|
71
75
|
CreateQueueCommandInput,
|
|
72
76
|
CreateQueueCommandOutput,
|
|
@@ -902,6 +906,19 @@ export interface Connect {
|
|
|
902
906
|
options: __HttpHandlerOptions,
|
|
903
907
|
cb: (err: any, data?: CreateIntegrationAssociationCommandOutput) => void
|
|
904
908
|
): void;
|
|
909
|
+
createParticipant(
|
|
910
|
+
args: CreateParticipantCommandInput,
|
|
911
|
+
options?: __HttpHandlerOptions
|
|
912
|
+
): Promise<CreateParticipantCommandOutput>;
|
|
913
|
+
createParticipant(
|
|
914
|
+
args: CreateParticipantCommandInput,
|
|
915
|
+
cb: (err: any, data?: CreateParticipantCommandOutput) => void
|
|
916
|
+
): void;
|
|
917
|
+
createParticipant(
|
|
918
|
+
args: CreateParticipantCommandInput,
|
|
919
|
+
options: __HttpHandlerOptions,
|
|
920
|
+
cb: (err: any, data?: CreateParticipantCommandOutput) => void
|
|
921
|
+
): void;
|
|
905
922
|
createQueue(
|
|
906
923
|
args: CreateQueueCommandInput,
|
|
907
924
|
options?: __HttpHandlerOptions
|
|
@@ -112,6 +112,10 @@ import {
|
|
|
112
112
|
CreateIntegrationAssociationCommandInput,
|
|
113
113
|
CreateIntegrationAssociationCommandOutput,
|
|
114
114
|
} from "./commands/CreateIntegrationAssociationCommand";
|
|
115
|
+
import {
|
|
116
|
+
CreateParticipantCommandInput,
|
|
117
|
+
CreateParticipantCommandOutput,
|
|
118
|
+
} from "./commands/CreateParticipantCommand";
|
|
115
119
|
import {
|
|
116
120
|
CreateQueueCommandInput,
|
|
117
121
|
CreateQueueCommandOutput,
|
|
@@ -747,6 +751,7 @@ export type ServiceInputTypes =
|
|
|
747
751
|
| CreateHoursOfOperationCommandInput
|
|
748
752
|
| CreateInstanceCommandInput
|
|
749
753
|
| CreateIntegrationAssociationCommandInput
|
|
754
|
+
| CreateParticipantCommandInput
|
|
750
755
|
| CreateQueueCommandInput
|
|
751
756
|
| CreateQuickConnectCommandInput
|
|
752
757
|
| CreateRoutingProfileCommandInput
|
|
@@ -918,6 +923,7 @@ export type ServiceOutputTypes =
|
|
|
918
923
|
| CreateHoursOfOperationCommandOutput
|
|
919
924
|
| CreateInstanceCommandOutput
|
|
920
925
|
| CreateIntegrationAssociationCommandOutput
|
|
926
|
+
| CreateParticipantCommandOutput
|
|
921
927
|
| CreateQueueCommandOutput
|
|
922
928
|
| CreateQuickConnectCommandOutput
|
|
923
929
|
| CreateRoutingProfileCommandOutput
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@aws-sdk/types";
|
|
9
|
+
import {
|
|
10
|
+
ConnectClientResolvedConfig,
|
|
11
|
+
ServiceInputTypes,
|
|
12
|
+
ServiceOutputTypes,
|
|
13
|
+
} from "../ConnectClient";
|
|
14
|
+
import {
|
|
15
|
+
CreateParticipantRequest,
|
|
16
|
+
CreateParticipantResponse,
|
|
17
|
+
} from "../models/models_0";
|
|
18
|
+
export interface CreateParticipantCommandInput
|
|
19
|
+
extends CreateParticipantRequest {}
|
|
20
|
+
export interface CreateParticipantCommandOutput
|
|
21
|
+
extends CreateParticipantResponse,
|
|
22
|
+
__MetadataBearer {}
|
|
23
|
+
export declare class CreateParticipantCommand extends $Command<
|
|
24
|
+
CreateParticipantCommandInput,
|
|
25
|
+
CreateParticipantCommandOutput,
|
|
26
|
+
ConnectClientResolvedConfig
|
|
27
|
+
> {
|
|
28
|
+
readonly input: CreateParticipantCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: CreateParticipantCommandInput);
|
|
31
|
+
resolveMiddleware(
|
|
32
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
33
|
+
configuration: ConnectClientResolvedConfig,
|
|
34
|
+
options?: __HttpHandlerOptions
|
|
35
|
+
): Handler<CreateParticipantCommandInput, CreateParticipantCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|
|
@@ -11,10 +11,8 @@ import {
|
|
|
11
11
|
ServiceInputTypes,
|
|
12
12
|
ServiceOutputTypes,
|
|
13
13
|
} from "../ConnectClient";
|
|
14
|
-
import {
|
|
15
|
-
|
|
16
|
-
ListAgentStatusResponse,
|
|
17
|
-
} from "../models/models_0";
|
|
14
|
+
import { ListAgentStatusRequest } from "../models/models_0";
|
|
15
|
+
import { ListAgentStatusResponse } from "../models/models_1";
|
|
18
16
|
export interface ListAgentStatusesCommandInput extends ListAgentStatusRequest {}
|
|
19
17
|
export interface ListAgentStatusesCommandOutput
|
|
20
18
|
extends ListAgentStatusResponse,
|
|
@@ -14,7 +14,7 @@ import {
|
|
|
14
14
|
import {
|
|
15
15
|
ListApprovedOriginsRequest,
|
|
16
16
|
ListApprovedOriginsResponse,
|
|
17
|
-
} from "../models/
|
|
17
|
+
} from "../models/models_1";
|
|
18
18
|
export interface ListApprovedOriginsCommandInput
|
|
19
19
|
extends ListApprovedOriginsRequest {}
|
|
20
20
|
export interface ListApprovedOriginsCommandOutput
|
|
@@ -11,8 +11,7 @@ import {
|
|
|
11
11
|
ServiceInputTypes,
|
|
12
12
|
ServiceOutputTypes,
|
|
13
13
|
} from "../ConnectClient";
|
|
14
|
-
import { ListBotsRequest } from "../models/
|
|
15
|
-
import { ListBotsResponse } from "../models/models_1";
|
|
14
|
+
import { ListBotsRequest, ListBotsResponse } from "../models/models_1";
|
|
16
15
|
export interface ListBotsCommandInput extends ListBotsRequest {}
|
|
17
16
|
export interface ListBotsCommandOutput
|
|
18
17
|
extends ListBotsResponse,
|
|
@@ -15,6 +15,7 @@ export * from "./CreateContactFlowModuleCommand";
|
|
|
15
15
|
export * from "./CreateHoursOfOperationCommand";
|
|
16
16
|
export * from "./CreateInstanceCommand";
|
|
17
17
|
export * from "./CreateIntegrationAssociationCommand";
|
|
18
|
+
export * from "./CreateParticipantCommand";
|
|
18
19
|
export * from "./CreateQueueCommand";
|
|
19
20
|
export * from "./CreateQuickConnectCommand";
|
|
20
21
|
export * from "./CreateRoutingProfileCommand";
|