aws-sdk-connectcampaignsv2 1.0.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 (21) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +8 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-connectcampaignsv2/client.rb +1822 -0
  6. data/lib/aws-sdk-connectcampaignsv2/client_api.rb +1163 -0
  7. data/lib/aws-sdk-connectcampaignsv2/customizations.rb +0 -0
  8. data/lib/aws-sdk-connectcampaignsv2/endpoint_parameters.rb +69 -0
  9. data/lib/aws-sdk-connectcampaignsv2/endpoint_provider.rb +54 -0
  10. data/lib/aws-sdk-connectcampaignsv2/endpoints.rb +20 -0
  11. data/lib/aws-sdk-connectcampaignsv2/errors.rb +240 -0
  12. data/lib/aws-sdk-connectcampaignsv2/plugins/endpoints.rb +77 -0
  13. data/lib/aws-sdk-connectcampaignsv2/resource.rb +26 -0
  14. data/lib/aws-sdk-connectcampaignsv2/types.rb +2187 -0
  15. data/lib/aws-sdk-connectcampaignsv2.rb +61 -0
  16. data/sig/client.rbs +651 -0
  17. data/sig/errors.rbs +53 -0
  18. data/sig/resource.rbs +82 -0
  19. data/sig/types.rbs +724 -0
  20. data/sig/waiters.rbs +13 -0
  21. metadata +99 -0
