@aws-sdk/client-connectcampaigns 3.378.0 → 3.382.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.
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useDualstackEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* A header that defines the error encountered while processing the request.
|
|
12
13
|
*/
|
|
13
14
|
xAmzErrorType?: string;
|
|
@@ -24,6 +25,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
24
25
|
readonly name: "ConflictException";
|
|
25
26
|
readonly $fault: "client";
|
|
26
27
|
/**
|
|
28
|
+
* @public
|
|
27
29
|
* A header that defines the error encountered while processing the request.
|
|
28
30
|
*/
|
|
29
31
|
xAmzErrorType?: string;
|
|
@@ -38,6 +40,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
38
40
|
*/
|
|
39
41
|
export interface PredictiveDialerConfig {
|
|
40
42
|
/**
|
|
43
|
+
* @public
|
|
41
44
|
* The bandwidth allocation of a queue resource.
|
|
42
45
|
*/
|
|
43
46
|
bandwidthAllocation: number | undefined;
|
|
@@ -48,6 +51,7 @@ export interface PredictiveDialerConfig {
|
|
|
48
51
|
*/
|
|
49
52
|
export interface ProgressiveDialerConfig {
|
|
50
53
|
/**
|
|
54
|
+
* @public
|
|
51
55
|
* The bandwidth allocation of a queue resource.
|
|
52
56
|
*/
|
|
53
57
|
bandwidthAllocation: number | undefined;
|
|
@@ -62,6 +66,7 @@ export type DialerConfig = DialerConfig.PredictiveDialerConfigMember | DialerCon
|
|
|
62
66
|
*/
|
|
63
67
|
export declare namespace DialerConfig {
|
|
64
68
|
/**
|
|
69
|
+
* @public
|
|
65
70
|
* Progressive Dialer config
|
|
66
71
|
*/
|
|
67
72
|
interface ProgressiveDialerConfigMember {
|
|
@@ -70,6 +75,7 @@ export declare namespace DialerConfig {
|
|
|
70
75
|
$unknown?: never;
|
|
71
76
|
}
|
|
72
77
|
/**
|
|
78
|
+
* @public
|
|
73
79
|
* Predictive Dialer config
|
|
74
80
|
*/
|
|
75
81
|
interface PredictiveDialerConfigMember {
|
|
@@ -77,6 +83,9 @@ export declare namespace DialerConfig {
|
|
|
77
83
|
predictiveDialerConfig: PredictiveDialerConfig;
|
|
78
84
|
$unknown?: never;
|
|
79
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
80
89
|
interface $UnknownMember {
|
|
81
90
|
progressiveDialerConfig?: never;
|
|
82
91
|
predictiveDialerConfig?: never;
|
|
@@ -95,6 +104,7 @@ export declare namespace DialerConfig {
|
|
|
95
104
|
*/
|
|
96
105
|
export interface AnswerMachineDetectionConfig {
|
|
97
106
|
/**
|
|
107
|
+
* @public
|
|
98
108
|
* Enable or disable answering machine detection
|
|
99
109
|
*/
|
|
100
110
|
enableAnswerMachineDetection: boolean | undefined;
|
|
@@ -105,18 +115,22 @@ export interface AnswerMachineDetectionConfig {
|
|
|
105
115
|
*/
|
|
106
116
|
export interface OutboundCallConfig {
|
|
107
117
|
/**
|
|
118
|
+
* @public
|
|
108
119
|
* The identifier of the contact flow for the outbound call.
|
|
109
120
|
*/
|
|
110
121
|
connectContactFlowId: string | undefined;
|
|
111
122
|
/**
|
|
123
|
+
* @public
|
|
112
124
|
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
113
125
|
*/
|
|
114
126
|
connectSourcePhoneNumber?: string;
|
|
115
127
|
/**
|
|
128
|
+
* @public
|
|
116
129
|
* The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
|
|
117
130
|
*/
|
|
118
131
|
connectQueueId: string | undefined;
|
|
119
132
|
/**
|
|
133
|
+
* @public
|
|
120
134
|
* Answering Machine Detection config
|
|
121
135
|
*/
|
|
122
136
|
answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
|
@@ -127,22 +141,27 @@ export interface OutboundCallConfig {
|
|
|
127
141
|
*/
|
|
128
142
|
export interface CreateCampaignRequest {
|
|
129
143
|
/**
|
|
144
|
+
* @public
|
|
130
145
|
* The name of an Amazon Connect Campaign name.
|
|
131
146
|
*/
|
|
132
147
|
name: string | undefined;
|
|
133
148
|
/**
|
|
149
|
+
* @public
|
|
134
150
|
* Amazon Connect Instance Id
|
|
135
151
|
*/
|
|
136
152
|
connectInstanceId: string | undefined;
|
|
137
153
|
/**
|
|
154
|
+
* @public
|
|
138
155
|
* The possible types of dialer config parameters
|
|
139
156
|
*/
|
|
140
157
|
dialerConfig: DialerConfig | undefined;
|
|
141
158
|
/**
|
|
159
|
+
* @public
|
|
142
160
|
* The configuration used for outbound calls.
|
|
143
161
|
*/
|
|
144
162
|
outboundCallConfig: OutboundCallConfig | undefined;
|
|
145
163
|
/**
|
|
164
|
+
* @public
|
|
146
165
|
* Tag map with key and value.
|
|
147
166
|
*/
|
|
148
167
|
tags?: Record<string, string>;
|
|
@@ -153,14 +172,17 @@ export interface CreateCampaignRequest {
|
|
|
153
172
|
*/
|
|
154
173
|
export interface CreateCampaignResponse {
|
|
155
174
|
/**
|
|
175
|
+
* @public
|
|
156
176
|
* Identifier representing a Campaign
|
|
157
177
|
*/
|
|
158
178
|
id?: string;
|
|
159
179
|
/**
|
|
180
|
+
* @public
|
|
160
181
|
* The resource name of an Amazon Connect campaign.
|
|
161
182
|
*/
|
|
162
183
|
arn?: string;
|
|
163
184
|
/**
|
|
185
|
+
* @public
|
|
164
186
|
* Tag map with key and value.
|
|
165
187
|
*/
|
|
166
188
|
tags?: Record<string, string>;
|
|
@@ -174,6 +196,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
174
196
|
readonly $fault: "server";
|
|
175
197
|
$retryable: {};
|
|
176
198
|
/**
|
|
199
|
+
* @public
|
|
177
200
|
* A header that defines the error encountered while processing the request.
|
|
178
201
|
*/
|
|
179
202
|
xAmzErrorType?: string;
|
|
@@ -190,6 +213,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
190
213
|
readonly name: "ResourceNotFoundException";
|
|
191
214
|
readonly $fault: "client";
|
|
192
215
|
/**
|
|
216
|
+
* @public
|
|
193
217
|
* A header that defines the error encountered while processing the request.
|
|
194
218
|
*/
|
|
195
219
|
xAmzErrorType?: string;
|
|
@@ -206,6 +230,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
206
230
|
readonly name: "ServiceQuotaExceededException";
|
|
207
231
|
readonly $fault: "client";
|
|
208
232
|
/**
|
|
233
|
+
* @public
|
|
209
234
|
* A header that defines the error encountered while processing the request.
|
|
210
235
|
*/
|
|
211
236
|
xAmzErrorType?: string;
|
|
@@ -223,6 +248,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
223
248
|
readonly $fault: "client";
|
|
224
249
|
$retryable: {};
|
|
225
250
|
/**
|
|
251
|
+
* @public
|
|
226
252
|
* A header that defines the error encountered while processing the request.
|
|
227
253
|
*/
|
|
228
254
|
xAmzErrorType?: string;
|
|
@@ -239,6 +265,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
239
265
|
readonly name: "ValidationException";
|
|
240
266
|
readonly $fault: "client";
|
|
241
267
|
/**
|
|
268
|
+
* @public
|
|
242
269
|
* A header that defines the error encountered while processing the request.
|
|
243
270
|
*/
|
|
244
271
|
xAmzErrorType?: string;
|
|
@@ -253,6 +280,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
253
280
|
*/
|
|
254
281
|
export interface DeleteCampaignRequest {
|
|
255
282
|
/**
|
|
283
|
+
* @public
|
|
256
284
|
* Identifier representing a Campaign
|
|
257
285
|
*/
|
|
258
286
|
id: string | undefined;
|
|
@@ -263,6 +291,7 @@ export interface DeleteCampaignRequest {
|
|
|
263
291
|
*/
|
|
264
292
|
export interface DeleteConnectInstanceConfigRequest {
|
|
265
293
|
/**
|
|
294
|
+
* @public
|
|
266
295
|
* Amazon Connect Instance Id
|
|
267
296
|
*/
|
|
268
297
|
connectInstanceId: string | undefined;
|
|
@@ -275,6 +304,7 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
275
304
|
readonly name: "InvalidStateException";
|
|
276
305
|
readonly $fault: "client";
|
|
277
306
|
/**
|
|
307
|
+
* @public
|
|
278
308
|
* A header that defines the error encountered while processing the request.
|
|
279
309
|
*/
|
|
280
310
|
xAmzErrorType?: string;
|
|
@@ -289,6 +319,7 @@ export declare class InvalidStateException extends __BaseException {
|
|
|
289
319
|
*/
|
|
290
320
|
export interface DeleteInstanceOnboardingJobRequest {
|
|
291
321
|
/**
|
|
322
|
+
* @public
|
|
292
323
|
* Amazon Connect Instance Id
|
|
293
324
|
*/
|
|
294
325
|
connectInstanceId: string | undefined;
|
|
@@ -299,6 +330,7 @@ export interface DeleteInstanceOnboardingJobRequest {
|
|
|
299
330
|
*/
|
|
300
331
|
export interface DescribeCampaignRequest {
|
|
301
332
|
/**
|
|
333
|
+
* @public
|
|
302
334
|
* Identifier representing a Campaign
|
|
303
335
|
*/
|
|
304
336
|
id: string | undefined;
|
|
@@ -309,30 +341,37 @@ export interface DescribeCampaignRequest {
|
|
|
309
341
|
*/
|
|
310
342
|
export interface Campaign {
|
|
311
343
|
/**
|
|
344
|
+
* @public
|
|
312
345
|
* Identifier representing a Campaign
|
|
313
346
|
*/
|
|
314
347
|
id: string | undefined;
|
|
315
348
|
/**
|
|
349
|
+
* @public
|
|
316
350
|
* The resource name of an Amazon Connect campaign.
|
|
317
351
|
*/
|
|
318
352
|
arn: string | undefined;
|
|
319
353
|
/**
|
|
354
|
+
* @public
|
|
320
355
|
* The name of an Amazon Connect Campaign name.
|
|
321
356
|
*/
|
|
322
357
|
name: string | undefined;
|
|
323
358
|
/**
|
|
359
|
+
* @public
|
|
324
360
|
* Amazon Connect Instance Id
|
|
325
361
|
*/
|
|
326
362
|
connectInstanceId: string | undefined;
|
|
327
363
|
/**
|
|
364
|
+
* @public
|
|
328
365
|
* The possible types of dialer config parameters
|
|
329
366
|
*/
|
|
330
367
|
dialerConfig: DialerConfig | undefined;
|
|
331
368
|
/**
|
|
369
|
+
* @public
|
|
332
370
|
* The configuration used for outbound calls.
|
|
333
371
|
*/
|
|
334
372
|
outboundCallConfig: OutboundCallConfig | undefined;
|
|
335
373
|
/**
|
|
374
|
+
* @public
|
|
336
375
|
* Tag map with key and value.
|
|
337
376
|
*/
|
|
338
377
|
tags?: Record<string, string>;
|
|
@@ -343,6 +382,7 @@ export interface Campaign {
|
|
|
343
382
|
*/
|
|
344
383
|
export interface DescribeCampaignResponse {
|
|
345
384
|
/**
|
|
385
|
+
* @public
|
|
346
386
|
* An Amazon Connect campaign.
|
|
347
387
|
*/
|
|
348
388
|
campaign?: Campaign;
|
|
@@ -353,6 +393,7 @@ export interface DescribeCampaignResponse {
|
|
|
353
393
|
*/
|
|
354
394
|
export interface GetCampaignStateRequest {
|
|
355
395
|
/**
|
|
396
|
+
* @public
|
|
356
397
|
* Identifier representing a Campaign
|
|
357
398
|
*/
|
|
358
399
|
id: string | undefined;
|
|
@@ -393,6 +434,7 @@ export type CampaignState = (typeof CampaignState)[keyof typeof CampaignState];
|
|
|
393
434
|
*/
|
|
394
435
|
export interface GetCampaignStateResponse {
|
|
395
436
|
/**
|
|
437
|
+
* @public
|
|
396
438
|
* State of a campaign
|
|
397
439
|
*/
|
|
398
440
|
state?: CampaignState | string;
|
|
@@ -403,6 +445,7 @@ export interface GetCampaignStateResponse {
|
|
|
403
445
|
*/
|
|
404
446
|
export interface GetCampaignStateBatchRequest {
|
|
405
447
|
/**
|
|
448
|
+
* @public
|
|
406
449
|
* List of CampaignId
|
|
407
450
|
*/
|
|
408
451
|
campaignIds: string[] | undefined;
|
|
@@ -431,10 +474,12 @@ export type GetCampaignStateBatchFailureCode = (typeof GetCampaignStateBatchFail
|
|
|
431
474
|
*/
|
|
432
475
|
export interface FailedCampaignStateResponse {
|
|
433
476
|
/**
|
|
477
|
+
* @public
|
|
434
478
|
* Identifier representing a Campaign
|
|
435
479
|
*/
|
|
436
480
|
campaignId?: string;
|
|
437
481
|
/**
|
|
482
|
+
* @public
|
|
438
483
|
* A predefined code indicating the error that caused the failure in getting state of campaigns
|
|
439
484
|
*/
|
|
440
485
|
failureCode?: GetCampaignStateBatchFailureCode | string;
|
|
@@ -445,10 +490,12 @@ export interface FailedCampaignStateResponse {
|
|
|
445
490
|
*/
|
|
446
491
|
export interface SuccessfulCampaignStateResponse {
|
|
447
492
|
/**
|
|
493
|
+
* @public
|
|
448
494
|
* Identifier representing a Campaign
|
|
449
495
|
*/
|
|
450
496
|
campaignId?: string;
|
|
451
497
|
/**
|
|
498
|
+
* @public
|
|
452
499
|
* State of a campaign
|
|
453
500
|
*/
|
|
454
501
|
state?: CampaignState | string;
|
|
@@ -459,10 +506,12 @@ export interface SuccessfulCampaignStateResponse {
|
|
|
459
506
|
*/
|
|
460
507
|
export interface GetCampaignStateBatchResponse {
|
|
461
508
|
/**
|
|
509
|
+
* @public
|
|
462
510
|
* List of successful response of campaign state
|
|
463
511
|
*/
|
|
464
512
|
successfulRequests?: SuccessfulCampaignStateResponse[];
|
|
465
513
|
/**
|
|
514
|
+
* @public
|
|
466
515
|
* List of failed requests of campaign state
|
|
467
516
|
*/
|
|
468
517
|
failedRequests?: FailedCampaignStateResponse[];
|
|
@@ -473,6 +522,7 @@ export interface GetCampaignStateBatchResponse {
|
|
|
473
522
|
*/
|
|
474
523
|
export interface GetConnectInstanceConfigRequest {
|
|
475
524
|
/**
|
|
525
|
+
* @public
|
|
476
526
|
* Amazon Connect Instance Id
|
|
477
527
|
*/
|
|
478
528
|
connectInstanceId: string | undefined;
|
|
@@ -497,14 +547,17 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
|
|
|
497
547
|
*/
|
|
498
548
|
export interface EncryptionConfig {
|
|
499
549
|
/**
|
|
550
|
+
* @public
|
|
500
551
|
* Boolean to indicate if custom encryption has been enabled.
|
|
501
552
|
*/
|
|
502
553
|
enabled: boolean | undefined;
|
|
503
554
|
/**
|
|
555
|
+
* @public
|
|
504
556
|
* Server-side encryption type.
|
|
505
557
|
*/
|
|
506
558
|
encryptionType?: EncryptionType | string;
|
|
507
559
|
/**
|
|
560
|
+
* @public
|
|
508
561
|
* KMS key id/arn for encryption config.
|
|
509
562
|
*/
|
|
510
563
|
keyArn?: string;
|
|
@@ -515,14 +568,17 @@ export interface EncryptionConfig {
|
|
|
515
568
|
*/
|
|
516
569
|
export interface InstanceConfig {
|
|
517
570
|
/**
|
|
571
|
+
* @public
|
|
518
572
|
* Amazon Connect Instance Id
|
|
519
573
|
*/
|
|
520
574
|
connectInstanceId: string | undefined;
|
|
521
575
|
/**
|
|
576
|
+
* @public
|
|
522
577
|
* Service linked role arn
|
|
523
578
|
*/
|
|
524
579
|
serviceLinkedRoleArn: string | undefined;
|
|
525
580
|
/**
|
|
581
|
+
* @public
|
|
526
582
|
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
527
583
|
* If disabled, service will perform encryption with its own key.
|
|
528
584
|
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
@@ -536,6 +592,7 @@ export interface InstanceConfig {
|
|
|
536
592
|
*/
|
|
537
593
|
export interface GetConnectInstanceConfigResponse {
|
|
538
594
|
/**
|
|
595
|
+
* @public
|
|
539
596
|
* Instance config object
|
|
540
597
|
*/
|
|
541
598
|
connectInstanceConfig?: InstanceConfig;
|
|
@@ -546,6 +603,7 @@ export interface GetConnectInstanceConfigResponse {
|
|
|
546
603
|
*/
|
|
547
604
|
export interface GetInstanceOnboardingJobStatusRequest {
|
|
548
605
|
/**
|
|
606
|
+
* @public
|
|
549
607
|
* Amazon Connect Instance Id
|
|
550
608
|
*/
|
|
551
609
|
connectInstanceId: string | undefined;
|
|
@@ -585,14 +643,17 @@ export type InstanceOnboardingJobStatusCode = (typeof InstanceOnboardingJobStatu
|
|
|
585
643
|
*/
|
|
586
644
|
export interface InstanceOnboardingJobStatus {
|
|
587
645
|
/**
|
|
646
|
+
* @public
|
|
588
647
|
* Amazon Connect Instance Id
|
|
589
648
|
*/
|
|
590
649
|
connectInstanceId: string | undefined;
|
|
591
650
|
/**
|
|
651
|
+
* @public
|
|
592
652
|
* Enumeration of the possible states for instance onboarding job
|
|
593
653
|
*/
|
|
594
654
|
status: InstanceOnboardingJobStatusCode | string | undefined;
|
|
595
655
|
/**
|
|
656
|
+
* @public
|
|
596
657
|
* Enumeration of the possible failure codes for instance onboarding job
|
|
597
658
|
*/
|
|
598
659
|
failureCode?: InstanceOnboardingJobFailureCode | string;
|
|
@@ -603,6 +664,7 @@ export interface InstanceOnboardingJobStatus {
|
|
|
603
664
|
*/
|
|
604
665
|
export interface GetInstanceOnboardingJobStatusResponse {
|
|
605
666
|
/**
|
|
667
|
+
* @public
|
|
606
668
|
* Instance onboarding job status object
|
|
607
669
|
*/
|
|
608
670
|
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
|
|
@@ -627,10 +689,12 @@ export type InstanceIdFilterOperator = (typeof InstanceIdFilterOperator)[keyof t
|
|
|
627
689
|
*/
|
|
628
690
|
export interface InstanceIdFilter {
|
|
629
691
|
/**
|
|
692
|
+
* @public
|
|
630
693
|
* Amazon Connect Instance Id
|
|
631
694
|
*/
|
|
632
695
|
value: string | undefined;
|
|
633
696
|
/**
|
|
697
|
+
* @public
|
|
634
698
|
* Operators for Connect instance identifier filter
|
|
635
699
|
*/
|
|
636
700
|
operator: InstanceIdFilterOperator | string | undefined;
|
|
@@ -641,6 +705,7 @@ export interface InstanceIdFilter {
|
|
|
641
705
|
*/
|
|
642
706
|
export interface CampaignFilters {
|
|
643
707
|
/**
|
|
708
|
+
* @public
|
|
644
709
|
* Connect instance identifier filter
|
|
645
710
|
*/
|
|
646
711
|
instanceIdFilter?: InstanceIdFilter;
|
|
@@ -651,14 +716,17 @@ export interface CampaignFilters {
|
|
|
651
716
|
*/
|
|
652
717
|
export interface ListCampaignsRequest {
|
|
653
718
|
/**
|
|
719
|
+
* @public
|
|
654
720
|
* The maximum number of results to return per page.
|
|
655
721
|
*/
|
|
656
722
|
maxResults?: number;
|
|
657
723
|
/**
|
|
724
|
+
* @public
|
|
658
725
|
* The token for the next set of results.
|
|
659
726
|
*/
|
|
660
727
|
nextToken?: string;
|
|
661
728
|
/**
|
|
729
|
+
* @public
|
|
662
730
|
* Filter model by type
|
|
663
731
|
*/
|
|
664
732
|
filters?: CampaignFilters;
|
|
@@ -669,18 +737,22 @@ export interface ListCampaignsRequest {
|
|
|
669
737
|
*/
|
|
670
738
|
export interface CampaignSummary {
|
|
671
739
|
/**
|
|
740
|
+
* @public
|
|
672
741
|
* Identifier representing a Campaign
|
|
673
742
|
*/
|
|
674
743
|
id: string | undefined;
|
|
675
744
|
/**
|
|
745
|
+
* @public
|
|
676
746
|
* The resource name of an Amazon Connect campaign.
|
|
677
747
|
*/
|
|
678
748
|
arn: string | undefined;
|
|
679
749
|
/**
|
|
750
|
+
* @public
|
|
680
751
|
* The name of an Amazon Connect Campaign name.
|
|
681
752
|
*/
|
|
682
753
|
name: string | undefined;
|
|
683
754
|
/**
|
|
755
|
+
* @public
|
|
684
756
|
* Amazon Connect Instance Id
|
|
685
757
|
*/
|
|
686
758
|
connectInstanceId: string | undefined;
|
|
@@ -691,10 +763,12 @@ export interface CampaignSummary {
|
|
|
691
763
|
*/
|
|
692
764
|
export interface ListCampaignsResponse {
|
|
693
765
|
/**
|
|
766
|
+
* @public
|
|
694
767
|
* The token for the next set of results.
|
|
695
768
|
*/
|
|
696
769
|
nextToken?: string;
|
|
697
770
|
/**
|
|
771
|
+
* @public
|
|
698
772
|
* A list of Amazon Connect campaigns.
|
|
699
773
|
*/
|
|
700
774
|
campaignSummaryList?: CampaignSummary[];
|
|
@@ -705,6 +779,7 @@ export interface ListCampaignsResponse {
|
|
|
705
779
|
*/
|
|
706
780
|
export interface ListTagsForResourceRequest {
|
|
707
781
|
/**
|
|
782
|
+
* @public
|
|
708
783
|
* Arn
|
|
709
784
|
*/
|
|
710
785
|
arn: string | undefined;
|
|
@@ -715,6 +790,7 @@ export interface ListTagsForResourceRequest {
|
|
|
715
790
|
*/
|
|
716
791
|
export interface ListTagsForResourceResponse {
|
|
717
792
|
/**
|
|
793
|
+
* @public
|
|
718
794
|
* Tag map with key and value.
|
|
719
795
|
*/
|
|
720
796
|
tags?: Record<string, string>;
|
|
@@ -727,10 +803,12 @@ export declare class InvalidCampaignStateException extends __BaseException {
|
|
|
727
803
|
readonly name: "InvalidCampaignStateException";
|
|
728
804
|
readonly $fault: "client";
|
|
729
805
|
/**
|
|
806
|
+
* @public
|
|
730
807
|
* State of a campaign
|
|
731
808
|
*/
|
|
732
809
|
state: CampaignState | string | undefined;
|
|
733
810
|
/**
|
|
811
|
+
* @public
|
|
734
812
|
* A header that defines the error encountered while processing the request.
|
|
735
813
|
*/
|
|
736
814
|
xAmzErrorType?: string;
|
|
@@ -745,6 +823,7 @@ export declare class InvalidCampaignStateException extends __BaseException {
|
|
|
745
823
|
*/
|
|
746
824
|
export interface PauseCampaignRequest {
|
|
747
825
|
/**
|
|
826
|
+
* @public
|
|
748
827
|
* Identifier representing a Campaign
|
|
749
828
|
*/
|
|
750
829
|
id: string | undefined;
|
|
@@ -755,18 +834,22 @@ export interface PauseCampaignRequest {
|
|
|
755
834
|
*/
|
|
756
835
|
export interface DialRequest {
|
|
757
836
|
/**
|
|
837
|
+
* @public
|
|
758
838
|
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
759
839
|
*/
|
|
760
840
|
clientToken: string | undefined;
|
|
761
841
|
/**
|
|
842
|
+
* @public
|
|
762
843
|
* The phone number of the customer, in E.164 format.
|
|
763
844
|
*/
|
|
764
845
|
phoneNumber: string | undefined;
|
|
765
846
|
/**
|
|
847
|
+
* @public
|
|
766
848
|
* Timestamp with no UTC offset or timezone
|
|
767
849
|
*/
|
|
768
850
|
expirationTime: Date | undefined;
|
|
769
851
|
/**
|
|
852
|
+
* @public
|
|
770
853
|
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
|
|
771
854
|
*/
|
|
772
855
|
attributes: Record<string, string> | undefined;
|
|
@@ -777,10 +860,12 @@ export interface DialRequest {
|
|
|
777
860
|
*/
|
|
778
861
|
export interface PutDialRequestBatchRequest {
|
|
779
862
|
/**
|
|
863
|
+
* @public
|
|
780
864
|
* Identifier representing a Campaign
|
|
781
865
|
*/
|
|
782
866
|
id: string | undefined;
|
|
783
867
|
/**
|
|
868
|
+
* @public
|
|
784
869
|
* A list of dial requests.
|
|
785
870
|
*/
|
|
786
871
|
dialRequests: DialRequest[] | undefined;
|
|
@@ -813,14 +898,17 @@ export type FailureCode = (typeof FailureCode)[keyof typeof FailureCode];
|
|
|
813
898
|
*/
|
|
814
899
|
export interface FailedRequest {
|
|
815
900
|
/**
|
|
901
|
+
* @public
|
|
816
902
|
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
817
903
|
*/
|
|
818
904
|
clientToken?: string;
|
|
819
905
|
/**
|
|
906
|
+
* @public
|
|
820
907
|
* Identifier representing a Dial request
|
|
821
908
|
*/
|
|
822
909
|
id?: string;
|
|
823
910
|
/**
|
|
911
|
+
* @public
|
|
824
912
|
* A predefined code indicating the error that caused the failure.
|
|
825
913
|
*/
|
|
826
914
|
failureCode?: FailureCode | string;
|
|
@@ -831,10 +919,12 @@ export interface FailedRequest {
|
|
|
831
919
|
*/
|
|
832
920
|
export interface SuccessfulRequest {
|
|
833
921
|
/**
|
|
922
|
+
* @public
|
|
834
923
|
* Client provided parameter used for idempotency. Its value must be unique for each request.
|
|
835
924
|
*/
|
|
836
925
|
clientToken?: string;
|
|
837
926
|
/**
|
|
927
|
+
* @public
|
|
838
928
|
* Identifier representing a Dial request
|
|
839
929
|
*/
|
|
840
930
|
id?: string;
|
|
@@ -845,10 +935,12 @@ export interface SuccessfulRequest {
|
|
|
845
935
|
*/
|
|
846
936
|
export interface PutDialRequestBatchResponse {
|
|
847
937
|
/**
|
|
938
|
+
* @public
|
|
848
939
|
* A list of successful requests identified by the unique client token.
|
|
849
940
|
*/
|
|
850
941
|
successfulRequests?: SuccessfulRequest[];
|
|
851
942
|
/**
|
|
943
|
+
* @public
|
|
852
944
|
* A list of failed requests.
|
|
853
945
|
*/
|
|
854
946
|
failedRequests?: FailedRequest[];
|
|
@@ -859,6 +951,7 @@ export interface PutDialRequestBatchResponse {
|
|
|
859
951
|
*/
|
|
860
952
|
export interface ResumeCampaignRequest {
|
|
861
953
|
/**
|
|
954
|
+
* @public
|
|
862
955
|
* Identifier representing a Campaign
|
|
863
956
|
*/
|
|
864
957
|
id: string | undefined;
|
|
@@ -869,6 +962,7 @@ export interface ResumeCampaignRequest {
|
|
|
869
962
|
*/
|
|
870
963
|
export interface StartCampaignRequest {
|
|
871
964
|
/**
|
|
965
|
+
* @public
|
|
872
966
|
* Identifier representing a Campaign
|
|
873
967
|
*/
|
|
874
968
|
id: string | undefined;
|
|
@@ -879,10 +973,12 @@ export interface StartCampaignRequest {
|
|
|
879
973
|
*/
|
|
880
974
|
export interface StartInstanceOnboardingJobRequest {
|
|
881
975
|
/**
|
|
976
|
+
* @public
|
|
882
977
|
* Amazon Connect Instance Id
|
|
883
978
|
*/
|
|
884
979
|
connectInstanceId: string | undefined;
|
|
885
980
|
/**
|
|
981
|
+
* @public
|
|
886
982
|
* Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
|
|
887
983
|
* If disabled, service will perform encryption with its own key.
|
|
888
984
|
* If enabled, a KMS key id needs to be provided and KMS charges will apply.
|
|
@@ -896,6 +992,7 @@ export interface StartInstanceOnboardingJobRequest {
|
|
|
896
992
|
*/
|
|
897
993
|
export interface StartInstanceOnboardingJobResponse {
|
|
898
994
|
/**
|
|
995
|
+
* @public
|
|
899
996
|
* Instance onboarding job status object
|
|
900
997
|
*/
|
|
901
998
|
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
|
|
@@ -906,6 +1003,7 @@ export interface StartInstanceOnboardingJobResponse {
|
|
|
906
1003
|
*/
|
|
907
1004
|
export interface StopCampaignRequest {
|
|
908
1005
|
/**
|
|
1006
|
+
* @public
|
|
909
1007
|
* Identifier representing a Campaign
|
|
910
1008
|
*/
|
|
911
1009
|
id: string | undefined;
|
|
@@ -916,10 +1014,12 @@ export interface StopCampaignRequest {
|
|
|
916
1014
|
*/
|
|
917
1015
|
export interface TagResourceRequest {
|
|
918
1016
|
/**
|
|
1017
|
+
* @public
|
|
919
1018
|
* Arn
|
|
920
1019
|
*/
|
|
921
1020
|
arn: string | undefined;
|
|
922
1021
|
/**
|
|
1022
|
+
* @public
|
|
923
1023
|
* Tag map with key and value.
|
|
924
1024
|
*/
|
|
925
1025
|
tags: Record<string, string> | undefined;
|
|
@@ -930,10 +1030,12 @@ export interface TagResourceRequest {
|
|
|
930
1030
|
*/
|
|
931
1031
|
export interface UntagResourceRequest {
|
|
932
1032
|
/**
|
|
1033
|
+
* @public
|
|
933
1034
|
* Arn
|
|
934
1035
|
*/
|
|
935
1036
|
arn: string | undefined;
|
|
936
1037
|
/**
|
|
1038
|
+
* @public
|
|
937
1039
|
* List of tag keys.
|
|
938
1040
|
*/
|
|
939
1041
|
tagKeys: string[] | undefined;
|
|
@@ -944,10 +1046,12 @@ export interface UntagResourceRequest {
|
|
|
944
1046
|
*/
|
|
945
1047
|
export interface UpdateCampaignDialerConfigRequest {
|
|
946
1048
|
/**
|
|
1049
|
+
* @public
|
|
947
1050
|
* Identifier representing a Campaign
|
|
948
1051
|
*/
|
|
949
1052
|
id: string | undefined;
|
|
950
1053
|
/**
|
|
1054
|
+
* @public
|
|
951
1055
|
* The possible types of dialer config parameters
|
|
952
1056
|
*/
|
|
953
1057
|
dialerConfig: DialerConfig | undefined;
|
|
@@ -958,10 +1062,12 @@ export interface UpdateCampaignDialerConfigRequest {
|
|
|
958
1062
|
*/
|
|
959
1063
|
export interface UpdateCampaignNameRequest {
|
|
960
1064
|
/**
|
|
1065
|
+
* @public
|
|
961
1066
|
* Identifier representing a Campaign
|
|
962
1067
|
*/
|
|
963
1068
|
id: string | undefined;
|
|
964
1069
|
/**
|
|
1070
|
+
* @public
|
|
965
1071
|
* The name of an Amazon Connect Campaign name.
|
|
966
1072
|
*/
|
|
967
1073
|
name: string | undefined;
|
|
@@ -972,18 +1078,22 @@ export interface UpdateCampaignNameRequest {
|
|
|
972
1078
|
*/
|
|
973
1079
|
export interface UpdateCampaignOutboundCallConfigRequest {
|
|
974
1080
|
/**
|
|
1081
|
+
* @public
|
|
975
1082
|
* Identifier representing a Campaign
|
|
976
1083
|
*/
|
|
977
1084
|
id: string | undefined;
|
|
978
1085
|
/**
|
|
1086
|
+
* @public
|
|
979
1087
|
* The identifier of the contact flow for the outbound call.
|
|
980
1088
|
*/
|
|
981
1089
|
connectContactFlowId?: string;
|
|
982
1090
|
/**
|
|
1091
|
+
* @public
|
|
983
1092
|
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
|
|
984
1093
|
*/
|
|
985
1094
|
connectSourcePhoneNumber?: string;
|
|
986
1095
|
/**
|
|
1096
|
+
* @public
|
|
987
1097
|
* Answering Machine Detection config
|
|
988
1098
|
*/
|
|
989
1099
|
answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-connectcampaigns",
|
|
3
3
|
"description": "AWS SDK for JavaScript Connectcampaigns Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.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",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|