@aws-sdk/client-connectcampaigns 3.169.0 → 3.170.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist-types/ts3.4/ConnectCampaigns.d.ts +400 -115
  3. package/dist-types/ts3.4/ConnectCampaignsClient.d.ts +262 -95
  4. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +37 -17
  5. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +32 -17
  6. package/dist-types/ts3.4/commands/DeleteConnectInstanceConfigCommand.d.ts +37 -17
  7. package/dist-types/ts3.4/commands/DeleteInstanceOnboardingJobCommand.d.ts +37 -17
  8. package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +37 -17
  9. package/dist-types/ts3.4/commands/GetCampaignStateBatchCommand.d.ts +41 -17
  10. package/dist-types/ts3.4/commands/GetCampaignStateCommand.d.ts +37 -17
  11. package/dist-types/ts3.4/commands/GetConnectInstanceConfigCommand.d.ts +41 -17
  12. package/dist-types/ts3.4/commands/GetInstanceOnboardingJobStatusCommand.d.ts +41 -17
  13. package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +37 -17
  14. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -17
  15. package/dist-types/ts3.4/commands/PauseCampaignCommand.d.ts +32 -17
  16. package/dist-types/ts3.4/commands/PutDialRequestBatchCommand.d.ts +38 -17
  17. package/dist-types/ts3.4/commands/ResumeCampaignCommand.d.ts +32 -17
  18. package/dist-types/ts3.4/commands/StartCampaignCommand.d.ts +32 -17
  19. package/dist-types/ts3.4/commands/StartInstanceOnboardingJobCommand.d.ts +41 -17
  20. package/dist-types/ts3.4/commands/StopCampaignCommand.d.ts +32 -17
  21. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +32 -17
  22. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +32 -17
  23. package/dist-types/ts3.4/commands/UpdateCampaignDialerConfigCommand.d.ts +37 -17
  24. package/dist-types/ts3.4/commands/UpdateCampaignNameCommand.d.ts +33 -17
  25. package/dist-types/ts3.4/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +37 -17
  26. package/dist-types/ts3.4/commands/index.d.ts +22 -22
  27. package/dist-types/ts3.4/endpoints.d.ts +2 -2
  28. package/dist-types/ts3.4/index.d.ts +6 -6
  29. package/dist-types/ts3.4/models/ConnectCampaignsServiceException.d.ts +8 -6
  30. package/dist-types/ts3.4/models/index.d.ts +1 -1
  31. package/dist-types/ts3.4/models/models_0.d.ts +650 -595
  32. package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -6
  33. package/dist-types/ts3.4/pagination/ListCampaignsPaginator.d.ts +11 -4
  34. package/dist-types/ts3.4/pagination/index.d.ts +2 -2
  35. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +269 -68
  36. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +68 -38
  37. package/dist-types/ts3.4/runtimeConfig.d.ts +68 -38
  38. package/dist-types/ts3.4/runtimeConfig.native.d.ts +69 -37
  39. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +13 -11
  40. package/package.json +34 -34
