aws-sdk-connectcampaignservice 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1441 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ConnectCampaignService
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @!attribute [rw] x_amz_error_type
19
+ # A header that defines the error encountered while processing the
20
+ # request.
21
+ # @return [String]
22
+ #
23
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/AccessDeniedException AWS API Documentation
24
+ #
25
+ class AccessDeniedException < Struct.new(
26
+ :message,
27
+ :x_amz_error_type)
28
+ SENSITIVE = []
29
+ include Aws::Structure
30
+ end
31
+
32
+ # Answering Machine Detection config
33
+ #
34
+ # @note When making an API call, you may pass AnswerMachineDetectionConfig
35
+ # data as a hash:
36
+ #
37
+ # {
38
+ # enable_answer_machine_detection: false, # required
39
+ # }
40
+ #
41
+ # @!attribute [rw] enable_answer_machine_detection
42
+ # Enable or disable answering machine detection
43
+ # @return [Boolean]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/AnswerMachineDetectionConfig AWS API Documentation
46
+ #
47
+ class AnswerMachineDetectionConfig < Struct.new(
48
+ :enable_answer_machine_detection)
49
+ SENSITIVE = []
50
+ include Aws::Structure
51
+ end
52
+
53
+ # An Amazon Connect campaign.
54
+ #
55
+ # @!attribute [rw] arn
56
+ # The resource name of an Amazon Connect campaign.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] connect_instance_id
60
+ # Amazon Connect Instance Id
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] dialer_config
64
+ # The possible types of dialer config parameters
65
+ # @return [Types::DialerConfig]
66
+ #
67
+ # @!attribute [rw] id
68
+ # Identifier representing a Campaign
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] name
72
+ # The name of an Amazon Connect Campaign name.
73
+ # @return [String]
74
+ #
75
+ # @!attribute [rw] outbound_call_config
76
+ # The configuration used for outbound calls.
77
+ # @return [Types::OutboundCallConfig]
78
+ #
79
+ # @!attribute [rw] tags
80
+ # Tag map with key and value.
81
+ # @return [Hash<String,String>]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/Campaign AWS API Documentation
84
+ #
85
+ class Campaign < Struct.new(
86
+ :arn,
87
+ :connect_instance_id,
88
+ :dialer_config,
89
+ :id,
90
+ :name,
91
+ :outbound_call_config,
92
+ :tags)
93
+ SENSITIVE = []
94
+ include Aws::Structure
95
+ end
96
+
97
+ # Filter model by type
98
+ #
99
+ # @note When making an API call, you may pass CampaignFilters
100
+ # data as a hash:
101
+ #
102
+ # {
103
+ # instance_id_filter: {
104
+ # operator: "Eq", # required, accepts Eq
105
+ # value: "InstanceId", # required
106
+ # },
107
+ # }
108
+ #
109
+ # @!attribute [rw] instance_id_filter
110
+ # Connect instance identifier filter
111
+ # @return [Types::InstanceIdFilter]
112
+ #
113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/CampaignFilters AWS API Documentation
114
+ #
115
+ class CampaignFilters < Struct.new(
116
+ :instance_id_filter)
117
+ SENSITIVE = []
118
+ include Aws::Structure
119
+ end
120
+
121
+ # An Amazon Connect campaign summary.
122
+ #
123
+ # @!attribute [rw] arn
124
+ # The resource name of an Amazon Connect campaign.
125
+ # @return [String]
126
+ #
127
+ # @!attribute [rw] connect_instance_id
128
+ # Amazon Connect Instance Id
129
+ # @return [String]
130
+ #
131
+ # @!attribute [rw] id
132
+ # Identifier representing a Campaign
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] name
136
+ # The name of an Amazon Connect Campaign name.
137
+ # @return [String]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/CampaignSummary AWS API Documentation
140
+ #
141
+ class CampaignSummary < Struct.new(
142
+ :arn,
143
+ :connect_instance_id,
144
+ :id,
145
+ :name)
146
+ SENSITIVE = []
147
+ include Aws::Structure
148
+ end
149
+
150
+ # The request could not be processed because of conflict in the current
151
+ # state of the resource.
152
+ #
153
+ # @!attribute [rw] message
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] x_amz_error_type
157
+ # A header that defines the error encountered while processing the
158
+ # request.
159
+ # @return [String]
160
+ #
161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ConflictException AWS API Documentation
162
+ #
163
+ class ConflictException < Struct.new(
164
+ :message,
165
+ :x_amz_error_type)
166
+ SENSITIVE = []
167
+ include Aws::Structure
168
+ end
169
+
170
+ # The request for Create Campaign API.
171
+ #
172
+ # @note When making an API call, you may pass CreateCampaignRequest
173
+ # data as a hash:
174
+ #
175
+ # {
176
+ # connect_instance_id: "InstanceId", # required
177
+ # dialer_config: { # required
178
+ # predictive_dialer_config: {
179
+ # bandwidth_allocation: 1.0, # required
180
+ # },
181
+ # progressive_dialer_config: {
182
+ # bandwidth_allocation: 1.0, # required
183
+ # },
184
+ # },
185
+ # name: "CampaignName", # required
186
+ # outbound_call_config: { # required
187
+ # answer_machine_detection_config: {
188
+ # enable_answer_machine_detection: false, # required
189
+ # },
190
+ # connect_contact_flow_id: "ContactFlowId", # required
191
+ # connect_queue_id: "QueueId", # required
192
+ # connect_source_phone_number: "SourcePhoneNumber",
193
+ # },
194
+ # tags: {
195
+ # "TagKey" => "TagValue",
196
+ # },
197
+ # }
198
+ #
199
+ # @!attribute [rw] connect_instance_id
200
+ # Amazon Connect Instance Id
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] dialer_config
204
+ # The possible types of dialer config parameters
205
+ # @return [Types::DialerConfig]
206
+ #
207
+ # @!attribute [rw] name
208
+ # The name of an Amazon Connect Campaign name.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] outbound_call_config
212
+ # The configuration used for outbound calls.
213
+ # @return [Types::OutboundCallConfig]
214
+ #
215
+ # @!attribute [rw] tags
216
+ # Tag map with key and value.
217
+ # @return [Hash<String,String>]
218
+ #
219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/CreateCampaignRequest AWS API Documentation
220
+ #
221
+ class CreateCampaignRequest < Struct.new(
222
+ :connect_instance_id,
223
+ :dialer_config,
224
+ :name,
225
+ :outbound_call_config,
226
+ :tags)
227
+ SENSITIVE = []
228
+ include Aws::Structure
229
+ end
230
+
231
+ # The response for Create Campaign API
232
+ #
233
+ # @!attribute [rw] arn
234
+ # The resource name of an Amazon Connect campaign.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] id
238
+ # Identifier representing a Campaign
239
+ # @return [String]
240
+ #
241
+ # @!attribute [rw] tags
242
+ # Tag map with key and value.
243
+ # @return [Hash<String,String>]
244
+ #
245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/CreateCampaignResponse AWS API Documentation
246
+ #
247
+ class CreateCampaignResponse < Struct.new(
248
+ :arn,
249
+ :id,
250
+ :tags)
251
+ SENSITIVE = []
252
+ include Aws::Structure
253
+ end
254
+
255
+ # DeleteCampaignRequest
256
+ #
257
+ # @note When making an API call, you may pass DeleteCampaignRequest
258
+ # data as a hash:
259
+ #
260
+ # {
261
+ # id: "CampaignId", # required
262
+ # }
263
+ #
264
+ # @!attribute [rw] id
265
+ # Identifier representing a Campaign
266
+ # @return [String]
267
+ #
268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DeleteCampaignRequest AWS API Documentation
269
+ #
270
+ class DeleteCampaignRequest < Struct.new(
271
+ :id)
272
+ SENSITIVE = []
273
+ include Aws::Structure
274
+ end
275
+
276
+ # DeleteCampaignRequest
277
+ #
278
+ # @note When making an API call, you may pass DeleteConnectInstanceConfigRequest
279
+ # data as a hash:
280
+ #
281
+ # {
282
+ # connect_instance_id: "InstanceId", # required
283
+ # }
284
+ #
285
+ # @!attribute [rw] connect_instance_id
286
+ # Amazon Connect Instance Id
287
+ # @return [String]
288
+ #
289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DeleteConnectInstanceConfigRequest AWS API Documentation
290
+ #
291
+ class DeleteConnectInstanceConfigRequest < Struct.new(
292
+ :connect_instance_id)
293
+ SENSITIVE = []
294
+ include Aws::Structure
295
+ end
296
+
297
+ # The request for DeleteInstanceOnboardingJob API.
298
+ #
299
+ # @note When making an API call, you may pass DeleteInstanceOnboardingJobRequest
300
+ # data as a hash:
301
+ #
302
+ # {
303
+ # connect_instance_id: "InstanceId", # required
304
+ # }
305
+ #
306
+ # @!attribute [rw] connect_instance_id
307
+ # Amazon Connect Instance Id
308
+ # @return [String]
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJobRequest AWS API Documentation
311
+ #
312
+ class DeleteInstanceOnboardingJobRequest < Struct.new(
313
+ :connect_instance_id)
314
+ SENSITIVE = []
315
+ include Aws::Structure
316
+ end
317
+
318
+ # DescribeCampaignRequests
319
+ #
320
+ # @note When making an API call, you may pass DescribeCampaignRequest
321
+ # data as a hash:
322
+ #
323
+ # {
324
+ # id: "CampaignId", # required
325
+ # }
326
+ #
327
+ # @!attribute [rw] id
328
+ # Identifier representing a Campaign
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DescribeCampaignRequest AWS API Documentation
332
+ #
333
+ class DescribeCampaignRequest < Struct.new(
334
+ :id)
335
+ SENSITIVE = []
336
+ include Aws::Structure
337
+ end
338
+
339
+ # DescribeCampaignResponse
340
+ #
341
+ # @!attribute [rw] campaign
342
+ # An Amazon Connect campaign.
343
+ # @return [Types::Campaign]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DescribeCampaignResponse AWS API Documentation
346
+ #
347
+ class DescribeCampaignResponse < Struct.new(
348
+ :campaign)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # A dial request for a campaign.
354
+ #
355
+ # @note When making an API call, you may pass DialRequest
356
+ # data as a hash:
357
+ #
358
+ # {
359
+ # attributes: { # required
360
+ # "AttributeName" => "AttributeValue",
361
+ # },
362
+ # client_token: "ClientToken", # required
363
+ # expiration_time: Time.now, # required
364
+ # phone_number: "DestinationPhoneNumber", # required
365
+ # }
366
+ #
367
+ # @!attribute [rw] attributes
368
+ # A custom key-value pair using an attribute map. The attributes are
369
+ # standard Amazon Connect attributes, and can be accessed in contact
370
+ # flows just like any other contact attributes.
371
+ # @return [Hash<String,String>]
372
+ #
373
+ # @!attribute [rw] client_token
374
+ # Client provided parameter used for idempotency. Its value must be
375
+ # unique for each request.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] expiration_time
379
+ # Timestamp with no UTC offset or timezone
380
+ # @return [Time]
381
+ #
382
+ # @!attribute [rw] phone_number
383
+ # The phone number of the customer, in E.164 format.
384
+ # @return [String]
385
+ #
386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DialRequest AWS API Documentation
387
+ #
388
+ class DialRequest < Struct.new(
389
+ :attributes,
390
+ :client_token,
391
+ :expiration_time,
392
+ :phone_number)
393
+ SENSITIVE = [:attributes, :phone_number]
394
+ include Aws::Structure
395
+ end
396
+
397
+ # The possible types of dialer config parameters
398
+ #
399
+ # @note DialerConfig is a union - when making an API calls you must set exactly one of the members.
400
+ #
401
+ # @note DialerConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DialerConfig corresponding to the set member.
402
+ #
403
+ # @!attribute [rw] predictive_dialer_config
404
+ # Predictive Dialer config
405
+ # @return [Types::PredictiveDialerConfig]
406
+ #
407
+ # @!attribute [rw] progressive_dialer_config
408
+ # Progressive Dialer config
409
+ # @return [Types::ProgressiveDialerConfig]
410
+ #
411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/DialerConfig AWS API Documentation
412
+ #
413
+ class DialerConfig < Struct.new(
414
+ :predictive_dialer_config,
415
+ :progressive_dialer_config,
416
+ :unknown)
417
+ SENSITIVE = []
418
+ include Aws::Structure
419
+ include Aws::Structure::Union
420
+
421
+ class PredictiveDialerConfig < DialerConfig; end
422
+ class ProgressiveDialerConfig < DialerConfig; end
423
+ class Unknown < DialerConfig; end
424
+ end
425
+
426
+ # Encryption config for Connect Instance. Note that sensitive data will
427
+ # always be encrypted. If disabled, service will perform encryption with
428
+ # its own key. If enabled, a KMS key id needs to be provided and KMS
429
+ # charges will apply. KMS is only type supported
430
+ #
431
+ # @note When making an API call, you may pass EncryptionConfig
432
+ # data as a hash:
433
+ #
434
+ # {
435
+ # enabled: false, # required
436
+ # encryption_type: "KMS", # accepts KMS
437
+ # key_arn: "EncryptionKey",
438
+ # }
439
+ #
440
+ # @!attribute [rw] enabled
441
+ # Boolean to indicate if custom encryption has been enabled.
442
+ # @return [Boolean]
443
+ #
444
+ # @!attribute [rw] encryption_type
445
+ # Server-side encryption type.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] key_arn
449
+ # KMS key id/arn for encryption config.
450
+ # @return [String]
451
+ #
452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/EncryptionConfig AWS API Documentation
453
+ #
454
+ class EncryptionConfig < Struct.new(
455
+ :enabled,
456
+ :encryption_type,
457
+ :key_arn)
458
+ SENSITIVE = []
459
+ include Aws::Structure
460
+ end
461
+
462
+ # Failed response of campaign state
463
+ #
464
+ # @!attribute [rw] campaign_id
465
+ # Identifier representing a Campaign
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] failure_code
469
+ # A predefined code indicating the error that caused the failure in
470
+ # getting state of campaigns
471
+ # @return [String]
472
+ #
473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/FailedCampaignStateResponse AWS API Documentation
474
+ #
475
+ class FailedCampaignStateResponse < Struct.new(
476
+ :campaign_id,
477
+ :failure_code)
478
+ SENSITIVE = []
479
+ include Aws::Structure
480
+ end
481
+
482
+ # A failed request identified by the unique client token.
483
+ #
484
+ # @!attribute [rw] client_token
485
+ # Client provided parameter used for idempotency. Its value must be
486
+ # unique for each request.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] failure_code
490
+ # A predefined code indicating the error that caused the failure.
491
+ # @return [String]
492
+ #
493
+ # @!attribute [rw] id
494
+ # Identifier representing a Dial request
495
+ # @return [String]
496
+ #
497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/FailedRequest AWS API Documentation
498
+ #
499
+ class FailedRequest < Struct.new(
500
+ :client_token,
501
+ :failure_code,
502
+ :id)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
507
+ # GetCampaignStateBatchRequest
508
+ #
509
+ # @note When making an API call, you may pass GetCampaignStateBatchRequest
510
+ # data as a hash:
511
+ #
512
+ # {
513
+ # campaign_ids: ["CampaignId"], # required
514
+ # }
515
+ #
516
+ # @!attribute [rw] campaign_ids
517
+ # List of CampaignId
518
+ # @return [Array<String>]
519
+ #
520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetCampaignStateBatchRequest AWS API Documentation
521
+ #
522
+ class GetCampaignStateBatchRequest < Struct.new(
523
+ :campaign_ids)
524
+ SENSITIVE = []
525
+ include Aws::Structure
526
+ end
527
+
528
+ # GetCampaignStateBatchResponse
529
+ #
530
+ # @!attribute [rw] failed_requests
531
+ # List of failed requests of campaign state
532
+ # @return [Array<Types::FailedCampaignStateResponse>]
533
+ #
534
+ # @!attribute [rw] successful_requests
535
+ # List of successful response of campaign state
536
+ # @return [Array<Types::SuccessfulCampaignStateResponse>]
537
+ #
538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetCampaignStateBatchResponse AWS API Documentation
539
+ #
540
+ class GetCampaignStateBatchResponse < Struct.new(
541
+ :failed_requests,
542
+ :successful_requests)
543
+ SENSITIVE = []
544
+ include Aws::Structure
545
+ end
546
+
547
+ # GetCampaignStateRequest
548
+ #
549
+ # @note When making an API call, you may pass GetCampaignStateRequest
550
+ # data as a hash:
551
+ #
552
+ # {
553
+ # id: "CampaignId", # required
554
+ # }
555
+ #
556
+ # @!attribute [rw] id
557
+ # Identifier representing a Campaign
558
+ # @return [String]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetCampaignStateRequest AWS API Documentation
561
+ #
562
+ class GetCampaignStateRequest < Struct.new(
563
+ :id)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
568
+ # GetCampaignStateResponse
569
+ #
570
+ # @!attribute [rw] state
571
+ # State of a campaign
572
+ # @return [String]
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetCampaignStateResponse AWS API Documentation
575
+ #
576
+ class GetCampaignStateResponse < Struct.new(
577
+ :state)
578
+ SENSITIVE = []
579
+ include Aws::Structure
580
+ end
581
+
582
+ # GetConnectInstanceConfigRequest
583
+ #
584
+ # @note When making an API call, you may pass GetConnectInstanceConfigRequest
585
+ # data as a hash:
586
+ #
587
+ # {
588
+ # connect_instance_id: "InstanceId", # required
589
+ # }
590
+ #
591
+ # @!attribute [rw] connect_instance_id
592
+ # Amazon Connect Instance Id
593
+ # @return [String]
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetConnectInstanceConfigRequest AWS API Documentation
596
+ #
597
+ class GetConnectInstanceConfigRequest < Struct.new(
598
+ :connect_instance_id)
599
+ SENSITIVE = []
600
+ include Aws::Structure
601
+ end
602
+
603
+ # GetConnectInstanceConfigResponse
604
+ #
605
+ # @!attribute [rw] connect_instance_config
606
+ # Instance config object
607
+ # @return [Types::InstanceConfig]
608
+ #
609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetConnectInstanceConfigResponse AWS API Documentation
610
+ #
611
+ class GetConnectInstanceConfigResponse < Struct.new(
612
+ :connect_instance_config)
613
+ SENSITIVE = []
614
+ include Aws::Structure
615
+ end
616
+
617
+ # GetInstanceOnboardingJobStatusRequest
618
+ #
619
+ # @note When making an API call, you may pass GetInstanceOnboardingJobStatusRequest
620
+ # data as a hash:
621
+ #
622
+ # {
623
+ # connect_instance_id: "InstanceId", # required
624
+ # }
625
+ #
626
+ # @!attribute [rw] connect_instance_id
627
+ # Amazon Connect Instance Id
628
+ # @return [String]
629
+ #
630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatusRequest AWS API Documentation
631
+ #
632
+ class GetInstanceOnboardingJobStatusRequest < Struct.new(
633
+ :connect_instance_id)
634
+ SENSITIVE = []
635
+ include Aws::Structure
636
+ end
637
+
638
+ # GetInstanceOnboardingJobStatusResponse
639
+ #
640
+ # @!attribute [rw] connect_instance_onboarding_job_status
641
+ # Instance onboarding job status object
642
+ # @return [Types::InstanceOnboardingJobStatus]
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatusResponse AWS API Documentation
645
+ #
646
+ class GetInstanceOnboardingJobStatusResponse < Struct.new(
647
+ :connect_instance_onboarding_job_status)
648
+ SENSITIVE = []
649
+ include Aws::Structure
650
+ end
651
+
652
+ # Instance config object
653
+ #
654
+ # @!attribute [rw] connect_instance_id
655
+ # Amazon Connect Instance Id
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] encryption_config
659
+ # Encryption config for Connect Instance. Note that sensitive data
660
+ # will always be encrypted. If disabled, service will perform
661
+ # encryption with its own key. If enabled, a KMS key id needs to be
662
+ # provided and KMS charges will apply. KMS is only type supported
663
+ # @return [Types::EncryptionConfig]
664
+ #
665
+ # @!attribute [rw] service_linked_role_arn
666
+ # Service linked role arn
667
+ # @return [String]
668
+ #
669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InstanceConfig AWS API Documentation
670
+ #
671
+ class InstanceConfig < Struct.new(
672
+ :connect_instance_id,
673
+ :encryption_config,
674
+ :service_linked_role_arn)
675
+ SENSITIVE = []
676
+ include Aws::Structure
677
+ end
678
+
679
+ # Connect instance identifier filter
680
+ #
681
+ # @note When making an API call, you may pass InstanceIdFilter
682
+ # data as a hash:
683
+ #
684
+ # {
685
+ # operator: "Eq", # required, accepts Eq
686
+ # value: "InstanceId", # required
687
+ # }
688
+ #
689
+ # @!attribute [rw] operator
690
+ # Operators for Connect instance identifier filter
691
+ # @return [String]
692
+ #
693
+ # @!attribute [rw] value
694
+ # Amazon Connect Instance Id
695
+ # @return [String]
696
+ #
697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InstanceIdFilter AWS API Documentation
698
+ #
699
+ class InstanceIdFilter < Struct.new(
700
+ :operator,
701
+ :value)
702
+ SENSITIVE = []
703
+ include Aws::Structure
704
+ end
705
+
706
+ # Instance onboarding job status object
707
+ #
708
+ # @!attribute [rw] connect_instance_id
709
+ # Amazon Connect Instance Id
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] failure_code
713
+ # Enumeration of the possible failure codes for instance onboarding
714
+ # job
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] status
718
+ # Enumeration of the possible states for instance onboarding job
719
+ # @return [String]
720
+ #
721
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InstanceOnboardingJobStatus AWS API Documentation
722
+ #
723
+ class InstanceOnboardingJobStatus < Struct.new(
724
+ :connect_instance_id,
725
+ :failure_code,
726
+ :status)
727
+ SENSITIVE = []
728
+ include Aws::Structure
729
+ end
730
+
731
+ # Request processing failed because of an error or failure with the
732
+ # service.
733
+ #
734
+ # @!attribute [rw] message
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] x_amz_error_type
738
+ # A header that defines the error encountered while processing the
739
+ # request.
740
+ # @return [String]
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InternalServerException AWS API Documentation
743
+ #
744
+ class InternalServerException < Struct.new(
745
+ :message,
746
+ :x_amz_error_type)
747
+ SENSITIVE = []
748
+ include Aws::Structure
749
+ end
750
+
751
+ # The request could not be processed because of conflict in the current
752
+ # state of the campaign.
753
+ #
754
+ # @!attribute [rw] message
755
+ # @return [String]
756
+ #
757
+ # @!attribute [rw] state
758
+ # State of a campaign
759
+ # @return [String]
760
+ #
761
+ # @!attribute [rw] x_amz_error_type
762
+ # A header that defines the error encountered while processing the
763
+ # request.
764
+ # @return [String]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InvalidCampaignStateException AWS API Documentation
767
+ #
768
+ class InvalidCampaignStateException < Struct.new(
769
+ :message,
770
+ :state,
771
+ :x_amz_error_type)
772
+ SENSITIVE = []
773
+ include Aws::Structure
774
+ end
775
+
776
+ # The request could not be processed because of conflict in the current
777
+ # state.
778
+ #
779
+ # @!attribute [rw] message
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] x_amz_error_type
783
+ # A header that defines the error encountered while processing the
784
+ # request.
785
+ # @return [String]
786
+ #
787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/InvalidStateException AWS API Documentation
788
+ #
789
+ class InvalidStateException < Struct.new(
790
+ :message,
791
+ :x_amz_error_type)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # ListCampaignsRequest
797
+ #
798
+ # @note When making an API call, you may pass ListCampaignsRequest
799
+ # data as a hash:
800
+ #
801
+ # {
802
+ # filters: {
803
+ # instance_id_filter: {
804
+ # operator: "Eq", # required, accepts Eq
805
+ # value: "InstanceId", # required
806
+ # },
807
+ # },
808
+ # max_results: 1,
809
+ # next_token: "NextToken",
810
+ # }
811
+ #
812
+ # @!attribute [rw] filters
813
+ # Filter model by type
814
+ # @return [Types::CampaignFilters]
815
+ #
816
+ # @!attribute [rw] max_results
817
+ # The maximum number of results to return per page.
818
+ # @return [Integer]
819
+ #
820
+ # @!attribute [rw] next_token
821
+ # The token for the next set of results.
822
+ # @return [String]
823
+ #
824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ListCampaignsRequest AWS API Documentation
825
+ #
826
+ class ListCampaignsRequest < Struct.new(
827
+ :filters,
828
+ :max_results,
829
+ :next_token)
830
+ SENSITIVE = []
831
+ include Aws::Structure
832
+ end
833
+
834
+ # ListCampaignsResponse
835
+ #
836
+ # @!attribute [rw] campaign_summary_list
837
+ # A list of Amazon Connect campaigns.
838
+ # @return [Array<Types::CampaignSummary>]
839
+ #
840
+ # @!attribute [rw] next_token
841
+ # The token for the next set of results.
842
+ # @return [String]
843
+ #
844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ListCampaignsResponse AWS API Documentation
845
+ #
846
+ class ListCampaignsResponse < Struct.new(
847
+ :campaign_summary_list,
848
+ :next_token)
849
+ SENSITIVE = []
850
+ include Aws::Structure
851
+ end
852
+
853
+ # ListTagsForResource
854
+ #
855
+ # @note When making an API call, you may pass ListTagsForResourceRequest
856
+ # data as a hash:
857
+ #
858
+ # {
859
+ # arn: "Arn", # required
860
+ # }
861
+ #
862
+ # @!attribute [rw] arn
863
+ # Arn
864
+ # @return [String]
865
+ #
866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ListTagsForResourceRequest AWS API Documentation
867
+ #
868
+ class ListTagsForResourceRequest < Struct.new(
869
+ :arn)
870
+ SENSITIVE = []
871
+ include Aws::Structure
872
+ end
873
+
874
+ # ListTagsForResponse
875
+ #
876
+ # @!attribute [rw] tags
877
+ # Tag map with key and value.
878
+ # @return [Hash<String,String>]
879
+ #
880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ListTagsForResourceResponse AWS API Documentation
881
+ #
882
+ class ListTagsForResourceResponse < Struct.new(
883
+ :tags)
884
+ SENSITIVE = []
885
+ include Aws::Structure
886
+ end
887
+
888
+ # The configuration used for outbound calls.
889
+ #
890
+ # @note When making an API call, you may pass OutboundCallConfig
891
+ # data as a hash:
892
+ #
893
+ # {
894
+ # answer_machine_detection_config: {
895
+ # enable_answer_machine_detection: false, # required
896
+ # },
897
+ # connect_contact_flow_id: "ContactFlowId", # required
898
+ # connect_queue_id: "QueueId", # required
899
+ # connect_source_phone_number: "SourcePhoneNumber",
900
+ # }
901
+ #
902
+ # @!attribute [rw] answer_machine_detection_config
903
+ # Answering Machine Detection config
904
+ # @return [Types::AnswerMachineDetectionConfig]
905
+ #
906
+ # @!attribute [rw] connect_contact_flow_id
907
+ # The identifier of the contact flow for the outbound call.
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] connect_queue_id
911
+ # The queue for the call. If you specify a queue, the phone displayed
912
+ # for caller ID is the phone number specified in the queue. If you do
913
+ # not specify a queue, the queue defined in the contact flow is used.
914
+ # If you do not specify a queue, you must specify a source phone
915
+ # number.
916
+ # @return [String]
917
+ #
918
+ # @!attribute [rw] connect_source_phone_number
919
+ # The phone number associated with the Amazon Connect instance, in
920
+ # E.164 format. If you do not specify a source phone number, you must
921
+ # specify a queue.
922
+ # @return [String]
923
+ #
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/OutboundCallConfig AWS API Documentation
925
+ #
926
+ class OutboundCallConfig < Struct.new(
927
+ :answer_machine_detection_config,
928
+ :connect_contact_flow_id,
929
+ :connect_queue_id,
930
+ :connect_source_phone_number)
931
+ SENSITIVE = []
932
+ include Aws::Structure
933
+ end
934
+
935
+ # PauseCampaignRequest
936
+ #
937
+ # @note When making an API call, you may pass PauseCampaignRequest
938
+ # data as a hash:
939
+ #
940
+ # {
941
+ # id: "CampaignId", # required
942
+ # }
943
+ #
944
+ # @!attribute [rw] id
945
+ # Identifier representing a Campaign
946
+ # @return [String]
947
+ #
948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/PauseCampaignRequest AWS API Documentation
949
+ #
950
+ class PauseCampaignRequest < Struct.new(
951
+ :id)
952
+ SENSITIVE = []
953
+ include Aws::Structure
954
+ end
955
+
956
+ # Predictive Dialer config
957
+ #
958
+ # @note When making an API call, you may pass PredictiveDialerConfig
959
+ # data as a hash:
960
+ #
961
+ # {
962
+ # bandwidth_allocation: 1.0, # required
963
+ # }
964
+ #
965
+ # @!attribute [rw] bandwidth_allocation
966
+ # The bandwidth allocation of a queue resource.
967
+ # @return [Float]
968
+ #
969
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/PredictiveDialerConfig AWS API Documentation
970
+ #
971
+ class PredictiveDialerConfig < Struct.new(
972
+ :bandwidth_allocation)
973
+ SENSITIVE = []
974
+ include Aws::Structure
975
+ end
976
+
977
+ # Progressive Dialer config
978
+ #
979
+ # @note When making an API call, you may pass ProgressiveDialerConfig
980
+ # data as a hash:
981
+ #
982
+ # {
983
+ # bandwidth_allocation: 1.0, # required
984
+ # }
985
+ #
986
+ # @!attribute [rw] bandwidth_allocation
987
+ # The bandwidth allocation of a queue resource.
988
+ # @return [Float]
989
+ #
990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ProgressiveDialerConfig AWS API Documentation
991
+ #
992
+ class ProgressiveDialerConfig < Struct.new(
993
+ :bandwidth_allocation)
994
+ SENSITIVE = []
995
+ include Aws::Structure
996
+ end
997
+
998
+ # PutDialRequestBatchRequest
999
+ #
1000
+ # @note When making an API call, you may pass PutDialRequestBatchRequest
1001
+ # data as a hash:
1002
+ #
1003
+ # {
1004
+ # dial_requests: [ # required
1005
+ # {
1006
+ # attributes: { # required
1007
+ # "AttributeName" => "AttributeValue",
1008
+ # },
1009
+ # client_token: "ClientToken", # required
1010
+ # expiration_time: Time.now, # required
1011
+ # phone_number: "DestinationPhoneNumber", # required
1012
+ # },
1013
+ # ],
1014
+ # id: "CampaignId", # required
1015
+ # }
1016
+ #
1017
+ # @!attribute [rw] dial_requests
1018
+ # A list of dial requests.
1019
+ # @return [Array<Types::DialRequest>]
1020
+ #
1021
+ # @!attribute [rw] id
1022
+ # Identifier representing a Campaign
1023
+ # @return [String]
1024
+ #
1025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/PutDialRequestBatchRequest AWS API Documentation
1026
+ #
1027
+ class PutDialRequestBatchRequest < Struct.new(
1028
+ :dial_requests,
1029
+ :id)
1030
+ SENSITIVE = []
1031
+ include Aws::Structure
1032
+ end
1033
+
1034
+ # PutDialRequestBatchResponse
1035
+ #
1036
+ # @!attribute [rw] failed_requests
1037
+ # A list of failed requests.
1038
+ # @return [Array<Types::FailedRequest>]
1039
+ #
1040
+ # @!attribute [rw] successful_requests
1041
+ # A list of successful requests identified by the unique client token.
1042
+ # @return [Array<Types::SuccessfulRequest>]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/PutDialRequestBatchResponse AWS API Documentation
1045
+ #
1046
+ class PutDialRequestBatchResponse < Struct.new(
1047
+ :failed_requests,
1048
+ :successful_requests)
1049
+ SENSITIVE = []
1050
+ include Aws::Structure
1051
+ end
1052
+
1053
+ # The specified resource was not found.
1054
+ #
1055
+ # @!attribute [rw] message
1056
+ # @return [String]
1057
+ #
1058
+ # @!attribute [rw] x_amz_error_type
1059
+ # A header that defines the error encountered while processing the
1060
+ # request.
1061
+ # @return [String]
1062
+ #
1063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ResourceNotFoundException AWS API Documentation
1064
+ #
1065
+ class ResourceNotFoundException < Struct.new(
1066
+ :message,
1067
+ :x_amz_error_type)
1068
+ SENSITIVE = []
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # ResumeCampaignRequest
1073
+ #
1074
+ # @note When making an API call, you may pass ResumeCampaignRequest
1075
+ # data as a hash:
1076
+ #
1077
+ # {
1078
+ # id: "CampaignId", # required
1079
+ # }
1080
+ #
1081
+ # @!attribute [rw] id
1082
+ # Identifier representing a Campaign
1083
+ # @return [String]
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ResumeCampaignRequest AWS API Documentation
1086
+ #
1087
+ class ResumeCampaignRequest < Struct.new(
1088
+ :id)
1089
+ SENSITIVE = []
1090
+ include Aws::Structure
1091
+ end
1092
+
1093
+ # Request would cause a service quota to be exceeded.
1094
+ #
1095
+ # @!attribute [rw] message
1096
+ # @return [String]
1097
+ #
1098
+ # @!attribute [rw] x_amz_error_type
1099
+ # A header that defines the error encountered while processing the
1100
+ # request.
1101
+ # @return [String]
1102
+ #
1103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ServiceQuotaExceededException AWS API Documentation
1104
+ #
1105
+ class ServiceQuotaExceededException < Struct.new(
1106
+ :message,
1107
+ :x_amz_error_type)
1108
+ SENSITIVE = []
1109
+ include Aws::Structure
1110
+ end
1111
+
1112
+ # StartCampaignRequest
1113
+ #
1114
+ # @note When making an API call, you may pass StartCampaignRequest
1115
+ # data as a hash:
1116
+ #
1117
+ # {
1118
+ # id: "CampaignId", # required
1119
+ # }
1120
+ #
1121
+ # @!attribute [rw] id
1122
+ # Identifier representing a Campaign
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/StartCampaignRequest AWS API Documentation
1126
+ #
1127
+ class StartCampaignRequest < Struct.new(
1128
+ :id)
1129
+ SENSITIVE = []
1130
+ include Aws::Structure
1131
+ end
1132
+
1133
+ # The request for StartInstanceOnboardingJob API.
1134
+ #
1135
+ # @note When making an API call, you may pass StartInstanceOnboardingJobRequest
1136
+ # data as a hash:
1137
+ #
1138
+ # {
1139
+ # connect_instance_id: "InstanceId", # required
1140
+ # encryption_config: { # required
1141
+ # enabled: false, # required
1142
+ # encryption_type: "KMS", # accepts KMS
1143
+ # key_arn: "EncryptionKey",
1144
+ # },
1145
+ # }
1146
+ #
1147
+ # @!attribute [rw] connect_instance_id
1148
+ # Amazon Connect Instance Id
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] encryption_config
1152
+ # Encryption config for Connect Instance. Note that sensitive data
1153
+ # will always be encrypted. If disabled, service will perform
1154
+ # encryption with its own key. If enabled, a KMS key id needs to be
1155
+ # provided and KMS charges will apply. KMS is only type supported
1156
+ # @return [Types::EncryptionConfig]
1157
+ #
1158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/StartInstanceOnboardingJobRequest AWS API Documentation
1159
+ #
1160
+ class StartInstanceOnboardingJobRequest < Struct.new(
1161
+ :connect_instance_id,
1162
+ :encryption_config)
1163
+ SENSITIVE = []
1164
+ include Aws::Structure
1165
+ end
1166
+
1167
+ # The response for StartInstanceOnboardingJob API.
1168
+ #
1169
+ # @!attribute [rw] connect_instance_onboarding_job_status
1170
+ # Instance onboarding job status object
1171
+ # @return [Types::InstanceOnboardingJobStatus]
1172
+ #
1173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/StartInstanceOnboardingJobResponse AWS API Documentation
1174
+ #
1175
+ class StartInstanceOnboardingJobResponse < Struct.new(
1176
+ :connect_instance_onboarding_job_status)
1177
+ SENSITIVE = []
1178
+ include Aws::Structure
1179
+ end
1180
+
1181
+ # StopCampaignRequest
1182
+ #
1183
+ # @note When making an API call, you may pass StopCampaignRequest
1184
+ # data as a hash:
1185
+ #
1186
+ # {
1187
+ # id: "CampaignId", # required
1188
+ # }
1189
+ #
1190
+ # @!attribute [rw] id
1191
+ # Identifier representing a Campaign
1192
+ # @return [String]
1193
+ #
1194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/StopCampaignRequest AWS API Documentation
1195
+ #
1196
+ class StopCampaignRequest < Struct.new(
1197
+ :id)
1198
+ SENSITIVE = []
1199
+ include Aws::Structure
1200
+ end
1201
+
1202
+ # Successful response of campaign state
1203
+ #
1204
+ # @!attribute [rw] campaign_id
1205
+ # Identifier representing a Campaign
1206
+ # @return [String]
1207
+ #
1208
+ # @!attribute [rw] state
1209
+ # State of a campaign
1210
+ # @return [String]
1211
+ #
1212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/SuccessfulCampaignStateResponse AWS API Documentation
1213
+ #
1214
+ class SuccessfulCampaignStateResponse < Struct.new(
1215
+ :campaign_id,
1216
+ :state)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
1221
+ # A successful request identified by the unique client token.
1222
+ #
1223
+ # @!attribute [rw] client_token
1224
+ # Client provided parameter used for idempotency. Its value must be
1225
+ # unique for each request.
1226
+ # @return [String]
1227
+ #
1228
+ # @!attribute [rw] id
1229
+ # Identifier representing a Dial request
1230
+ # @return [String]
1231
+ #
1232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/SuccessfulRequest AWS API Documentation
1233
+ #
1234
+ class SuccessfulRequest < Struct.new(
1235
+ :client_token,
1236
+ :id)
1237
+ SENSITIVE = []
1238
+ include Aws::Structure
1239
+ end
1240
+
1241
+ # TagResourceRequest
1242
+ #
1243
+ # @note When making an API call, you may pass TagResourceRequest
1244
+ # data as a hash:
1245
+ #
1246
+ # {
1247
+ # arn: "Arn", # required
1248
+ # tags: { # required
1249
+ # "TagKey" => "TagValue",
1250
+ # },
1251
+ # }
1252
+ #
1253
+ # @!attribute [rw] arn
1254
+ # Arn
1255
+ # @return [String]
1256
+ #
1257
+ # @!attribute [rw] tags
1258
+ # Tag map with key and value.
1259
+ # @return [Hash<String,String>]
1260
+ #
1261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/TagResourceRequest AWS API Documentation
1262
+ #
1263
+ class TagResourceRequest < Struct.new(
1264
+ :arn,
1265
+ :tags)
1266
+ SENSITIVE = []
1267
+ include Aws::Structure
1268
+ end
1269
+
1270
+ # The request was denied due to request throttling.
1271
+ #
1272
+ # @!attribute [rw] message
1273
+ # @return [String]
1274
+ #
1275
+ # @!attribute [rw] x_amz_error_type
1276
+ # A header that defines the error encountered while processing the
1277
+ # request.
1278
+ # @return [String]
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ThrottlingException AWS API Documentation
1281
+ #
1282
+ class ThrottlingException < Struct.new(
1283
+ :message,
1284
+ :x_amz_error_type)
1285
+ SENSITIVE = []
1286
+ include Aws::Structure
1287
+ end
1288
+
1289
+ # UntagResourceRequest
1290
+ #
1291
+ # @note When making an API call, you may pass UntagResourceRequest
1292
+ # data as a hash:
1293
+ #
1294
+ # {
1295
+ # arn: "Arn", # required
1296
+ # tag_keys: ["TagKey"], # required
1297
+ # }
1298
+ #
1299
+ # @!attribute [rw] arn
1300
+ # Arn
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] tag_keys
1304
+ # List of tag keys.
1305
+ # @return [Array<String>]
1306
+ #
1307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/UntagResourceRequest AWS API Documentation
1308
+ #
1309
+ class UntagResourceRequest < Struct.new(
1310
+ :arn,
1311
+ :tag_keys)
1312
+ SENSITIVE = []
1313
+ include Aws::Structure
1314
+ end
1315
+
1316
+ # UpdateCampaignDialerConfigRequest
1317
+ #
1318
+ # @note When making an API call, you may pass UpdateCampaignDialerConfigRequest
1319
+ # data as a hash:
1320
+ #
1321
+ # {
1322
+ # dialer_config: { # required
1323
+ # predictive_dialer_config: {
1324
+ # bandwidth_allocation: 1.0, # required
1325
+ # },
1326
+ # progressive_dialer_config: {
1327
+ # bandwidth_allocation: 1.0, # required
1328
+ # },
1329
+ # },
1330
+ # id: "CampaignId", # required
1331
+ # }
1332
+ #
1333
+ # @!attribute [rw] dialer_config
1334
+ # The possible types of dialer config parameters
1335
+ # @return [Types::DialerConfig]
1336
+ #
1337
+ # @!attribute [rw] id
1338
+ # Identifier representing a Campaign
1339
+ # @return [String]
1340
+ #
1341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/UpdateCampaignDialerConfigRequest AWS API Documentation
1342
+ #
1343
+ class UpdateCampaignDialerConfigRequest < Struct.new(
1344
+ :dialer_config,
1345
+ :id)
1346
+ SENSITIVE = []
1347
+ include Aws::Structure
1348
+ end
1349
+
1350
+ # UpdateCampaignNameRequest
1351
+ #
1352
+ # @note When making an API call, you may pass UpdateCampaignNameRequest
1353
+ # data as a hash:
1354
+ #
1355
+ # {
1356
+ # id: "CampaignId", # required
1357
+ # name: "CampaignName", # required
1358
+ # }
1359
+ #
1360
+ # @!attribute [rw] id
1361
+ # Identifier representing a Campaign
1362
+ # @return [String]
1363
+ #
1364
+ # @!attribute [rw] name
1365
+ # The name of an Amazon Connect Campaign name.
1366
+ # @return [String]
1367
+ #
1368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/UpdateCampaignNameRequest AWS API Documentation
1369
+ #
1370
+ class UpdateCampaignNameRequest < Struct.new(
1371
+ :id,
1372
+ :name)
1373
+ SENSITIVE = []
1374
+ include Aws::Structure
1375
+ end
1376
+
1377
+ # UpdateCampaignOutboundCallConfigRequest
1378
+ #
1379
+ # @note When making an API call, you may pass UpdateCampaignOutboundCallConfigRequest
1380
+ # data as a hash:
1381
+ #
1382
+ # {
1383
+ # answer_machine_detection_config: {
1384
+ # enable_answer_machine_detection: false, # required
1385
+ # },
1386
+ # connect_contact_flow_id: "ContactFlowId",
1387
+ # connect_source_phone_number: "SourcePhoneNumber",
1388
+ # id: "CampaignId", # required
1389
+ # }
1390
+ #
1391
+ # @!attribute [rw] answer_machine_detection_config
1392
+ # Answering Machine Detection config
1393
+ # @return [Types::AnswerMachineDetectionConfig]
1394
+ #
1395
+ # @!attribute [rw] connect_contact_flow_id
1396
+ # The identifier of the contact flow for the outbound call.
1397
+ # @return [String]
1398
+ #
1399
+ # @!attribute [rw] connect_source_phone_number
1400
+ # The phone number associated with the Amazon Connect instance, in
1401
+ # E.164 format. If you do not specify a source phone number, you must
1402
+ # specify a queue.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] id
1406
+ # Identifier representing a Campaign
1407
+ # @return [String]
1408
+ #
1409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfigRequest AWS API Documentation
1410
+ #
1411
+ class UpdateCampaignOutboundCallConfigRequest < Struct.new(
1412
+ :answer_machine_detection_config,
1413
+ :connect_contact_flow_id,
1414
+ :connect_source_phone_number,
1415
+ :id)
1416
+ SENSITIVE = []
1417
+ include Aws::Structure
1418
+ end
1419
+
1420
+ # The input fails to satisfy the constraints specified by an AWS
1421
+ # service.
1422
+ #
1423
+ # @!attribute [rw] message
1424
+ # @return [String]
1425
+ #
1426
+ # @!attribute [rw] x_amz_error_type
1427
+ # A header that defines the error encountered while processing the
1428
+ # request.
1429
+ # @return [String]
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaigns-2021-01-30/ValidationException AWS API Documentation
1432
+ #
1433
+ class ValidationException < Struct.new(
1434
+ :message,
1435
+ :x_amz_error_type)
1436
+ SENSITIVE = []
1437
+ include Aws::Structure
1438
+ end
1439
+
1440
+ end
1441
+ end