data/sig/client.rbs ADDED
@@ -0,0 +1,651 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module ConnectCampaignsV2
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?account_id: String,
19
+ ?active_endpoint_cache: bool,
20
+ ?adaptive_retry_wait_to_fill: bool,
21
+ ?client_side_monitoring: bool,
22
+ ?client_side_monitoring_client_id: String,
23
+ ?client_side_monitoring_host: String,
24
+ ?client_side_monitoring_port: Integer,
25
+ ?client_side_monitoring_publisher: untyped,
26
+ ?convert_params: bool,
27
+ ?correct_clock_skew: bool,
28
+ ?defaults_mode: String,
29
+ ?disable_host_prefix_injection: bool,
30
+ ?disable_request_compression: bool,
31
+ ?endpoint: String,
32
+ ?endpoint_cache_max_entries: Integer,
33
+ ?endpoint_cache_max_threads: Integer,
34
+ ?endpoint_cache_poll_interval: Integer,
35
+ ?endpoint_discovery: bool,
36
+ ?ignore_configured_endpoint_urls: bool,
37
+ ?log_formatter: untyped,
38
+ ?log_level: Symbol,
39
+ ?logger: untyped,
40
+ ?max_attempts: Integer,
41
+ ?profile: String,
42
+ ?request_min_compression_size_bytes: Integer,
43
+ ?retry_backoff: Proc,
44
+ ?retry_base_delay: Float,
45
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
46
+ ?retry_limit: Integer,
47
+ ?retry_max_delay: Integer,
48
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
49
+ ?sdk_ua_app_id: String,
50
+ ?secret_access_key: String,
51
+ ?session_token: String,
52
+ ?sigv4a_signing_region_set: Array[String],
53
+ ?stub_responses: untyped,
54
+ ?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
55
+ ?token_provider: untyped,
56
+ ?use_dualstack_endpoint: bool,
57
+ ?use_fips_endpoint: bool,
58
+ ?validate_params: bool,
59
+ ?endpoint_provider: untyped,
60
+ ?http_proxy: String,
61
+ ?http_open_timeout: (Float | Integer),
62
+ ?http_read_timeout: (Float | Integer),
63
+ ?http_idle_timeout: (Float | Integer),
64
+ ?http_continue_timeout: (Float | Integer),
65
+ ?ssl_timeout: (Float | Integer | nil),
66
+ ?http_wire_trace: bool,
67
+ ?ssl_verify_peer: bool,
68
+ ?ssl_ca_bundle: String,
69
+ ?ssl_ca_directory: String,
70
+ ?ssl_ca_store: String,
71
+ ?on_chunk_received: Proc,
72
+ ?on_chunk_sent: Proc,
73
+ ?raise_response_errors: bool
74
+ ) -> instance
75
+ | (?Hash[Symbol, untyped]) -> instance
76
+
77
+
78
+ interface _CreateCampaignResponseSuccess
79
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateCampaignResponse]
80
+ def id: () -> ::String
81
+ def arn: () -> ::String
82
+ def tags: () -> ::Hash[::String, ::String]
83
+ end
84
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#create_campaign-instance_method
85
+ def create_campaign: (
86
+ name: ::String,
87
+ connect_instance_id: ::String,
88
+ channel_subtype_config: {
89
+ telephony: {
90
+ capacity: ::Float?,
91
+ connect_queue_id: ::String?,
92
+ outbound_mode: {
93
+ progressive: {
94
+ bandwidth_allocation: ::Float
95
+ }?,
96
+ predictive: {
97
+ bandwidth_allocation: ::Float
98
+ }?,
99
+ agentless: {
100
+ }?
101
+ },
102
+ default_outbound_config: {
103
+ connect_contact_flow_id: ::String,
104
+ connect_source_phone_number: ::String?,
105
+ answer_machine_detection_config: {
106
+ enable_answer_machine_detection: bool,
107
+ await_answer_machine_prompt: bool?
108
+ }?
109
+ }
110
+ }?,
111
+ sms: {
112
+ capacity: ::Float?,
113
+ outbound_mode: {
114
+ agentless: {
115
+ }?
116
+ },
117
+ default_outbound_config: {
118
+ connect_source_phone_number_arn: ::String,
119
+ wisdom_template_arn: ::String
120
+ }
121
+ }?,
122
+ email: {
123
+ capacity: ::Float?,
124
+ outbound_mode: {
125
+ agentless: {
126
+ }?
127
+ },
128
+ default_outbound_config: {
129
+ connect_source_email_address: ::String,
130
+ source_email_address_display_name: ::String?,
131
+ wisdom_template_arn: ::String
132
+ }
133
+ }?
134
+ },
135
+ ?source: {
136
+ customer_profiles_segment_arn: ::String?
137
+ },
138
+ ?connect_campaign_flow_arn: ::String,
139
+ ?schedule: {
140
+ start_time: ::Time,
141
+ end_time: ::Time,
142
+ refresh_frequency: ::String?
143
+ },
144
+ ?communication_time_config: {
145
+ local_time_zone_config: {
146
+ default_time_zone: ::String?,
147
+ local_time_zone_detection: Array[("ZIP_CODE" | "AREA_CODE")]?
148
+ },
149
+ telephony: {
150
+ open_hours: {
151
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
152
+ {
153
+ start_time: ::String,
154
+ end_time: ::String
155
+ },
156
+ ]]?
157
+ },
158
+ restricted_periods: {
159
+ restricted_period_list: Array[
160
+ {
161
+ name: ::String?,
162
+ start_date: ::String,
163
+ end_date: ::String
164
+ },
165
+ ]?
166
+ }?
167
+ }?,
168
+ sms: {
169
+ open_hours: {
170
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
171
+ {
172
+ start_time: ::String,
173
+ end_time: ::String
174
+ },
175
+ ]]?
176
+ },
177
+ restricted_periods: {
178
+ restricted_period_list: Array[
179
+ {
180
+ name: ::String?,
181
+ start_date: ::String,
182
+ end_date: ::String
183
+ },
184
+ ]?
185
+ }?
186
+ }?,
187
+ email: {
188
+ open_hours: {
189
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
190
+ {
191
+ start_time: ::String,
192
+ end_time: ::String
193
+ },
194
+ ]]?
195
+ },
196
+ restricted_periods: {
197
+ restricted_period_list: Array[
198
+ {
199
+ name: ::String?,
200
+ start_date: ::String,
201
+ end_date: ::String
202
+ },
203
+ ]?
204
+ }?
205
+ }?
206
+ },
207
+ ?communication_limits_override: {
208
+ all_channel_subtypes: {
209
+ communication_limits_list: Array[
210
+ {
211
+ max_count_per_recipient: ::Integer,
212
+ frequency: ::Integer,
213
+ unit: ("DAY")
214
+ },
215
+ ]?
216
+ }?
217
+ },
218
+ ?tags: Hash[::String, ::String]
219
+ ) -> _CreateCampaignResponseSuccess
220
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCampaignResponseSuccess
221
+
222
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_campaign-instance_method
223
+ def delete_campaign: (
224
+ id: ::String
225
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
226
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
227
+
228
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_campaign_channel_subtype_config-instance_method
229
+ def delete_campaign_channel_subtype_config: (
230
+ id: ::String,
231
+ channel_subtype: ("TELEPHONY" | "SMS" | "EMAIL")
232
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
233
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
234
+
235
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_campaign_communication_limits-instance_method
236
+ def delete_campaign_communication_limits: (
237
+ id: ::String,
238
+ config: ("ALL_CHANNEL_SUBTYPES")
239
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
240
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
241
+
242
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_campaign_communication_time-instance_method
243
+ def delete_campaign_communication_time: (
244
+ id: ::String,
245
+ config: ("TELEPHONY" | "SMS" | "EMAIL")
246
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
247
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
248
+
249
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_connect_instance_config-instance_method
250
+ def delete_connect_instance_config: (
251
+ connect_instance_id: ::String,
252
+ ?campaign_deletion_policy: ("RETAIN_ALL" | "DELETE_ALL")
253
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
254
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
255
+
256
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_connect_instance_integration-instance_method
257
+ def delete_connect_instance_integration: (
258
+ connect_instance_id: ::String,
259
+ integration_identifier: {
260
+ customer_profiles: {
261
+ domain_arn: ::String
262
+ }?,
263
+ q_connect: {
264
+ knowledge_base_arn: ::String
265
+ }?
266
+ }
267
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
268
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
269
+
270
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#delete_instance_onboarding_job-instance_method
271
+ def delete_instance_onboarding_job: (
272
+ connect_instance_id: ::String
273
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
274
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
275
+
276
+ interface _DescribeCampaignResponseSuccess
277
+ include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCampaignResponse]
278
+ def campaign: () -> Types::Campaign
279
+ end
280
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#describe_campaign-instance_method
281
+ def describe_campaign: (
282
+ id: ::String
283
+ ) -> _DescribeCampaignResponseSuccess
284
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCampaignResponseSuccess
285
+
286
+ interface _GetCampaignStateResponseSuccess
287
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignStateResponse]
288
+ def state: () -> ("Initialized" | "Running" | "Paused" | "Stopped" | "Failed" | "Completed")
289
+ end
290
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#get_campaign_state-instance_method
291
+ def get_campaign_state: (
292
+ id: ::String
293
+ ) -> _GetCampaignStateResponseSuccess
294
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignStateResponseSuccess
295
+
296
+ interface _GetCampaignStateBatchResponseSuccess
297
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetCampaignStateBatchResponse]
298
+ def successful_requests: () -> ::Array[Types::SuccessfulCampaignStateResponse]
299
+ def failed_requests: () -> ::Array[Types::FailedCampaignStateResponse]
300
+ end
301
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#get_campaign_state_batch-instance_method
302
+ def get_campaign_state_batch: (
303
+ campaign_ids: Array[::String]
304
+ ) -> _GetCampaignStateBatchResponseSuccess
305
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCampaignStateBatchResponseSuccess
306
+
307
+ interface _GetConnectInstanceConfigResponseSuccess
308
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetConnectInstanceConfigResponse]
309
+ def connect_instance_config: () -> Types::InstanceConfig
310
+ end
311
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#get_connect_instance_config-instance_method
312
+ def get_connect_instance_config: (
313
+ connect_instance_id: ::String
314
+ ) -> _GetConnectInstanceConfigResponseSuccess
315
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetConnectInstanceConfigResponseSuccess
316
+
317
+ interface _GetInstanceOnboardingJobStatusResponseSuccess
318
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetInstanceOnboardingJobStatusResponse]
319
+ def connect_instance_onboarding_job_status: () -> Types::InstanceOnboardingJobStatus
320
+ end
321
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#get_instance_onboarding_job_status-instance_method
322
+ def get_instance_onboarding_job_status: (
323
+ connect_instance_id: ::String
324
+ ) -> _GetInstanceOnboardingJobStatusResponseSuccess
325
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetInstanceOnboardingJobStatusResponseSuccess
326
+
327
+ interface _ListCampaignsResponseSuccess
328
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListCampaignsResponse]
329
+ def next_token: () -> ::String
330
+ def campaign_summary_list: () -> ::Array[Types::CampaignSummary]
331
+ end
332
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#list_campaigns-instance_method
333
+ def list_campaigns: (
334
+ ?max_results: ::Integer,
335
+ ?next_token: ::String,
336
+ ?filters: {
337
+ instance_id_filter: {
338
+ value: ::String,
339
+ operator: ("Eq")
340
+ }?
341
+ }
342
+ ) -> _ListCampaignsResponseSuccess
343
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCampaignsResponseSuccess
344
+
345
+ interface _ListConnectInstanceIntegrationsResponseSuccess
346
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListConnectInstanceIntegrationsResponse]
347
+ def next_token: () -> ::String
348
+ def integration_summary_list: () -> ::Array[Types::IntegrationSummary]
349
+ end
350
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#list_connect_instance_integrations-instance_method
351
+ def list_connect_instance_integrations: (
352
+ connect_instance_id: ::String,
353
+ ?max_results: ::Integer,
354
+ ?next_token: ::String
355
+ ) -> _ListConnectInstanceIntegrationsResponseSuccess
356
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListConnectInstanceIntegrationsResponseSuccess
357
+
358
+ interface _ListTagsForResourceResponseSuccess
359
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
360
+ def tags: () -> ::Hash[::String, ::String]
361
+ end
362
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#list_tags_for_resource-instance_method
363
+ def list_tags_for_resource: (
364
+ arn: ::String
365
+ ) -> _ListTagsForResourceResponseSuccess
366
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
367
+
368
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#pause_campaign-instance_method
369
+ def pause_campaign: (
370
+ id: ::String
371
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
372
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
373
+
374
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#put_connect_instance_integration-instance_method
375
+ def put_connect_instance_integration: (
376
+ connect_instance_id: ::String,
377
+ integration_config: {
378
+ customer_profiles: {
379
+ domain_arn: ::String,
380
+ object_type_names: Hash[("Campaign-Email" | "Campaign-SMS" | "Campaign-Telephony" | "Campaign-Orchestration"), ::String]
381
+ }?,
382
+ q_connect: {
383
+ knowledge_base_arn: ::String
384
+ }?
385
+ }
386
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
387
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
388
+
389
+ interface _PutOutboundRequestBatchResponseSuccess
390
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutOutboundRequestBatchResponse]
391
+ def successful_requests: () -> ::Array[Types::SuccessfulRequest]
392
+ def failed_requests: () -> ::Array[Types::FailedRequest]
393
+ end
394
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#put_outbound_request_batch-instance_method
395
+ def put_outbound_request_batch: (
396
+ id: ::String,
397
+ outbound_requests: Array[
398
+ {
399
+ client_token: ::String,
400
+ expiration_time: ::Time,
401
+ channel_subtype_parameters: {
402
+ telephony: {
403
+ destination_phone_number: ::String,
404
+ attributes: Hash[::String, ::String],
405
+ connect_source_phone_number: ::String?,
406
+ answer_machine_detection_config: {
407
+ enable_answer_machine_detection: bool,
408
+ await_answer_machine_prompt: bool?
409
+ }?
410
+ }?,
411
+ sms: {
412
+ destination_phone_number: ::String,
413
+ connect_source_phone_number_arn: ::String?,
414
+ template_arn: ::String?,
415
+ template_parameters: Hash[::String, ::String]
416
+ }?,
417
+ email: {
418
+ destination_email_address: ::String,
419
+ connect_source_email_address: ::String?,
420
+ template_arn: ::String?,
421
+ template_parameters: Hash[::String, ::String]
422
+ }?
423
+ }
424
+ },
425
+ ]
426
+ ) -> _PutOutboundRequestBatchResponseSuccess
427
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutOutboundRequestBatchResponseSuccess
428
+
429
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#resume_campaign-instance_method
430
+ def resume_campaign: (
431
+ id: ::String
432
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
433
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
434
+
435
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#start_campaign-instance_method
436
+ def start_campaign: (
437
+ id: ::String
438
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
439
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
440
+
441
+ interface _StartInstanceOnboardingJobResponseSuccess
442
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartInstanceOnboardingJobResponse]
443
+ def connect_instance_onboarding_job_status: () -> Types::InstanceOnboardingJobStatus
444
+ end
445
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#start_instance_onboarding_job-instance_method
446
+ def start_instance_onboarding_job: (
447
+ connect_instance_id: ::String,
448
+ encryption_config: {
449
+ enabled: bool,
450
+ encryption_type: ("KMS")?,
451
+ key_arn: ::String?
452
+ }
453
+ ) -> _StartInstanceOnboardingJobResponseSuccess
454
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartInstanceOnboardingJobResponseSuccess
455
+
456
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#stop_campaign-instance_method
457
+ def stop_campaign: (
458
+ id: ::String
459
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
460
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
461
+
462
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#tag_resource-instance_method
463
+ def tag_resource: (
464
+ arn: ::String,
465
+ tags: Hash[::String, ::String]
466
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
467
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
468
+
469
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#untag_resource-instance_method
470
+ def untag_resource: (
471
+ arn: ::String,
472
+ tag_keys: Array[::String]
473
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
474
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
475
+
476
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_channel_subtype_config-instance_method
477
+ def update_campaign_channel_subtype_config: (
478
+ id: ::String,
479
+ channel_subtype_config: {
480
+ telephony: {
481
+ capacity: ::Float?,
482
+ connect_queue_id: ::String?,
483
+ outbound_mode: {
484
+ progressive: {
485
+ bandwidth_allocation: ::Float
486
+ }?,
487
+ predictive: {
488
+ bandwidth_allocation: ::Float
489
+ }?,
490
+ agentless: {
491
+ }?
492
+ },
493
+ default_outbound_config: {
494
+ connect_contact_flow_id: ::String,
495
+ connect_source_phone_number: ::String?,
496
+ answer_machine_detection_config: {
497
+ enable_answer_machine_detection: bool,
498
+ await_answer_machine_prompt: bool?
499
+ }?
500
+ }
501
+ }?,
502
+ sms: {
503
+ capacity: ::Float?,
504
+ outbound_mode: {
505
+ agentless: {
506
+ }?
507
+ },
508
+ default_outbound_config: {
509
+ connect_source_phone_number_arn: ::String,
510
+ wisdom_template_arn: ::String
511
+ }
512
+ }?,
513
+ email: {
514
+ capacity: ::Float?,
515
+ outbound_mode: {
516
+ agentless: {
517
+ }?
518
+ },
519
+ default_outbound_config: {
520
+ connect_source_email_address: ::String,
521
+ source_email_address_display_name: ::String?,
522
+ wisdom_template_arn: ::String
523
+ }
524
+ }?
525
+ }
526
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
527
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
528
+
529
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_communication_limits-instance_method
530
+ def update_campaign_communication_limits: (
531
+ id: ::String,
532
+ communication_limits_override: {
533
+ all_channel_subtypes: {
534
+ communication_limits_list: Array[
535
+ {
536
+ max_count_per_recipient: ::Integer,
537
+ frequency: ::Integer,
538
+ unit: ("DAY")
539
+ },
540
+ ]?
541
+ }?
542
+ }
543
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
544
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
545
+
546
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_communication_time-instance_method
547
+ def update_campaign_communication_time: (
548
+ id: ::String,
549
+ communication_time_config: {
550
+ local_time_zone_config: {
551
+ default_time_zone: ::String?,
552
+ local_time_zone_detection: Array[("ZIP_CODE" | "AREA_CODE")]?
553
+ },
554
+ telephony: {
555
+ open_hours: {
556
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
557
+ {
558
+ start_time: ::String,
559
+ end_time: ::String
560
+ },
561
+ ]]?
562
+ },
563
+ restricted_periods: {
564
+ restricted_period_list: Array[
565
+ {
566
+ name: ::String?,
567
+ start_date: ::String,
568
+ end_date: ::String
569
+ },
570
+ ]?
571
+ }?
572
+ }?,
573
+ sms: {
574
+ open_hours: {
575
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
576
+ {
577
+ start_time: ::String,
578
+ end_time: ::String
579
+ },
580
+ ]]?
581
+ },
582
+ restricted_periods: {
583
+ restricted_period_list: Array[
584
+ {
585
+ name: ::String?,
586
+ start_date: ::String,
587
+ end_date: ::String
588
+ },
589
+ ]?
590
+ }?
591
+ }?,
592
+ email: {
593
+ open_hours: {
594
+ daily_hours: Hash[("MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY"), Array[
595
+ {
596
+ start_time: ::String,
597
+ end_time: ::String
598
+ },
599
+ ]]?
600
+ },
601
+ restricted_periods: {
602
+ restricted_period_list: Array[
603
+ {
604
+ name: ::String?,
605
+ start_date: ::String,
606
+ end_date: ::String
607
+ },
608
+ ]?
609
+ }?
610
+ }?
611
+ }
612
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
613
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
614
+
615
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_flow_association-instance_method
616
+ def update_campaign_flow_association: (
617
+ id: ::String,
618
+ connect_campaign_flow_arn: ::String
619
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
620
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
621
+
622
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_name-instance_method
623
+ def update_campaign_name: (
624
+ id: ::String,
625
+ name: ::String
626
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
627
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
628
+
629
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_schedule-instance_method
630
+ def update_campaign_schedule: (
631
+ id: ::String,
632
+ schedule: {
633
+ start_time: ::Time,
634
+ end_time: ::Time,
635
+ refresh_frequency: ::String?
636
+ }
637
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
638
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
639
+
640
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#update_campaign_source-instance_method
641
+ def update_campaign_source: (
642
+ id: ::String,
643
+ source: {
644
+ customer_profiles_segment_arn: ::String?
645
+ }
646
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
647
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
648
+ end
649
+ end
650
+ end
651
+