@aws-sdk/client-connectcampaigns 3.533.0 → 3.540.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 (55) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/ConnectCampaigns.d.ts +2 -1
  6. package/dist-types/ConnectCampaignsClient.d.ts +1 -1
  7. package/dist-types/commands/CreateCampaignCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteCampaignCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteConnectInstanceConfigCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteInstanceOnboardingJobCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeCampaignCommand.d.ts +2 -1
  12. package/dist-types/commands/GetCampaignStateBatchCommand.d.ts +2 -1
  13. package/dist-types/commands/GetCampaignStateCommand.d.ts +2 -1
  14. package/dist-types/commands/GetConnectInstanceConfigCommand.d.ts +2 -1
  15. package/dist-types/commands/GetInstanceOnboardingJobStatusCommand.d.ts +2 -1
  16. package/dist-types/commands/ListCampaignsCommand.d.ts +2 -1
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  18. package/dist-types/commands/PauseCampaignCommand.d.ts +2 -1
  19. package/dist-types/commands/PutDialRequestBatchCommand.d.ts +2 -1
  20. package/dist-types/commands/ResumeCampaignCommand.d.ts +2 -1
  21. package/dist-types/commands/StartCampaignCommand.d.ts +2 -1
  22. package/dist-types/commands/StartInstanceOnboardingJobCommand.d.ts +2 -1
  23. package/dist-types/commands/StopCampaignCommand.d.ts +2 -1
  24. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  25. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  26. package/dist-types/commands/UpdateCampaignDialerConfigCommand.d.ts +2 -1
  27. package/dist-types/commands/UpdateCampaignNameCommand.d.ts +2 -1
  28. package/dist-types/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +2 -1
  29. package/dist-types/index.d.ts +0 -1
  30. package/dist-types/models/models_0.d.ts +170 -170
  31. package/dist-types/ts3.4/ConnectCampaigns.d.ts +1 -0
  32. package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/DeleteConnectInstanceConfigCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/DeleteInstanceOnboardingJobCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/GetCampaignStateBatchCommand.d.ts +9 -0
  38. package/dist-types/ts3.4/commands/GetCampaignStateCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/GetConnectInstanceConfigCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/GetInstanceOnboardingJobStatusCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/PauseCampaignCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/PutDialRequestBatchCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/ResumeCampaignCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/StartCampaignCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/StartInstanceOnboardingJobCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/StopCampaignCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/UpdateCampaignDialerConfigCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/UpdateCampaignNameCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/UpdateCampaignOutboundCallConfigCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/index.d.ts +0 -1
  55. package/package.json +40 -40
@@ -1,15 +1,15 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectCampaignsServiceException as __BaseException } from "./ConnectCampaignsServiceException";
3
3
  /**
4
- * @public
5
4
  * You do not have sufficient access to perform this action.
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
9
9
  readonly $fault: "client";
10
10
  /**
11
- * @public
12
11
  * A header that defines the error encountered while processing the request.
12
+ * @public
13
13
  */
14
14
  xAmzErrorType?: string;
15
15
  /**
@@ -18,26 +18,26 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
19
19
  }
20
20
  /**
21
- * @public
22
21
  * Agentless Dialer config
22
+ * @public
23
23
  */
24
24
  export interface AgentlessDialerConfig {
25
25
  /**
26
- * @public
27
26
  * Allocates dialing capacity for this campaign between multiple active campaigns
27
+ * @public
28
28
  */
29
29
  dialingCapacity?: number;
30
30
  }
31
31
  /**
32
- * @public
33
32
  * The request could not be processed because of conflict in the current state of the resource.
33
+ * @public
34
34
  */