@@ -1,595 +1,650 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
- import { ConnectCampaignsServiceException as __BaseException } from "./ConnectCampaignsServiceException";
3
-
4
- export declare class AccessDeniedException extends __BaseException {
5
- readonly name: "AccessDeniedException";
6
- readonly $fault: "client";
7
-
8
- xAmzErrorType?: string;
9
-
10
- constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
11
- }
12
-
13
- export declare class ConflictException extends __BaseException {
14
- readonly name: "ConflictException";
15
- readonly $fault: "client";
16
-
17
- xAmzErrorType?: string;
18
-
19
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
20
- }
21
-
22
- export interface PredictiveDialerConfig {
23
-
24
- bandwidthAllocation: number | undefined;
25
- }
26
-
27
- export interface ProgressiveDialerConfig {
28
-
29
- bandwidthAllocation: number | undefined;
30
- }
31
-
32
- export declare type DialerConfig = DialerConfig.PredictiveDialerConfigMember | DialerConfig.ProgressiveDialerConfigMember | DialerConfig.$UnknownMember;
33
- export declare namespace DialerConfig {
34
-
35
- interface ProgressiveDialerConfigMember {
36
- progressiveDialerConfig: ProgressiveDialerConfig;
37
- predictiveDialerConfig?: never;
38
- $unknown?: never;
39
- }
40
-
41
- interface PredictiveDialerConfigMember {
42
- progressiveDialerConfig?: never;
43
- predictiveDialerConfig: PredictiveDialerConfig;
44
- $unknown?: never;
45
- }
46
- interface $UnknownMember {
47
- progressiveDialerConfig?: never;
48
- predictiveDialerConfig?: never;
49
- $unknown: [
50
- string,
51
- any
52
- ];
53
- }
54
- interface Visitor<T> {
55
- progressiveDialerConfig: (value: ProgressiveDialerConfig) => T;
56
- predictiveDialerConfig: (value: PredictiveDialerConfig) => T;
57
- _: (name: string, value: any) => T;
58
- }
59
- const visit: <T>(value: DialerConfig, visitor: Visitor<T>) => T;
60
- }
61
-
62
- export interface AnswerMachineDetectionConfig {
63
-
64
- enableAnswerMachineDetection: boolean | undefined;
65
- }
66
-
67
- export interface OutboundCallConfig {
68
-
69
- connectContactFlowId: string | undefined;
70
-
71
- connectSourcePhoneNumber?: string;
72
-
73
- connectQueueId: string | undefined;
74
-
75
- answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
76
- }
77
-
78
- export interface CreateCampaignRequest {
79
-
80
- name: string | undefined;
81
-
82
- connectInstanceId: string | undefined;
83
-
84
- dialerConfig: DialerConfig | undefined;
85
-
86
- outboundCallConfig: OutboundCallConfig | undefined;
87
-
88
- tags?: Record<string, string>;
89
- }
90
-
91
- export interface CreateCampaignResponse {
92
-
93
- id?: string;
94
-
95
- arn?: string;
96
-
97
- tags?: Record<string, string>;
98
- }
99
-
100
- export declare class InternalServerException extends __BaseException {
101
- readonly name: "InternalServerException";
102
- readonly $fault: "server";
103
- $retryable: {};
104
-
105
- xAmzErrorType?: string;
106
-
107
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
108
- }
109
-
110
- export declare class ResourceNotFoundException extends __BaseException {
111
- readonly name: "ResourceNotFoundException";
112
- readonly $fault: "client";
113
-
114
- xAmzErrorType?: string;
115
-
116
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
117
- }
118
-
119
- export declare class ServiceQuotaExceededException extends __BaseException {
120
- readonly name: "ServiceQuotaExceededException";
121
- readonly $fault: "client";
122
-
123
- xAmzErrorType?: string;
124
-
125
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
126
- }
127
-
128
- export declare class ThrottlingException extends __BaseException {
129
- readonly name: "ThrottlingException";
130
- readonly $fault: "client";
131
- $retryable: {};
132
-
133
- xAmzErrorType?: string;
134
-
135
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
136
- }
137
-
138
- export declare class ValidationException extends __BaseException {
139
- readonly name: "ValidationException";
140
- readonly $fault: "client";
141
-
142
- xAmzErrorType?: string;
143
-
144
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
145
- }
146
-
147
- export interface DeleteCampaignRequest {
148
-
149
- id: string | undefined;
150
- }
151
-
152
- export interface DeleteConnectInstanceConfigRequest {
153
-
154
- connectInstanceId: string | undefined;
155
- }
156
-
157
- export declare class InvalidStateException extends __BaseException {
158
- readonly name: "InvalidStateException";
159
- readonly $fault: "client";
160
-
161
- xAmzErrorType?: string;
162
-
163
- constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
164
- }
165
-
166
- export interface DeleteInstanceOnboardingJobRequest {
167
-
168
- connectInstanceId: string | undefined;
169
- }
170
-
171
- export interface DescribeCampaignRequest {
172
-
173
- id: string | undefined;
174
- }
175
-
176
- export interface Campaign {
177
-
178
- id: string | undefined;
179
-
180
- arn: string | undefined;
181
-
182
- name: string | undefined;
183
-
184
- connectInstanceId: string | undefined;
185
-
186
- dialerConfig: DialerConfig | undefined;
187
-
188
- outboundCallConfig: OutboundCallConfig | undefined;
189
-
190
- tags?: Record<string, string>;
191
- }
192
-
193
- export interface DescribeCampaignResponse {
194
-
195
- campaign?: Campaign;
196
- }
197
-
198
- export interface GetCampaignStateRequest {
199
-
200
- id: string | undefined;
201
- }
202
- export declare enum CampaignState {
203
-
204
- FAILED = "Failed",
205
-
206
- INITIALIZED = "Initialized",
207
-
208
- PAUSED = "Paused",
209
-
210
- RUNNING = "Running",
211
-
212
- STOPPED = "Stopped"
213
- }
214
-
215
- export interface GetCampaignStateResponse {
216
-
217
- state?: CampaignState | string;
218
- }
219
-
220
- export interface GetCampaignStateBatchRequest {
221
-
222
- campaignIds: string[] | undefined;
223
- }
224
- export declare enum GetCampaignStateBatchFailureCode {
225
-
226
- RESOURCE_NOT_FOUND = "ResourceNotFound",
227
-
228
- UNKNOWN_ERROR = "UnknownError"
229
- }
230
-
231
- export interface FailedCampaignStateResponse {
232
-
233
- campaignId?: string;
234
-
235
- failureCode?: GetCampaignStateBatchFailureCode | string;
236
- }
237
-
238
- export interface SuccessfulCampaignStateResponse {
239
-
240
- campaignId?: string;
241
-
242
- state?: CampaignState | string;
243
- }
244
-
245
- export interface GetCampaignStateBatchResponse {
246
-
247
- successfulRequests?: SuccessfulCampaignStateResponse[];
248
-
249
- failedRequests?: FailedCampaignStateResponse[];
250
- }
251
-
252
- export interface GetConnectInstanceConfigRequest {
253
-
254
- connectInstanceId: string | undefined;
255
- }
256
- export declare enum EncryptionType {
257
- KMS = "KMS"
258
- }
259
-
260
- export interface EncryptionConfig {
261
-
262
- enabled: boolean | undefined;
263
-
264
- encryptionType?: EncryptionType | string;
265
-
266
- keyArn?: string;
267
- }
268
-
269
- export interface InstanceConfig {
270
-
271
- connectInstanceId: string | undefined;
272
-
273
- serviceLinkedRoleArn: string | undefined;
274
-
275
- encryptionConfig: EncryptionConfig | undefined;
276
- }
277
-
278
- export interface GetConnectInstanceConfigResponse {
279
-
280
- connectInstanceConfig?: InstanceConfig;
281
- }
282
-
283
- export interface GetInstanceOnboardingJobStatusRequest {
284
-
285
- connectInstanceId: string | undefined;
286
- }
287
- export declare enum InstanceOnboardingJobFailureCode {
288
- EVENT_BRIDGE_ACCESS_DENIED = "EVENT_BRIDGE_ACCESS_DENIED",
289
- EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED = "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
290
- IAM_ACCESS_DENIED = "IAM_ACCESS_DENIED",
291
- INTERNAL_FAILURE = "INTERNAL_FAILURE",
292
- KMS_ACCESS_DENIED = "KMS_ACCESS_DENIED",
293
- KMS_KEY_NOT_FOUND = "KMS_KEY_NOT_FOUND"
294
- }
295
- export declare enum InstanceOnboardingJobStatusCode {
296
- FAILED = "FAILED",
297
- IN_PROGRESS = "IN_PROGRESS",
298
- SUCCEEDED = "SUCCEEDED"
299
- }
300
-
301
- export interface InstanceOnboardingJobStatus {
302
-
303
- connectInstanceId: string | undefined;
304
-
305
- status: InstanceOnboardingJobStatusCode | string | undefined;
306
-
307
- failureCode?: InstanceOnboardingJobFailureCode | string;
308
- }
309
-
310
- export interface GetInstanceOnboardingJobStatusResponse {
311
-
312
- connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
313
- }
314
- export declare enum InstanceIdFilterOperator {
315
-
316
- EQ = "Eq"
317
- }
318
-
319
- export interface InstanceIdFilter {
320
-
321
- value: string | undefined;
322
-
323
- operator: InstanceIdFilterOperator | string | undefined;
324
- }
325
-
326
- export interface CampaignFilters {
327
-
328
- instanceIdFilter?: InstanceIdFilter;
329
- }
330
-
331
- export interface ListCampaignsRequest {
332
-
333
- maxResults?: number;
334
-
335
- nextToken?: string;
336
-
337
- filters?: CampaignFilters;
338
- }
339
-
340
- export interface CampaignSummary {
341
-
342
- id: string | undefined;
343
-
344
- arn: string | undefined;
345
-
346
- name: string | undefined;
347
-
348
- connectInstanceId: string | undefined;
349
- }
350
-
351
- export interface ListCampaignsResponse {
352
-
353
- nextToken?: string;
354
-
355
- campaignSummaryList?: CampaignSummary[];
356
- }
357
-
358
- export interface ListTagsForResourceRequest {
359
-
360
- arn: string | undefined;
361
- }
362
-
363
- export interface ListTagsForResourceResponse {
364
-
365
- tags?: Record<string, string>;
366
- }
367
-
368
- export declare class InvalidCampaignStateException extends __BaseException {
369
- readonly name: "InvalidCampaignStateException";
370
- readonly $fault: "client";
371
-
372
- state: CampaignState | string | undefined;
373
-
374
- xAmzErrorType?: string;
375
-
376
- constructor(opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>);
377
- }
378
-
379
- export interface PauseCampaignRequest {
380
-
381
- id: string | undefined;
382
- }
383
-
384
- export interface DialRequest {
385
-
386
- clientToken: string | undefined;
387
-
388
- phoneNumber: string | undefined;
389
-
390
- expirationTime: Date | undefined;
391
-
392
- attributes: Record<string, string> | undefined;
393
- }
394
-
395
- export interface PutDialRequestBatchRequest {
396
-
397
- id: string | undefined;
398
-
399
- dialRequests: DialRequest[] | undefined;
400
- }
401
- export declare enum FailureCode {
402
-
403
- INVALID_INPUT = "InvalidInput",
404
-
405
- REQUEST_THROTTLED = "RequestThrottled",
406
-
407
- UNKNOWN_ERROR = "UnknownError"
408
- }
409
-
410
- export interface FailedRequest {
411
-
412
- clientToken?: string;
413
-
414
- id?: string;
415
-
416
- failureCode?: FailureCode | string;
417
- }
418
-
419
- export interface SuccessfulRequest {
420
-
421
- clientToken?: string;
422
-
423
- id?: string;
424
- }
425
-
426
- export interface PutDialRequestBatchResponse {
427
-
428
- successfulRequests?: SuccessfulRequest[];
429
-
430
- failedRequests?: FailedRequest[];
431
- }
432
-
433
- export interface ResumeCampaignRequest {
434
-
435
- id: string | undefined;
436
- }
437
-
438
- export interface StartCampaignRequest {
439
-
440
- id: string | undefined;
441
- }
442
-
443
- export interface StartInstanceOnboardingJobRequest {
444
-
445
- connectInstanceId: string | undefined;
446
-
447
- encryptionConfig: EncryptionConfig | undefined;
448
- }
449
-
450
- export interface StartInstanceOnboardingJobResponse {
451
-
452
- connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
453
- }
454
-
455
- export interface StopCampaignRequest {
456
-
457
- id: string | undefined;
458
- }
459
-
460
- export interface TagResourceRequest {
461
-
462
- arn: string | undefined;
463
-
464
- tags: Record<string, string> | undefined;
465
- }
466
-
467
- export interface UntagResourceRequest {
468
-
469
- arn: string | undefined;
470
-
471
- tagKeys: string[] | undefined;
472
- }
473
-
474
- export interface UpdateCampaignDialerConfigRequest {
475
-
476
- id: string | undefined;
477
-
478
- dialerConfig: DialerConfig | undefined;
479
- }
480
-
481
- export interface UpdateCampaignNameRequest {
482
-
483
- id: string | undefined;
484
-
485
- name: string | undefined;
486
- }
487
-
488
- export interface UpdateCampaignOutboundCallConfigRequest {
489
-
490
- id: string | undefined;
491
-
492
- connectContactFlowId?: string;
493
-
494
- connectSourcePhoneNumber?: string;
495
-
496
- answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
497
- }
498
-
499
- export declare const PredictiveDialerConfigFilterSensitiveLog: (obj: PredictiveDialerConfig) => any;
500
-
501
- export declare const ProgressiveDialerConfigFilterSensitiveLog: (obj: ProgressiveDialerConfig) => any;
502
-
503
- export declare const DialerConfigFilterSensitiveLog: (obj: DialerConfig) => any;
504
-
505
- export declare const AnswerMachineDetectionConfigFilterSensitiveLog: (obj: AnswerMachineDetectionConfig) => any;
506
-
507
- export declare const OutboundCallConfigFilterSensitiveLog: (obj: OutboundCallConfig) => any;
508
-
509
- export declare const CreateCampaignRequestFilterSensitiveLog: (obj: CreateCampaignRequest) => any;
510
-
511
- export declare const CreateCampaignResponseFilterSensitiveLog: (obj: CreateCampaignResponse) => any;
512
-
513
- export declare const DeleteCampaignRequestFilterSensitiveLog: (obj: DeleteCampaignRequest) => any;
514
-
515
- export declare const DeleteConnectInstanceConfigRequestFilterSensitiveLog: (obj: DeleteConnectInstanceConfigRequest) => any;
516
-
517
- export declare const DeleteInstanceOnboardingJobRequestFilterSensitiveLog: (obj: DeleteInstanceOnboardingJobRequest) => any;
518
-
519
- export declare const DescribeCampaignRequestFilterSensitiveLog: (obj: DescribeCampaignRequest) => any;
520
-
521
- export declare const CampaignFilterSensitiveLog: (obj: Campaign) => any;
522
-
523
- export declare const DescribeCampaignResponseFilterSensitiveLog: (obj: DescribeCampaignResponse) => any;
524
-
525
- export declare const GetCampaignStateRequestFilterSensitiveLog: (obj: GetCampaignStateRequest) => any;
526
-
527
- export declare const GetCampaignStateResponseFilterSensitiveLog: (obj: GetCampaignStateResponse) => any;
528
-
529
- export declare const GetCampaignStateBatchRequestFilterSensitiveLog: (obj: GetCampaignStateBatchRequest) => any;
530
-
531
- export declare const FailedCampaignStateResponseFilterSensitiveLog: (obj: FailedCampaignStateResponse) => any;
532
-
533
- export declare const SuccessfulCampaignStateResponseFilterSensitiveLog: (obj: SuccessfulCampaignStateResponse) => any;
534
-
535
- export declare const GetCampaignStateBatchResponseFilterSensitiveLog: (obj: GetCampaignStateBatchResponse) => any;
536
-
537
- export declare const GetConnectInstanceConfigRequestFilterSensitiveLog: (obj: GetConnectInstanceConfigRequest) => any;
538
-
539
- export declare const EncryptionConfigFilterSensitiveLog: (obj: EncryptionConfig) => any;
540
-
541
- export declare const InstanceConfigFilterSensitiveLog: (obj: InstanceConfig) => any;
542
-
543
- export declare const GetConnectInstanceConfigResponseFilterSensitiveLog: (obj: GetConnectInstanceConfigResponse) => any;
544
-
545
- export declare const GetInstanceOnboardingJobStatusRequestFilterSensitiveLog: (obj: GetInstanceOnboardingJobStatusRequest) => any;
546
-
547
- export declare const InstanceOnboardingJobStatusFilterSensitiveLog: (obj: InstanceOnboardingJobStatus) => any;
548
-
549
- export declare const GetInstanceOnboardingJobStatusResponseFilterSensitiveLog: (obj: GetInstanceOnboardingJobStatusResponse) => any;
550
-
551
- export declare const InstanceIdFilterFilterSensitiveLog: (obj: InstanceIdFilter) => any;
552
-
553
- export declare const CampaignFiltersFilterSensitiveLog: (obj: CampaignFilters) => any;
554
-
555
- export declare const ListCampaignsRequestFilterSensitiveLog: (obj: ListCampaignsRequest) => any;
556
-
557
- export declare const CampaignSummaryFilterSensitiveLog: (obj: CampaignSummary) => any;
558
-
559
- export declare const ListCampaignsResponseFilterSensitiveLog: (obj: ListCampaignsResponse) => any;
560
-
561
- export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
562
-
563
- export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
564
-
565
- export declare const PauseCampaignRequestFilterSensitiveLog: (obj: PauseCampaignRequest) => any;
566
-
567
- export declare const DialRequestFilterSensitiveLog: (obj: DialRequest) => any;
568
-
569
- export declare const PutDialRequestBatchRequestFilterSensitiveLog: (obj: PutDialRequestBatchRequest) => any;
570
-
571
- export declare const FailedRequestFilterSensitiveLog: (obj: FailedRequest) => any;
572
-
573
- export declare const SuccessfulRequestFilterSensitiveLog: (obj: SuccessfulRequest) => any;
574
-
575
- export declare const PutDialRequestBatchResponseFilterSensitiveLog: (obj: PutDialRequestBatchResponse) => any;
576
-
577
- export declare const ResumeCampaignRequestFilterSensitiveLog: (obj: ResumeCampaignRequest) => any;
578
-
579
- export declare const StartCampaignRequestFilterSensitiveLog: (obj: StartCampaignRequest) => any;
580
-
581
- export declare const StartInstanceOnboardingJobRequestFilterSensitiveLog: (obj: StartInstanceOnboardingJobRequest) => any;
582
-
583
- export declare const StartInstanceOnboardingJobResponseFilterSensitiveLog: (obj: StartInstanceOnboardingJobResponse) => any;
584
-
585
- export declare const StopCampaignRequestFilterSensitiveLog: (obj: StopCampaignRequest) => any;
586
-
587
- export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
588
-
589
- export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
590
-
591
- export declare const UpdateCampaignDialerConfigRequestFilterSensitiveLog: (obj: UpdateCampaignDialerConfigRequest) => any;
592
-
593
- export declare const UpdateCampaignNameRequestFilterSensitiveLog: (obj: UpdateCampaignNameRequest) => any;
594
-
595
- export declare const UpdateCampaignOutboundCallConfigRequestFilterSensitiveLog: (obj: UpdateCampaignOutboundCallConfigRequest) => any;
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { ConnectCampaignsServiceException as __BaseException } from "./ConnectCampaignsServiceException";
3
+
4
+ export declare class AccessDeniedException extends __BaseException {
5
+ readonly name: "AccessDeniedException";
6
+ readonly $fault: "client";
7
+
8
+ xAmzErrorType?: string;
9
+
10
+ constructor(
11
+ opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
12
+ );
13
+ }
14
+
15
+ export declare class ConflictException extends __BaseException {
16
+ readonly name: "ConflictException";
17
+ readonly $fault: "client";
18
+
19
+ xAmzErrorType?: string;
20
+
21
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
22
+ }
23
+
24
+ export interface PredictiveDialerConfig {
25
+ bandwidthAllocation: number | undefined;
26
+ }
27
+
28
+ export interface ProgressiveDialerConfig {
29
+ bandwidthAllocation: number | undefined;
30
+ }
31
+
32
+ export declare type DialerConfig =
33
+ | DialerConfig.PredictiveDialerConfigMember
34
+ | DialerConfig.ProgressiveDialerConfigMember
35
+ | DialerConfig.$UnknownMember;
36
+ export declare namespace DialerConfig {
37
+ interface ProgressiveDialerConfigMember {
38
+ progressiveDialerConfig: ProgressiveDialerConfig;
39
+ predictiveDialerConfig?: never;
40
+ $unknown?: never;
41
+ }
42
+
43
+ interface PredictiveDialerConfigMember {
44
+ progressiveDialerConfig?: never;
45
+ predictiveDialerConfig: PredictiveDialerConfig;
46
+ $unknown?: never;
47
+ }
48
+ interface $UnknownMember {
49
+ progressiveDialerConfig?: never;
50
+ predictiveDialerConfig?: never;
51
+ $unknown: [string, any];
52
+ }
53
+ interface Visitor<T> {
54
+ progressiveDialerConfig: (value: ProgressiveDialerConfig) => T;
55
+ predictiveDialerConfig: (value: PredictiveDialerConfig) => T;
56
+ _: (name: string, value: any) => T;
57
+ }
58
+ const visit: <T>(value: DialerConfig, visitor: Visitor<T>) => T;
59
+ }
60
+
61
+ export interface AnswerMachineDetectionConfig {
62
+ enableAnswerMachineDetection: boolean | undefined;
63
+ }
64
+
65
+ export interface OutboundCallConfig {
66
+ connectContactFlowId: string | undefined;
67
+
68
+ connectSourcePhoneNumber?: string;
69
+
70
+ connectQueueId: string | undefined;
71
+
72
+ answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
73
+ }
74
+
75
+ export interface CreateCampaignRequest {
76
+ name: string | undefined;
77
+
78
+ connectInstanceId: string | undefined;
79
+
80
+ dialerConfig: DialerConfig | undefined;
81
+
82
+ outboundCallConfig: OutboundCallConfig | undefined;
83
+
84
+ tags?: Record<string, string>;
85
+ }
86
+
87
+ export interface CreateCampaignResponse {
88
+ id?: string;
89
+
90
+ arn?: string;
91
+
92
+ tags?: Record<string, string>;
93
+ }
94
+
95
+ export declare class InternalServerException extends __BaseException {
96
+ readonly name: "InternalServerException";
97
+ readonly $fault: "server";
98
+ $retryable: {};
99
+
100
+ xAmzErrorType?: string;
101
+
102
+ constructor(
103
+ opts: __ExceptionOptionType<InternalServerException, __BaseException>
104
+ );
105
+ }
106
+
107
+ export declare class ResourceNotFoundException extends __BaseException {
108
+ readonly name: "ResourceNotFoundException";
109
+ readonly $fault: "client";
110
+
111
+ xAmzErrorType?: string;
112
+
113
+ constructor(
114
+ opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
115
+ );
116
+ }
117
+
118
+ export declare class ServiceQuotaExceededException extends __BaseException {
119
+ readonly name: "ServiceQuotaExceededException";
120
+ readonly $fault: "client";
121
+
122
+ xAmzErrorType?: string;
123
+
124
+ constructor(
125
+ opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
126
+ );
127
+ }
128
+
129
+ export declare class ThrottlingException extends __BaseException {
130
+ readonly name: "ThrottlingException";
131
+ readonly $fault: "client";
132
+ $retryable: {};
133
+
134
+ xAmzErrorType?: string;
135
+
136
+ constructor(
137
+ opts: __ExceptionOptionType<ThrottlingException, __BaseException>
138
+ );
139
+ }
140
+
141
+ export declare class ValidationException extends __BaseException {
142
+ readonly name: "ValidationException";
143
+ readonly $fault: "client";
144
+
145
+ xAmzErrorType?: string;
146
+
147
+ constructor(
148
+ opts: __ExceptionOptionType<ValidationException, __BaseException>
149
+ );
150
+ }
151
+
152
+ export interface DeleteCampaignRequest {
153
+ id: string | undefined;
154
+ }
155
+
156
+ export interface DeleteConnectInstanceConfigRequest {
157
+ connectInstanceId: string | undefined;
158
+ }
159
+
160
+ export declare class InvalidStateException extends __BaseException {
161
+ readonly name: "InvalidStateException";
162
+ readonly $fault: "client";
163
+
164
+ xAmzErrorType?: string;
165
+
166
+ constructor(
167
+ opts: __ExceptionOptionType<InvalidStateException, __BaseException>
168
+ );
169
+ }
170
+
171
+ export interface DeleteInstanceOnboardingJobRequest {
172
+ connectInstanceId: string | undefined;
173
+ }
174
+
175
+ export interface DescribeCampaignRequest {
176
+ id: string | undefined;
177
+ }
178
+
179
+ export interface Campaign {
180
+ id: string | undefined;
181
+
182
+ arn: string | undefined;
183
+
184
+ name: string | undefined;
185
+
186
+ connectInstanceId: string | undefined;
187
+
188
+ dialerConfig: DialerConfig | undefined;
189
+
190
+ outboundCallConfig: OutboundCallConfig | undefined;
191
+
192
+ tags?: Record<string, string>;
193
+ }
194
+
195
+ export interface DescribeCampaignResponse {
196
+ campaign?: Campaign;
197
+ }
198
+
199
+ export interface GetCampaignStateRequest {
200
+ id: string | undefined;
201
+ }
202
+ export declare enum CampaignState {
203
+ FAILED = "Failed",
204
+
205
+ INITIALIZED = "Initialized",
206
+
207
+ PAUSED = "Paused",
208
+
209
+ RUNNING = "Running",
210
+
211
+ STOPPED = "Stopped",
212
+ }
213
+
214
+ export interface GetCampaignStateResponse {
215
+ state?: CampaignState | string;
216
+ }
217
+
218
+ export interface GetCampaignStateBatchRequest {
219
+ campaignIds: string[] | undefined;
220
+ }
221
+ export declare enum GetCampaignStateBatchFailureCode {
222
+ RESOURCE_NOT_FOUND = "ResourceNotFound",
223
+
224
+ UNKNOWN_ERROR = "UnknownError",
225
+ }
226
+
227
+ export interface FailedCampaignStateResponse {
228
+ campaignId?: string;
229
+
230
+ failureCode?: GetCampaignStateBatchFailureCode | string;
231
+ }
232
+
233
+ export interface SuccessfulCampaignStateResponse {
234
+ campaignId?: string;
235
+
236
+ state?: CampaignState | string;
237
+ }
238
+
239
+ export interface GetCampaignStateBatchResponse {
240
+ successfulRequests?: SuccessfulCampaignStateResponse[];
241
+
242
+ failedRequests?: FailedCampaignStateResponse[];
243
+ }
244
+
245
+ export interface GetConnectInstanceConfigRequest {
246
+ connectInstanceId: string | undefined;
247
+ }
248
+ export declare enum EncryptionType {
249
+ KMS = "KMS",
250
+ }
251
+
252
+ export interface EncryptionConfig {
253
+ enabled: boolean | undefined;
254
+
255
+ encryptionType?: EncryptionType | string;
256
+
257
+ keyArn?: string;
258
+ }
259
+
260
+ export interface InstanceConfig {
261
+ connectInstanceId: string | undefined;
262
+
263
+ serviceLinkedRoleArn: string | undefined;
264
+
265
+ encryptionConfig: EncryptionConfig | undefined;
266
+ }
267
+
268
+ export interface GetConnectInstanceConfigResponse {
269
+ connectInstanceConfig?: InstanceConfig;
270
+ }
271
+
272
+ export interface GetInstanceOnboardingJobStatusRequest {
273
+ connectInstanceId: string | undefined;
274
+ }
275
+ export declare enum InstanceOnboardingJobFailureCode {
276
+ EVENT_BRIDGE_ACCESS_DENIED = "EVENT_BRIDGE_ACCESS_DENIED",
277
+ EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED = "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
278
+ IAM_ACCESS_DENIED = "IAM_ACCESS_DENIED",
279
+ INTERNAL_FAILURE = "INTERNAL_FAILURE",
280
+ KMS_ACCESS_DENIED = "KMS_ACCESS_DENIED",
281
+ KMS_KEY_NOT_FOUND = "KMS_KEY_NOT_FOUND",
282
+ }
283
+ export declare enum InstanceOnboardingJobStatusCode {
284
+ FAILED = "FAILED",
285
+ IN_PROGRESS = "IN_PROGRESS",
286
+ SUCCEEDED = "SUCCEEDED",
287
+ }
288
+
289
+ export interface InstanceOnboardingJobStatus {
290
+ connectInstanceId: string | undefined;
291
+
292
+ status: InstanceOnboardingJobStatusCode | string | undefined;
293
+
294
+ failureCode?: InstanceOnboardingJobFailureCode | string;
295
+ }
296
+
297
+ export interface GetInstanceOnboardingJobStatusResponse {
298
+ connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
299
+ }
300
+ export declare enum InstanceIdFilterOperator {
301
+ EQ = "Eq",
302
+ }
303
+
304
+ export interface InstanceIdFilter {
305
+ value: string | undefined;
306
+
307
+ operator: InstanceIdFilterOperator | string | undefined;
308
+ }
309
+
310
+ export interface CampaignFilters {
311
+ instanceIdFilter?: InstanceIdFilter;
312
+ }
313
+
314
+ export interface ListCampaignsRequest {
315
+ maxResults?: number;
316
+
317
+ nextToken?: string;
318
+
319
+ filters?: CampaignFilters;
320
+ }
321
+
322
+ export interface CampaignSummary {
323
+ id: string | undefined;
324
+
325
+ arn: string | undefined;
326
+
327
+ name: string | undefined;
328
+
329
+ connectInstanceId: string | undefined;
330
+ }
331
+
332
+ export interface ListCampaignsResponse {
333
+ nextToken?: string;
334
+
335
+ campaignSummaryList?: CampaignSummary[];
336
+ }
337
+
338
+ export interface ListTagsForResourceRequest {
339
+ arn: string | undefined;
340
+ }
341
+
342
+ export interface ListTagsForResourceResponse {
343
+ tags?: Record<string, string>;
344
+ }
345
+
346
+ export declare class InvalidCampaignStateException extends __BaseException {
347
+ readonly name: "InvalidCampaignStateException";
348
+ readonly $fault: "client";
349
+
350
+ state: CampaignState | string | undefined;
351
+
352
+ xAmzErrorType?: string;
353
+
354
+ constructor(
355
+ opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>
356
+ );
357
+ }
358
+
359
+ export interface PauseCampaignRequest {
360
+ id: string | undefined;
361
+ }
362
+
363
+ export interface DialRequest {
364
+ clientToken: string | undefined;
365
+
366
+ phoneNumber: string | undefined;
367
+
368
+ expirationTime: Date | undefined;
369
+
370
+ attributes: Record<string, string> | undefined;
371
+ }
372
+
373
+ export interface PutDialRequestBatchRequest {
374
+ id: string | undefined;
375
+
376
+ dialRequests: DialRequest[] | undefined;
377
+ }
378
+ export declare enum FailureCode {
379
+ INVALID_INPUT = "InvalidInput",
380
+
381
+ REQUEST_THROTTLED = "RequestThrottled",
382
+
383
+ UNKNOWN_ERROR = "UnknownError",
384
+ }
385
+
386
+ export interface FailedRequest {
387
+ clientToken?: string;
388
+
389
+ id?: string;
390
+
391
+ failureCode?: FailureCode | string;
392
+ }
393
+
394
+ export interface SuccessfulRequest {
395
+ clientToken?: string;
396
+
397
+ id?: string;
398
+ }
399
+
400
+ export interface PutDialRequestBatchResponse {
401
+ successfulRequests?: SuccessfulRequest[];
402
+
403
+ failedRequests?: FailedRequest[];
404
+ }
405
+
406
+ export interface ResumeCampaignRequest {
407
+ id: string | undefined;
408
+ }
409
+
410
+ export interface StartCampaignRequest {
411
+ id: string | undefined;
412
+ }
413
+
414
+ export interface StartInstanceOnboardingJobRequest {
415
+ connectInstanceId: string | undefined;
416
+
417
+ encryptionConfig: EncryptionConfig | undefined;
418
+ }
419
+
420
+ export interface StartInstanceOnboardingJobResponse {
421
+ connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
422
+ }
423
+
424
+ export interface StopCampaignRequest {
425
+ id: string | undefined;
426
+ }
427
+
428
+ export interface TagResourceRequest {
429
+ arn: string | undefined;
430
+
431
+ tags: Record<string, string> | undefined;
432
+ }
433
+
434
+ export interface UntagResourceRequest {
435
+ arn: string | undefined;
436
+
437
+ tagKeys: string[] | undefined;
438
+ }
439
+
440
+ export interface UpdateCampaignDialerConfigRequest {
441
+ id: string | undefined;
442
+
443
+ dialerConfig: DialerConfig | undefined;
444
+ }
445
+
446
+ export interface UpdateCampaignNameRequest {
447
+ id: string | undefined;
448
+
449
+ name: string | undefined;
450
+ }
451
+
452
+ export interface UpdateCampaignOutboundCallConfigRequest {
453
+ id: string | undefined;
454
+
455
+ connectContactFlowId?: string;
456
+
457
+ connectSourcePhoneNumber?: string;
458
+
459
+ answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
460
+ }
461
+
462
+ export declare const PredictiveDialerConfigFilterSensitiveLog: (
463
+ obj: PredictiveDialerConfig
464
+ ) => any;
465
+
466
+ export declare const ProgressiveDialerConfigFilterSensitiveLog: (
467
+ obj: ProgressiveDialerConfig
468
+ ) => any;
469
+
470
+ export declare const DialerConfigFilterSensitiveLog: (obj: DialerConfig) => any;
471
+
472
+ export declare const AnswerMachineDetectionConfigFilterSensitiveLog: (
473
+ obj: AnswerMachineDetectionConfig
474
+ ) => any;
475
+
476
+ export declare const OutboundCallConfigFilterSensitiveLog: (
477
+ obj: OutboundCallConfig
478
+ ) => any;
479
+
480
+ export declare const CreateCampaignRequestFilterSensitiveLog: (
481
+ obj: CreateCampaignRequest
482
+ ) => any;
483
+
484
+ export declare const CreateCampaignResponseFilterSensitiveLog: (
485
+ obj: CreateCampaignResponse
486
+ ) => any;
487
+
488
+ export declare const DeleteCampaignRequestFilterSensitiveLog: (
489
+ obj: DeleteCampaignRequest
490
+ ) => any;
491
+
492
+ export declare const DeleteConnectInstanceConfigRequestFilterSensitiveLog: (
493
+ obj: DeleteConnectInstanceConfigRequest
494
+ ) => any;
495
+
496
+ export declare const DeleteInstanceOnboardingJobRequestFilterSensitiveLog: (
497
+ obj: DeleteInstanceOnboardingJobRequest
498
+ ) => any;
499
+
500
+ export declare const DescribeCampaignRequestFilterSensitiveLog: (
501
+ obj: DescribeCampaignRequest
502
+ ) => any;
503
+
504
+ export declare const CampaignFilterSensitiveLog: (obj: Campaign) => any;
505
+
506
+ export declare const DescribeCampaignResponseFilterSensitiveLog: (
507
+ obj: DescribeCampaignResponse
508
+ ) => any;
509
+
510
+ export declare const GetCampaignStateRequestFilterSensitiveLog: (
511
+ obj: GetCampaignStateRequest
512
+ ) => any;
513
+
514
+ export declare const GetCampaignStateResponseFilterSensitiveLog: (
515
+ obj: GetCampaignStateResponse
516
+ ) => any;
517
+
518
+ export declare const GetCampaignStateBatchRequestFilterSensitiveLog: (
519
+ obj: GetCampaignStateBatchRequest
520
+ ) => any;
521
+
522
+ export declare const FailedCampaignStateResponseFilterSensitiveLog: (
523
+ obj: FailedCampaignStateResponse
524
+ ) => any;
525
+
526
+ export declare const SuccessfulCampaignStateResponseFilterSensitiveLog: (
527
+ obj: SuccessfulCampaignStateResponse
528
+ ) => any;
529
+
530
+ export declare const GetCampaignStateBatchResponseFilterSensitiveLog: (
531
+ obj: GetCampaignStateBatchResponse
532
+ ) => any;
533
+
534
+ export declare const GetConnectInstanceConfigRequestFilterSensitiveLog: (
535
+ obj: GetConnectInstanceConfigRequest
536
+ ) => any;
537
+
538
+ export declare const EncryptionConfigFilterSensitiveLog: (
539
+ obj: EncryptionConfig
540
+ ) => any;
541
+
542
+ export declare const InstanceConfigFilterSensitiveLog: (
543
+ obj: InstanceConfig
544
+ ) => any;
545
+
546
+ export declare const GetConnectInstanceConfigResponseFilterSensitiveLog: (
547
+ obj: GetConnectInstanceConfigResponse
548
+ ) => any;
549
+
550
+ export declare const GetInstanceOnboardingJobStatusRequestFilterSensitiveLog: (
551
+ obj: GetInstanceOnboardingJobStatusRequest
552
+ ) => any;
553
+
554
+ export declare const InstanceOnboardingJobStatusFilterSensitiveLog: (
555
+ obj: InstanceOnboardingJobStatus
556
+ ) => any;
557
+
558
+ export declare const GetInstanceOnboardingJobStatusResponseFilterSensitiveLog: (
559
+ obj: GetInstanceOnboardingJobStatusResponse
560
+ ) => any;
561
+
562
+ export declare const InstanceIdFilterFilterSensitiveLog: (
563
+ obj: InstanceIdFilter
564
+ ) => any;
565
+
566
+ export declare const CampaignFiltersFilterSensitiveLog: (
567
+ obj: CampaignFilters
568
+ ) => any;
569
+
570
+ export declare const ListCampaignsRequestFilterSensitiveLog: (
571
+ obj: ListCampaignsRequest
572
+ ) => any;
573
+
574
+ export declare const CampaignSummaryFilterSensitiveLog: (
575
+ obj: CampaignSummary
576
+ ) => any;
577
+
578
+ export declare const ListCampaignsResponseFilterSensitiveLog: (
579
+ obj: ListCampaignsResponse
580
+ ) => any;
581
+
582
+ export declare const ListTagsForResourceRequestFilterSensitiveLog: (
583
+ obj: ListTagsForResourceRequest
584
+ ) => any;
585
+
586
+ export declare const ListTagsForResourceResponseFilterSensitiveLog: (
587
+ obj: ListTagsForResourceResponse
588
+ ) => any;
589
+
590
+ export declare const PauseCampaignRequestFilterSensitiveLog: (
591
+ obj: PauseCampaignRequest
592
+ ) => any;
593
+
594
+ export declare const DialRequestFilterSensitiveLog: (obj: DialRequest) => any;
595
+
596
+ export declare const PutDialRequestBatchRequestFilterSensitiveLog: (
597
+ obj: PutDialRequestBatchRequest
598
+ ) => any;
599
+
600
+ export declare const FailedRequestFilterSensitiveLog: (
601
+ obj: FailedRequest
602
+ ) => any;
603
+
604
+ export declare const SuccessfulRequestFilterSensitiveLog: (
605
+ obj: SuccessfulRequest
606
+ ) => any;
607
+
608
+ export declare const PutDialRequestBatchResponseFilterSensitiveLog: (
609
+ obj: PutDialRequestBatchResponse
610
+ ) => any;
611
+
612
+ export declare const ResumeCampaignRequestFilterSensitiveLog: (
613
+ obj: ResumeCampaignRequest
614
+ ) => any;
615
+
616
+ export declare const StartCampaignRequestFilterSensitiveLog: (
617
+ obj: StartCampaignRequest
618
+ ) => any;
619
+
620
+ export declare const StartInstanceOnboardingJobRequestFilterSensitiveLog: (
621
+ obj: StartInstanceOnboardingJobRequest
622
+ ) => any;
623
+
624
+ export declare const StartInstanceOnboardingJobResponseFilterSensitiveLog: (
625
+ obj: StartInstanceOnboardingJobResponse
626
+ ) => any;
627
+
628
+ export declare const StopCampaignRequestFilterSensitiveLog: (
629
+ obj: StopCampaignRequest
630
+ ) => any;
631
+
632
+ export declare const TagResourceRequestFilterSensitiveLog: (
633
+ obj: TagResourceRequest
634
+ ) => any;
635
+
636
+ export declare const UntagResourceRequestFilterSensitiveLog: (
637
+ obj: UntagResourceRequest
638
+ ) => any;
639
+
640
+ export declare const UpdateCampaignDialerConfigRequestFilterSensitiveLog: (
641
+ obj: UpdateCampaignDialerConfigRequest
642
+ ) => any;
643
+
644
+ export declare const UpdateCampaignNameRequestFilterSensitiveLog: (
645
+ obj: UpdateCampaignNameRequest
646
+ ) => any;
647
+
648
+ export declare const UpdateCampaignOutboundCallConfigRequestFilterSensitiveLog: (
649
+ obj: UpdateCampaignOutboundCallConfigRequest
650
+ ) => any;