35
35
  export declare class ConflictException extends __BaseException {
36
36
  readonly name: "ConflictException";
37
37
  readonly $fault: "client";
38
38
  /**
39
- * @public
40
39
  * A header that defines the error encountered while processing the request.
40
+ * @public
41
41
  */
42
42
  xAmzErrorType?: string;
43
43
  /**
@@ -46,40 +46,40 @@ export declare class ConflictException extends __BaseException {
46
46
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
47
47
  }
48
48
  /**
49
- * @public
50
49
  * Predictive Dialer config
50
+ * @public
51
51
  */
52
52
  export interface PredictiveDialerConfig {
53
53
  /**
54
- * @public
55
54
  * The bandwidth allocation of a queue resource.
55
+ * @public
56
56
  */
57
57
  bandwidthAllocation: number | undefined;
58
58
  /**
59
- * @public
60
59
  * Allocates dialing capacity for this campaign between multiple active campaigns
60
+ * @public
61
61
  */
62
62
  dialingCapacity?: number;
63
63
  }
64
64
  /**
65
- * @public
66
65
  * Progressive Dialer config
66
+ * @public
67
67
  */
68
68
  export interface ProgressiveDialerConfig {
69
69
  /**
70
- * @public
71
70
  * The bandwidth allocation of a queue resource.
71
+ * @public
72
72
  */
73
73
  bandwidthAllocation: number | undefined;
74
74
  /**
75
- * @public
76
75
  * Allocates dialing capacity for this campaign between multiple active campaigns
76
+ * @public
77
77
  */
78
78
  dialingCapacity?: number;
79
79
  }
80
80
  /**
81
- * @public
82
81
  * The possible types of dialer config parameters
82
+ * @public
83
83
  */
84
84
  export type DialerConfig = DialerConfig.AgentlessDialerConfigMember | DialerConfig.PredictiveDialerConfigMember | DialerConfig.ProgressiveDialerConfigMember | DialerConfig.$UnknownMember;
85
85
  /**
@@ -87,8 +87,8 @@ export type DialerConfig = DialerConfig.AgentlessDialerConfigMember | DialerConf
87
87
  */
88
88
  export declare namespace DialerConfig {
89
89
  /**
90
- * @public
91
90
  * Progressive Dialer config
91
+ * @public
92
92
  */
93
93
  interface ProgressiveDialerConfigMember {
94
94
  progressiveDialerConfig: ProgressiveDialerConfig;
@@ -97,8 +97,8 @@ export declare namespace DialerConfig {
97
97
  $unknown?: never;
98
98
  }
99
99
  /**
100
- * @public
101
100
  * Predictive Dialer config
101
+ * @public
102
102
  */
103
103
  interface PredictiveDialerConfigMember {
104
104
  progressiveDialerConfig?: never;
@@ -107,8 +107,8 @@ export declare namespace DialerConfig {
107
107
  $unknown?: never;
108
108
  }
109
109
  /**
110
- * @public
111
110
  * Agentless Dialer config
111
+ * @public
112
112
  */
113
113
  interface AgentlessDialerConfigMember {
114
114
  progressiveDialerConfig?: never;
@@ -134,105 +134,105 @@ export declare namespace DialerConfig {
134
134
  const visit: <T>(value: DialerConfig, visitor: Visitor<T>) => T;
135
135
  }
136
136
  /**
137
- * @public
138
137
  * Answering Machine Detection config
138
+ * @public
139
139
  */
140
140
  export interface AnswerMachineDetectionConfig {
141
141
  /**
142
- * @public
143
142
  * Enable or disable answering machine detection
143
+ * @public
144
144
  */
145
145
  enableAnswerMachineDetection: boolean | undefined;
146
146
  }
147
147
  /**
148
- * @public
149
148
  * The configuration used for outbound calls.
149
+ * @public
150
150
  */
151
151
  export interface OutboundCallConfig {
152
152
  /**
153
- * @public
154
153
  * The identifier of the contact flow for the outbound call.
154
+ * @public
155
155
  */
156
156
  connectContactFlowId: string | undefined;
157
157
  /**
158
- * @public
159
158
  * 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.
159
+ * @public
160
160
  */
161
161
  connectSourcePhoneNumber?: string;
162
162
  /**
163
- * @public
164
163
  * 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.
164
+ * @public
165
165
  */
166
166
  connectQueueId?: string;
167
167
  /**
168
- * @public
169
168
  * Answering Machine Detection config
169
+ * @public
170
170
  */
171
171
  answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
172
172
  }
173
173
  /**
174
- * @public
175
174
  * The request for Create Campaign API.
175
+ * @public
176
176
  */
177
177
  export interface CreateCampaignRequest {
178
178
  /**
179
- * @public
180
179
  * The name of an Amazon Connect Campaign name.
180
+ * @public
181
181
  */
182
182
  name: string | undefined;
183
183
  /**
184
- * @public
185
184
  * Amazon Connect Instance Id
185
+ * @public
186
186
  */
187
187
  connectInstanceId: string | undefined;
188
188
  /**
189
- * @public
190
189
  * The possible types of dialer config parameters
190
+ * @public
191
191
  */
192
192
  dialerConfig: DialerConfig | undefined;
193
193
  /**
194
- * @public
195
194
  * The configuration used for outbound calls.
195
+ * @public
196
196
  */
197
197
  outboundCallConfig: OutboundCallConfig | undefined;
198
198
  /**
199
- * @public
200
199
  * Tag map with key and value.
200
+ * @public
201
201
  */
202
202
  tags?: Record<string, string>;
203
203
  }
204
204
  /**
205
- * @public
206
205
  * The response for Create Campaign API
206
+ * @public
207
207
  */
208
208
  export interface CreateCampaignResponse {
209
209
  /**
210
- * @public
211
210
  * Identifier representing a Campaign
211
+ * @public
212
212
  */
213
213
  id?: string;
214
214
  /**
215
- * @public
216
215
  * The resource name of an Amazon Connect campaign.
216
+ * @public
217
217
  */
218
218
  arn?: string;
219
219
  /**
220
- * @public
221
220
  * Tag map with key and value.
221
+ * @public
222
222
  */
223
223
  tags?: Record<string, string>;
224
224
  }
225
225
  /**
226
- * @public
227
226
  * Request processing failed because of an error or failure with the service.
227
+ * @public
228
228
  */
229
229
  export declare class InternalServerException extends __BaseException {
230
230
  readonly name: "InternalServerException";
231
231
  readonly $fault: "server";
232
232
  $retryable: {};
233
233
  /**
234
- * @public
235
234
  * A header that defines the error encountered while processing the request.
235
+ * @public
236
236
  */
237
237
  xAmzErrorType?: string;
238
238
  /**
@@ -241,15 +241,15 @@ export declare class InternalServerException extends __BaseException {
241
241
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
242
242
  }
243
243
  /**
244
- * @public
245
244
  * The specified resource was not found.
245
+ * @public
246
246
  */
247
247
  export declare class ResourceNotFoundException extends __BaseException {
248
248
  readonly name: "ResourceNotFoundException";
249
249
  readonly $fault: "client";
250
250
  /**
251
- * @public
252
251
  * A header that defines the error encountered while processing the request.
252
+ * @public
253
253
  */
254
254
  xAmzErrorType?: string;
255
255
  /**
@@ -258,15 +258,15 @@ export declare class ResourceNotFoundException extends __BaseException {
258
258
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
259
259
  }
260
260
  /**
261
- * @public
262
261
  * Request would cause a service quota to be exceeded.
262
+ * @public
263
263
  */
264
264
  export declare class ServiceQuotaExceededException extends __BaseException {
265
265
  readonly name: "ServiceQuotaExceededException";
266
266
  readonly $fault: "client";
267
267
  /**
268
- * @public
269
268
  * A header that defines the error encountered while processing the request.
269
+ * @public
270
270
  */
271
271
  xAmzErrorType?: string;
272
272
  /**
@@ -275,16 +275,16 @@ export declare class ServiceQuotaExceededException extends __BaseException {
275
275
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
276
276
  }
277
277
  /**
278
- * @public
279
278
  * The request was denied due to request throttling.
279
+ * @public
280
280
  */
281
281
  export declare class ThrottlingException extends __BaseException {
282
282
  readonly name: "ThrottlingException";
283
283
  readonly $fault: "client";
284
284
  $retryable: {};
285
285
  /**
286
- * @public
287
286
  * A header that defines the error encountered while processing the request.
287
+ * @public
288
288
  */
289
289
  xAmzErrorType?: string;
290
290
  /**
@@ -293,15 +293,15 @@ export declare class ThrottlingException extends __BaseException {
293
293
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
294
294
  }
295
295
  /**
296
- * @public
297
296
  * The input fails to satisfy the constraints specified by an AWS service.
297
+ * @public
298
298
  */
299
299
  export declare class ValidationException extends __BaseException {
300
300
  readonly name: "ValidationException";
301
301
  readonly $fault: "client";
302
302
  /**
303
- * @public
304
303
  * A header that defines the error encountered while processing the request.
304
+ * @public
305
305
  */
306
306
  xAmzErrorType?: string;
307
307
  /**
@@ -310,37 +310,37 @@ export declare class ValidationException extends __BaseException {
310
310
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
311
311
  }
312
312
  /**
313
- * @public
314
313
  * DeleteCampaignRequest
314
+ * @public
315
315
  */
316
316
  export interface DeleteCampaignRequest {
317
317
  /**
318
- * @public
319
318
  * Identifier representing a Campaign
319
+ * @public
320
320
  */
321
321
  id: string | undefined;
322
322
  }
323
323
  /**
324
- * @public
325
324
  * DeleteCampaignRequest
325
+ * @public
326
326
  */
327
327
  export interface DeleteConnectInstanceConfigRequest {
328
328
  /**
329
- * @public
330
329
  * Amazon Connect Instance Id
330
+ * @public
331
331
  */
332
332
  connectInstanceId: string | undefined;
333
333
  }
334
334
  /**
335
- * @public
336
335
  * The request could not be processed because of conflict in the current state.
336
+ * @public
337
337
  */
338
338
  export declare class InvalidStateException extends __BaseException {
339
339
  readonly name: "InvalidStateException";
340
340
  readonly $fault: "client";
341
341
  /**
342
- * @public
343
342
  * A header that defines the error encountered while processing the request.
343
+ * @public
344
344
  */
345
345
  xAmzErrorType?: string;
346
346
  /**
@@ -349,87 +349,87 @@ export declare class InvalidStateException extends __BaseException {
349
349
  constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
350
350
  }
351
351
  /**
352
- * @public
353
352
  * The request for DeleteInstanceOnboardingJob API.
353
+ * @public
354
354
  */
355
355
  export interface DeleteInstanceOnboardingJobRequest {
356
356
  /**
357
- * @public
358
357
  * Amazon Connect Instance Id
358
+ * @public
359
359
  */
360
360
  connectInstanceId: string | undefined;
361
361
  }
362
362
  /**
363
- * @public
364
363
  * DescribeCampaignRequests
364
+ * @public
365
365
  */
366
366
  export interface DescribeCampaignRequest {
367
367
  /**
368
- * @public
369
368
  * Identifier representing a Campaign
369
+ * @public
370
370
  */
371
371
  id: string | undefined;
372
372
  }
373
373
  /**
374
- * @public
375
374
  * An Amazon Connect campaign.
375
+ * @public
376
376
  */
377
377
  export interface Campaign {
378
378
  /**
379
- * @public
380
379
  * Identifier representing a Campaign
380
+ * @public
381
381
  */
382
382
  id: string | undefined;
383
383
  /**
384
- * @public
385
384
  * The resource name of an Amazon Connect campaign.
385
+ * @public
386
386
  */
387
387
  arn: string | undefined;
388
388
  /**
389
- * @public
390
389
  * The name of an Amazon Connect Campaign name.
390
+ * @public
391
391
  */
392
392
  name: string | undefined;
393
393
  /**
394
- * @public
395
394
  * Amazon Connect Instance Id
395
+ * @public
396
396
  */
397
397
  connectInstanceId: string | undefined;
398
398
  /**
399
- * @public
400
399
  * The possible types of dialer config parameters
400
+ * @public
401
401
  */
402
402
  dialerConfig: DialerConfig | undefined;
403
403
  /**
404
- * @public
405
404
  * The configuration used for outbound calls.
405
+ * @public
406
406
  */
407
407
  outboundCallConfig: OutboundCallConfig | undefined;
408
408
  /**
409
- * @public
410
409
  * Tag map with key and value.
410
+ * @public
411
411
  */
412
412
  tags?: Record<string, string>;
413
413
  }
414
414
  /**
415
- * @public
416
415
  * DescribeCampaignResponse
416
+ * @public
417
417
  */
418
418
  export interface DescribeCampaignResponse {
419
419
  /**
420
- * @public
421
420
  * An Amazon Connect campaign.
421
+ * @public
422
422
  */
423
423
  campaign?: Campaign;
424
424
  }
425
425
  /**
426
- * @public
427
426
  * GetCampaignStateRequest
427
+ * @public
428
428
  */
429
429
  export interface GetCampaignStateRequest {
430
430
  /**
431
- * @public
432
431
  * Identifier representing a Campaign
432
+ * @public
433
433
  */
434
434
  id: string | undefined;
435
435
  }
@@ -464,24 +464,24 @@ export declare const CampaignState: {
464
464
  */
465
465
  export type CampaignState = (typeof CampaignState)[keyof typeof CampaignState];
466
466
  /**
467
- * @public
468
467
  * GetCampaignStateResponse
468
+ * @public
469
469
  */
470
470
  export interface GetCampaignStateResponse {
471
471
  /**
472
- * @public
473
472
  * State of a campaign
473
+ * @public
474
474
  */
475
475
  state?: CampaignState;
476
476
  }
477
477
  /**
478
- * @public
479
478
  * GetCampaignStateBatchRequest
479
+ * @public
480
480
  */
481
481
  export interface GetCampaignStateBatchRequest {
482
482
  /**
483
- * @public
484
483
  * List of CampaignId
484
+ * @public
485
485
  */
486
486
  campaignIds: string[] | undefined;
487
487
  }
@@ -504,61 +504,61 @@ export declare const GetCampaignStateBatchFailureCode: {
504
504
  */
505
505
  export type GetCampaignStateBatchFailureCode = (typeof GetCampaignStateBatchFailureCode)[keyof typeof GetCampaignStateBatchFailureCode];
506
506
  /**
507
- * @public
508
507
  * Failed response of campaign state
508
+ * @public
509
509
  */
510
510
  export interface FailedCampaignStateResponse {
511
511
  /**
512
- * @public
513
512
  * Identifier representing a Campaign
513
+ * @public
514
514
  */
515
515
  campaignId?: string;
516
516
  /**
517
- * @public
518
517
  * A predefined code indicating the error that caused the failure in getting state of campaigns
518
+ * @public
519
519
  */
520
520
  failureCode?: GetCampaignStateBatchFailureCode;
521
521
  }
522
522
  /**
523
- * @public
524
523
  * Successful response of campaign state
524
+ * @public
525
525
  */
526
526
  export interface SuccessfulCampaignStateResponse {
527
527
  /**
528
- * @public
529
528
  * Identifier representing a Campaign
529
+ * @public
530
530
  */
531
531
  campaignId?: string;
532
532
  /**
533
- * @public
534
533
  * State of a campaign
534
+ * @public
535
535
  */
536
536
  state?: CampaignState;
537
537
  }
538
538
  /**
539
- * @public
540
539
  * GetCampaignStateBatchResponse
540
+ * @public
541
541
  */
542
542
  export interface GetCampaignStateBatchResponse {
543
543
  /**
544
- * @public
545
544
  * List of successful response of campaign state
545
+ * @public
546
546
  */
547
547
  successfulRequests?: SuccessfulCampaignStateResponse[];
548
548
  /**
549
- * @public
550
549
  * List of failed requests of campaign state
550
+ * @public
551
551
  */
552
552
  failedRequests?: FailedCampaignStateResponse[];
553
553
  }
554
554
  /**
555
- * @public
556
555
  * GetConnectInstanceConfigRequest
556
+ * @public
557
557
  */
558
558
  export interface GetConnectInstanceConfigRequest {
559
559
  /**
560
- * @public
561
560
  * Amazon Connect Instance Id
561
+ * @public
562
562
  */
563
563
  connectInstanceId: string | undefined;
564
564
  }
@@ -574,72 +574,72 @@ export declare const EncryptionType: {
574
574
  */
575
575
  export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
576
576
  /**
577
- * @public
578
577
  * Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
579
578
  * If disabled, service will perform encryption with its own key.
580
579
  * If enabled, a KMS key id needs to be provided and KMS charges will apply.
581
580
  * KMS is only type supported
581
+ * @public
582
582
  */
583
583
  export interface EncryptionConfig {
584
584
  /**
585
- * @public
586
585
  * Boolean to indicate if custom encryption has been enabled.
586
+ * @public
587
587
  */
588
588
  enabled: boolean | undefined;
589
589
  /**
590
- * @public
591
590
  * Server-side encryption type.
591
+ * @public
592
592
  */
593
593
  encryptionType?: EncryptionType;
594
594
  /**
595
- * @public
596
595
  * KMS key id/arn for encryption config.
596
+ * @public
597
597
  */
598
598
  keyArn?: string;
599
599
  }
600
600
  /**
601
- * @public
602
601
  * Instance config object
602
+ * @public
603
603
  */
604
604
  export interface InstanceConfig {
605
605
  /**
606
- * @public
607
606
  * Amazon Connect Instance Id
607
+ * @public
608
608
  */
609
609
  connectInstanceId: string | undefined;
610
610
  /**
611
- * @public
612
611
  * Service linked role arn
612
+ * @public
613
613
  */
614
614
  serviceLinkedRoleArn: string | undefined;
615
615
  /**
616
- * @public
617
616
  * Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
618
617
  * If disabled, service will perform encryption with its own key.
619
618
  * If enabled, a KMS key id needs to be provided and KMS charges will apply.
620
619
  * KMS is only type supported
620
+ * @public
621
621
  */
622
622
  encryptionConfig: EncryptionConfig | undefined;
623
623
  }
624
624
  /**
625
- * @public
626
625
  * GetConnectInstanceConfigResponse
626
+ * @public
627
627
  */
628
628
  export interface GetConnectInstanceConfigResponse {
629
629
  /**
630
- * @public
631
630
  * Instance config object
631
+ * @public
632
632
  */
633
633
  connectInstanceConfig?: InstanceConfig;
634
634
  }
635
635
  /**
636
- * @public
637
636
  * GetInstanceOnboardingJobStatusRequest
637
+ * @public
638
638
  */
639
639
  export interface GetInstanceOnboardingJobStatusRequest {
640
640
  /**
641
- * @public
642
641
  * Amazon Connect Instance Id
642
+ * @public
643
643
  */
644
644
  connectInstanceId: string | undefined;
645
645
  }
@@ -673,34 +673,34 @@ export declare const InstanceOnboardingJobStatusCode: {
673
673
  */
674
674
  export type InstanceOnboardingJobStatusCode = (typeof InstanceOnboardingJobStatusCode)[keyof typeof InstanceOnboardingJobStatusCode];
675
675
  /**
676
- * @public
677
676
  * Instance onboarding job status object
677
+ * @public
678
678
  */
679
679
  export interface InstanceOnboardingJobStatus {
680
680
  /**
681
- * @public
682
681
  * Amazon Connect Instance Id
682
+ * @public
683
683
  */
684
684
  connectInstanceId: string | undefined;
685
685
  /**
686
- * @public
687
686
  * Enumeration of the possible states for instance onboarding job
687
+ * @public
688
688
  */
689
689
  status: InstanceOnboardingJobStatusCode | undefined;
690
690
  /**
691
- * @public
692
691
  * Enumeration of the possible failure codes for instance onboarding job
692
+ * @public
693
693
  */
694
694
  failureCode?: InstanceOnboardingJobFailureCode;
695
695
  }
696
696
  /**
697
- * @public
698
697
  * GetInstanceOnboardingJobStatusResponse
698
+ * @public
699
699
  */
700
700
  export interface GetInstanceOnboardingJobStatusResponse {
701
701
  /**
702
- * @public
703
702
  * Instance onboarding job status object
703
+ * @public
704
704
  */
705
705
  connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
706
706
  }
@@ -719,132 +719,132 @@ export declare const InstanceIdFilterOperator: {
719
719
  */
720
720
  export type InstanceIdFilterOperator = (typeof InstanceIdFilterOperator)[keyof typeof InstanceIdFilterOperator];
721
721
  /**
722
- * @public
723
722
  * Connect instance identifier filter
723
+ * @public
724
724
  */
725
725
  export interface InstanceIdFilter {
726
726
  /**
727
- * @public
728
727
  * Amazon Connect Instance Id
728
+ * @public
729
729
  */
730
730
  value: string | undefined;
731
731
  /**
732
- * @public
733
732
  * Operators for Connect instance identifier filter
733
+ * @public
734
734
  */
735
735
  operator: InstanceIdFilterOperator | undefined;
736
736
  }
737
737
  /**
738
- * @public
739
738
  * Filter model by type
739
+ * @public
740
740
  */
741
741
  export interface CampaignFilters {
742
742
  /**
743
- * @public
744
743
  * Connect instance identifier filter
744
+ * @public
745
745
  */
746
746
  instanceIdFilter?: InstanceIdFilter;
747
747
  }
748
748
  /**
749
- * @public
750
749
  * ListCampaignsRequest
750
+ * @public
751
751
  */
752
752
  export interface ListCampaignsRequest {
753
753
  /**
754
- * @public
755
754
  * The maximum number of results to return per page.
755
+ * @public
756
756
  */
757
757
  maxResults?: number;
758
758
  /**
759
- * @public
760
759
  * The token for the next set of results.
760
+ * @public
761
761
  */
762
762
  nextToken?: string;
763
763
  /**
764
- * @public
765
764
  * Filter model by type
765
+ * @public
766
766
  */
767
767
  filters?: CampaignFilters;
768
768
  }
769
769
  /**
770
- * @public
771
770
  * An Amazon Connect campaign summary.
771
+ * @public
772
772
  */
773
773
  export interface CampaignSummary {
774
774
  /**
775
- * @public
776
775
  * Identifier representing a Campaign
776
+ * @public
777
777
  */
778
778
  id: string | undefined;
779
779
  /**
780
- * @public
781
780
  * The resource name of an Amazon Connect campaign.
781
+ * @public
782
782
  */
783
783
  arn: string | undefined;
784
784
  /**
785
- * @public
786
785
  * The name of an Amazon Connect Campaign name.
786
+ * @public
787
787
  */
788
788
  name: string | undefined;
789
789
  /**
790
- * @public
791
790
  * Amazon Connect Instance Id
791
+ * @public
792
792
  */
793
793
  connectInstanceId: string | undefined;
794
794
  }
795
795
  /**
796
- * @public
797
796
  * ListCampaignsResponse
797
+ * @public
798
798
  */
799
799
  export interface ListCampaignsResponse {
800
800
  /**
801
- * @public
802
801
  * The token for the next set of results.
802
+ * @public
803
803
  */
804
804
  nextToken?: string;
805
805
  /**
806
- * @public
807
806
  * A list of Amazon Connect campaigns.
807
+ * @public
808
808
  */
809
809
  campaignSummaryList?: CampaignSummary[];
810
810
  }
811
811
  /**
812
- * @public
813
812
  * ListTagsForResource
813
+ * @public
814
814
  */
815
815
  export interface ListTagsForResourceRequest {
816
816
  /**
817
- * @public
818
817
  * Arn
818
+ * @public
819
819
  */
820
820
  arn: string | undefined;
821
821
  }
822
822
  /**
823
- * @public
824
823
  * ListTagsForResponse
824
+ * @public
825
825
  */
826
826
  export interface ListTagsForResourceResponse {
827
827
  /**
828
- * @public
829
828
  * Tag map with key and value.
829
+ * @public
830
830
  */
831
831
  tags?: Record<string, string>;
832
832
  }
833
833
  /**
834
- * @public
835
834
  * The request could not be processed because of conflict in the current state of the campaign.
835
+ * @public
836
836
  */
837
837
  export declare class InvalidCampaignStateException extends __BaseException {
838
838
  readonly name: "InvalidCampaignStateException";
839
839
  readonly $fault: "client";
840
840
  /**
841
- * @public
842
841
  * State of a campaign
842
+ * @public
843
843
  */
844
844
  state: CampaignState | undefined;
845
845
  /**
846
- * @public
847
846
  * A header that defines the error encountered while processing the request.
847
+ * @public
848
848
  */
849
849
  xAmzErrorType?: string;
850
850
  /**
@@ -853,55 +853,55 @@ export declare class InvalidCampaignStateException extends __BaseException {
853
853
  constructor(opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>);
854
854
  }
855
855
  /**
856
- * @public
857
856
  * PauseCampaignRequest
857
+ * @public
858
858
  */
859
859
  export interface PauseCampaignRequest {
860
860
  /**
861
- * @public
862
861
  * Identifier representing a Campaign
862
+ * @public
863
863
  */
864
864
  id: string | undefined;
865
865
  }
866
866
  /**
867
- * @public
868
867
  * A dial request for a campaign.
868
+ * @public
869
869
  */
870
870
  export interface DialRequest {
871
871
  /**
872
- * @public
873
872
  * Client provided parameter used for idempotency. Its value must be unique for each request.
873
+ * @public
874
874
  */
875
875
  clientToken: string | undefined;
876
876
  /**
877
- * @public
878
877
  * The phone number of the customer, in E.164 format.
878
+ * @public
879
879
  */
880
880
  phoneNumber: string | undefined;
881
881
  /**
882
- * @public
883
882
  * Timestamp with no UTC offset or timezone
883
+ * @public
884
884
  */
885
885
  expirationTime: Date | undefined;
886
886
  /**
887
- * @public
888
887
  * 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.
888
+ * @public
889
889
  */
890
890
  attributes: Record<string, string> | undefined;
891
891
  }
892
892
  /**
893
- * @public
894
893
  * PutDialRequestBatchRequest
894
+ * @public
895
895
  */
896
896
  export interface PutDialRequestBatchRequest {
897
897
  /**
898
- * @public
899
898
  * Identifier representing a Campaign
899
+ * @public
900
900
  */
901
901
  id: string | undefined;
902
902
  /**
903
- * @public
904
903
  * A list of dial requests.
904
+ * @public
905
905
  */
906
906
  dialRequests: DialRequest[] | undefined;
907
907
  }
@@ -928,208 +928,208 @@ export declare const FailureCode: {
928
928
  */
929
929
  export type FailureCode = (typeof FailureCode)[keyof typeof FailureCode];
930
930
  /**
931
- * @public
932
931
  * A failed request identified by the unique client token.
932
+ * @public
933
933
  */
934
934
  export interface FailedRequest {
935
935
  /**
936
- * @public
937
936
  * Client provided parameter used for idempotency. Its value must be unique for each request.
937
+ * @public
938
938
  */
939
939
  clientToken?: string;
940
940
  /**
941
- * @public
942
941
  * Identifier representing a Dial request
942
+ * @public
943
943
  */
944
944
  id?: string;
945
945
  /**
946
- * @public
947
946
  * A predefined code indicating the error that caused the failure.
947
+ * @public
948
948
  */
949
949
  failureCode?: FailureCode;
950
950
  }
951
951
  /**
952
- * @public
953
952
  * A successful request identified by the unique client token.
953
+ * @public
954
954
  */
955
955
  export interface SuccessfulRequest {
956
956
  /**
957
- * @public
958
957
  * Client provided parameter used for idempotency. Its value must be unique for each request.
958
+ * @public
959
959
  */
960
960
  clientToken?: string;
961
961
  /**
962
- * @public
963
962
  * Identifier representing a Dial request
963
+ * @public
964
964
  */
965
965
  id?: string;
966
966
  }
967
967
  /**
968
- * @public
969
968
  * PutDialRequestBatchResponse
969
+ * @public
970
970
  */
971
971
  export interface PutDialRequestBatchResponse {
972
972
  /**
973
- * @public
974
973
  * A list of successful requests identified by the unique client token.
974
+ * @public
975
975
  */
976
976
  successfulRequests?: SuccessfulRequest[];
977
977
  /**
978
- * @public
979
978
  * A list of failed requests.
979
+ * @public
980
980
  */
981
981
  failedRequests?: FailedRequest[];
982
982
  }
983
983
  /**
984
- * @public
985
984
  * ResumeCampaignRequest
985
+ * @public
986
986
  */
987
987
  export interface ResumeCampaignRequest {
988
988
  /**
989
- * @public
990
989
  * Identifier representing a Campaign
990
+ * @public
991
991
  */
992
992
  id: string | undefined;
993
993
  }
994
994
  /**
995
- * @public
996
995
  * StartCampaignRequest
996
+ * @public
997
997
  */
998
998
  export interface StartCampaignRequest {
999
999
  /**
1000
- * @public
1001
1000
  * Identifier representing a Campaign
1001
+ * @public
1002
1002
  */
1003
1003
  id: string | undefined;
1004
1004
  }
1005
1005
  /**
1006
- * @public
1007
1006
  * The request for StartInstanceOnboardingJob API.
1007
+ * @public
1008
1008
  */
1009
1009
  export interface StartInstanceOnboardingJobRequest {
1010
1010
  /**
1011
- * @public
1012
1011
  * Amazon Connect Instance Id
1012
+ * @public
1013
1013
  */
1014
1014
  connectInstanceId: string | undefined;
1015
1015
  /**
1016
- * @public
1017
1016
  * Encryption config for Connect Instance. Note that sensitive data will always be encrypted.
1018
1017
  * If disabled, service will perform encryption with its own key.
1019
1018
  * If enabled, a KMS key id needs to be provided and KMS charges will apply.
1020
1019
  * KMS is only type supported
1020
+ * @public
1021
1021
  */
1022
1022
  encryptionConfig: EncryptionConfig | undefined;
1023
1023
  }
1024
1024
  /**
1025
- * @public
1026
1025
  * The response for StartInstanceOnboardingJob API.
1026
+ * @public
1027
1027
  */
1028
1028
  export interface StartInstanceOnboardingJobResponse {
1029
1029
  /**
1030
- * @public
1031
1030
  * Instance onboarding job status object
1031
+ * @public
1032
1032
  */
1033
1033
  connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
1034
1034
  }
1035
1035
  /**
1036
- * @public
1037
1036
  * StopCampaignRequest
1037
+ * @public
1038
1038
  */
1039
1039
  export interface StopCampaignRequest {
1040
1040
  /**
1041
- * @public
1042
1041
  * Identifier representing a Campaign
1042
+ * @public
1043
1043
  */
1044
1044
  id: string | undefined;
1045
1045
  }
1046
1046
  /**
1047
- * @public
1048
1047
  * TagResourceRequest
1048
+ * @public
1049
1049
  */
1050
1050
  export interface TagResourceRequest {
1051
1051
  /**
1052
- * @public
1053
1052
  * Arn
1053
+ * @public
1054
1054
  */
1055
1055
  arn: string | undefined;
1056
1056
  /**
1057
- * @public
1058
1057
  * Tag map with key and value.
1058
+ * @public
1059
1059
  */
1060
1060
  tags: Record<string, string> | undefined;
1061
1061
  }
1062
1062
  /**
1063
- * @public
1064
1063
  * UntagResourceRequest
1064
+ * @public
1065
1065
  */
1066
1066
  export interface UntagResourceRequest {
1067
1067
  /**
1068
- * @public
1069
1068
  * Arn
1069
+ * @public
1070
1070
  */
1071
1071
  arn: string | undefined;
1072
1072
  /**
1073
- * @public
1074
1073
  * List of tag keys.
1074
+ * @public
1075
1075
  */
1076
1076
  tagKeys: string[] | undefined;
1077
1077
  }
1078
1078
  /**
1079
- * @public
1080
1079
  * UpdateCampaignDialerConfigRequest
1080
+ * @public
1081
1081
  */
1082
1082
  export interface UpdateCampaignDialerConfigRequest {
1083
1083
  /**
1084
- * @public
1085
1084
  * Identifier representing a Campaign
1085
+ * @public
1086
1086
  */
1087
1087
  id: string | undefined;
1088
1088
  /**
1089
- * @public
1090
1089
  * The possible types of dialer config parameters
1090
+ * @public
1091
1091
  */
1092
1092
  dialerConfig: DialerConfig | undefined;
1093
1093
  }
1094
1094
  /**
1095
- * @public
1096
1095
  * UpdateCampaignNameRequest
1096
+ * @public
1097
1097
  */
1098
1098
  export interface UpdateCampaignNameRequest {
1099
1099
  /**
1100
- * @public
1101
1100
  * Identifier representing a Campaign
1101
+ * @public
1102
1102
  */
1103
1103
  id: string | undefined;
1104
1104
  /**
1105
- * @public
1106
1105
  * The name of an Amazon Connect Campaign name.
1106
+ * @public
1107
1107
  */
1108
1108
  name: string | undefined;
1109
1109
  }
1110
1110
  /**
1111
- * @public
1112
1111
  * UpdateCampaignOutboundCallConfigRequest
1112
+ * @public
1113
1113
  */
1114
1114
  export interface UpdateCampaignOutboundCallConfigRequest {
1115
1115
  /**
1116
- * @public
1117
1116
  * Identifier representing a Campaign
1117
+ * @public
1118
1118
  */
1119
1119
  id: string | undefined;
1120
1120
  /**
1121
- * @public
1122
1121
  * The identifier of the contact flow for the outbound call.
1122
+ * @public
1123
1123
  */
1124
1124
  connectContactFlowId?: string;
1125
1125
  /**
1126
- * @public
1127
1126
  * 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.
1127
+ * @public
1128
1128
  */
1129
1129
  connectSourcePhoneNumber?: string;
1130
1130
  /**
1131
- * @public
1132
1131
  * Answering Machine Detection config
1132
+ * @public
1133
1133
  */
1134
1134
  answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
1135
1135
  }