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.
@@ -0,0 +1,1822 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
29
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
30
+ require 'aws-sdk-core/plugins/http_checksum.rb'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
+ require 'aws-sdk-core/plugins/request_compression.rb'
33
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
34
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/telemetry.rb'
36
+ require 'aws-sdk-core/plugins/sign.rb'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
38
+
39
+ module Aws::ConnectCampaignsV2
40
+ # An API client for ConnectCampaignsV2. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::ConnectCampaignsV2::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :connectcampaignsv2
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::ConnectCampaignsV2::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials. This can be an instance of any one of the
99
+ # following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following
128
+ # locations will be searched for credentials:
129
+ #
130
+ # * `Aws.config[:credentials]`
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
+ # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
135
+ # * `~/.aws/credentials`
136
+ # * `~/.aws/config`
137
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
+ # are very aggressive. Construct and pass an instance of
139
+ # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
+ # enable retries and extended timeouts. Instance profile credential
141
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
+ # to true.
143
+ #
144
+ # @option options [required, String] :region
145
+ # The AWS region to connect to. The configured `:region` is
146
+ # used to determine the service `:endpoint`. When not passed,
147
+ # a default `:region` is searched for in the following locations:
148
+ #
149
+ # * `Aws.config[:region]`
150
+ # * `ENV['AWS_REGION']`
151
+ # * `ENV['AMAZON_REGION']`
152
+ # * `ENV['AWS_DEFAULT_REGION']`
153
+ # * `~/.aws/credentials`
154
+ # * `~/.aws/config`
155
+ #
156
+ # @option options [String] :access_key_id
157
+ #
158
+ # @option options [String] :account_id
159
+ #
160
+ # @option options [Boolean] :active_endpoint_cache (false)
161
+ # When set to `true`, a thread polling for endpoints will be running in
162
+ # the background every 60 secs (default). Defaults to `false`.
163
+ #
164
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
165
+ # Used only in `adaptive` retry mode. When true, the request will sleep
166
+ # until there is sufficent client side capacity to retry the request.
167
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
+ # not retry instead of sleeping.
169
+ #
170
+ # @option options [Boolean] :client_side_monitoring (false)
171
+ # When `true`, client-side metrics will be collected for all API requests from
172
+ # this client.
173
+ #
174
+ # @option options [String] :client_side_monitoring_client_id ("")
175
+ # Allows you to provide an identifier for this client which will be attached to
176
+ # all generated client side metrics. Defaults to an empty string.
177
+ #
178
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
179
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
180
+ # side monitoring agent is running on, where client metrics will be published via UDP.
181
+ #
182
+ # @option options [Integer] :client_side_monitoring_port (31000)
183
+ # Required for publishing client metrics. The port that the client side monitoring
184
+ # agent is running on, where client metrics will be published via UDP.
185
+ #
186
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
187
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
188
+ # will use the Client Side Monitoring Agent Publisher.
189
+ #
190
+ # @option options [Boolean] :convert_params (true)
191
+ # When `true`, an attempt is made to coerce request parameters into
192
+ # the required types.
193
+ #
194
+ # @option options [Boolean] :correct_clock_skew (true)
195
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
196
+ # a clock skew correction and retry requests with skewed client clocks.
197
+ #
198
+ # @option options [String] :defaults_mode ("legacy")
199
+ # See {Aws::DefaultsModeConfiguration} for a list of the
200
+ # accepted modes and the configuration defaults that are included.
201
+ #
202
+ # @option options [Boolean] :disable_host_prefix_injection (false)
203
+ # Set to true to disable SDK automatically adding host prefix
204
+ # to default service endpoint when available.
205
+ #
206
+ # @option options [Boolean] :disable_request_compression (false)
207
+ # When set to 'true' the request body will not be compressed
208
+ # for supported operations.
209
+ #
210
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
211
+ # Normally you should not configure the `:endpoint` option
212
+ # directly. This is normally constructed from the `:region`
213
+ # option. Configuring `:endpoint` is normally reserved for
214
+ # connecting to test or custom endpoints. The endpoint should
215
+ # be a URI formatted like:
216
+ #
217
+ # 'http://example.com'
218
+ # 'https://example.com'
219
+ # 'http://example.com:123'
220
+ #
221
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
222
+ # Used for the maximum size limit of the LRU cache storing endpoints data
223
+ # for endpoint discovery enabled operations. Defaults to 1000.
224
+ #
225
+ # @option options [Integer] :endpoint_cache_max_threads (10)
226
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
227
+ #
228
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
229
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
230
+ # Use this option to config the time interval in seconds for making
231
+ # requests fetching endpoints information. Defaults to 60 sec.
232
+ #
233
+ # @option options [Boolean] :endpoint_discovery (false)
234
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
235
+ #
236
+ # @option options [Boolean] :ignore_configured_endpoint_urls
237
+ # Setting to true disables use of endpoint URLs provided via environment
238
+ # variables and the shared configuration file.
239
+ #
240
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
241
+ # The log formatter.
242
+ #
243
+ # @option options [Symbol] :log_level (:info)
244
+ # The log level to send messages to the `:logger` at.
245
+ #
246
+ # @option options [Logger] :logger
247
+ # The Logger instance to send log messages to. If this option
248
+ # is not set, logging will be disabled.
249
+ #
250
+ # @option options [Integer] :max_attempts (3)
251
+ # An integer representing the maximum number attempts that will be made for
252
+ # a single request, including the initial attempt. For example,
253
+ # setting this value to 5 will result in a request being retried up to
254
+ # 4 times. Used in `standard` and `adaptive` retry modes.
255
+ #
256
+ # @option options [String] :profile ("default")
257
+ # Used when loading credentials from the shared credentials file
258
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
259
+ #
260
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
261
+ # The minimum size in bytes that triggers compression for request
262
+ # bodies. The value must be non-negative integer value between 0
263
+ # and 10485780 bytes inclusive.
264
+ #
265
+ # @option options [Proc] :retry_backoff
266
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
267
+ # This option is only used in the `legacy` retry mode.
268
+ #
269
+ # @option options [Float] :retry_base_delay (0.3)
270
+ # The base delay in seconds used by the default backoff function. This option
271
+ # is only used in the `legacy` retry mode.
272
+ #
273
+ # @option options [Symbol] :retry_jitter (:none)
274
+ # A delay randomiser function used by the default backoff function.
275
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
276
+ # otherwise a Proc that takes and returns a number. This option is only used
277
+ # in the `legacy` retry mode.
278
+ #
279
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
280
+ #
281
+ # @option options [Integer] :retry_limit (3)
282
+ # The maximum number of times to retry failed requests. Only
283
+ # ~ 500 level server errors and certain ~ 400 level client errors
284
+ # are retried. Generally, these are throttling errors, data
285
+ # checksum errors, networking errors, timeout errors, auth errors,
286
+ # endpoint discovery, and errors from expired credentials.
287
+ # This option is only used in the `legacy` retry mode.
288
+ #
289
+ # @option options [Integer] :retry_max_delay (0)
290
+ # The maximum number of seconds to delay between retries (0 for no limit)
291
+ # used by the default backoff function. This option is only used in the
292
+ # `legacy` retry mode.
293
+ #
294
+ # @option options [String] :retry_mode ("legacy")
295
+ # Specifies which retry algorithm to use. Values are:
296
+ #
297
+ # * `legacy` - The pre-existing retry behavior. This is default value if
298
+ # no retry mode is provided.
299
+ #
300
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
301
+ # This includes support for retry quotas, which limit the number of
302
+ # unsuccessful retries a client can make.
303
+ #
304
+ # * `adaptive` - An experimental retry mode that includes all the
305
+ # functionality of `standard` mode along with automatic client side
306
+ # throttling. This is a provisional mode that may change behavior
307
+ # in the future.
308
+ #
309
+ # @option options [String] :sdk_ua_app_id
310
+ # A unique and opaque application ID that is appended to the
311
+ # User-Agent header as app/sdk_ua_app_id. It should have a
312
+ # maximum length of 50. This variable is sourced from environment
313
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
314
+ #
315
+ # @option options [String] :secret_access_key
316
+ #
317
+ # @option options [String] :session_token
318
+ #
319
+ # @option options [Array] :sigv4a_signing_region_set
320
+ # A list of regions that should be signed with SigV4a signing. When
321
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
322
+ # in the following locations:
323
+ #
324
+ # * `Aws.config[:sigv4a_signing_region_set]`
325
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
326
+ # * `~/.aws/config`
327
+ #
328
+ # @option options [Boolean] :stub_responses (false)
329
+ # Causes the client to return stubbed responses. By default
330
+ # fake responses are generated and returned. You can specify
331
+ # the response data to return or errors to raise by calling
332
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
333
+ #
334
+ # ** Please note ** When response stubbing is enabled, no HTTP
335
+ # requests are made, and retries are disabled.
336
+ #
337
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
338
+ # Allows you to provide a telemetry provider, which is used to
339
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
340
+ # will not record or emit any telemetry data. The SDK supports the
341
+ # following telemetry providers:
342
+ #
343
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
344
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
345
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
346
+ #
347
+ # @option options [Aws::TokenProvider] :token_provider
348
+ # A Bearer Token Provider. This can be an instance of any one of the
349
+ # following classes:
350
+ #
351
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
352
+ # tokens.
353
+ #
354
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
355
+ # access token generated from `aws login`.
356
+ #
357
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
358
+ # will be used to search for tokens configured for your profile in shared configuration files.
359
+ #
360
+ # @option options [Boolean] :use_dualstack_endpoint
361
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
362
+ # will be used if available.
363
+ #
364
+ # @option options [Boolean] :use_fips_endpoint
365
+ # When set to `true`, fips compatible endpoints will be used if available.
366
+ # When a `fips` region is used, the region is normalized and this config
367
+ # is set to `true`.
368
+ #
369
+ # @option options [Boolean] :validate_params (true)
370
+ # When `true`, request parameters are validated before
371
+ # sending the request.
372
+ #
373
+ # @option options [Aws::ConnectCampaignsV2::EndpointProvider] :endpoint_provider
374
+ # The endpoint provider used to resolve endpoints. Any object that responds to
375
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
376
+ # `Aws::ConnectCampaignsV2::EndpointParameters`.
377
+ #
378
+ # @option options [Float] :http_continue_timeout (1)
379
+ # The number of seconds to wait for a 100-continue response before sending the
380
+ # request body. This option has no effect unless the request has "Expect"
381
+ # header set to "100-continue". Defaults to `nil` which disables this
382
+ # behaviour. This value can safely be set per request on the session.
383
+ #
384
+ # @option options [Float] :http_idle_timeout (5)
385
+ # The number of seconds a connection is allowed to sit idle before it
386
+ # is considered stale. Stale connections are closed and removed from the
387
+ # pool before making a request.
388
+ #
389
+ # @option options [Float] :http_open_timeout (15)
390
+ # The default number of seconds to wait for response data.
391
+ # This value can safely be set per-request on the session.
392
+ #
393
+ # @option options [URI::HTTP,String] :http_proxy
394
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
395
+ #
396
+ # @option options [Float] :http_read_timeout (60)
397
+ # The default number of seconds to wait for response data.
398
+ # This value can safely be set per-request on the session.
399
+ #
400
+ # @option options [Boolean] :http_wire_trace (false)
401
+ # When `true`, HTTP debug output will be sent to the `:logger`.
402
+ #
403
+ # @option options [Proc] :on_chunk_received
404
+ # When a Proc object is provided, it will be used as callback when each chunk
405
+ # of the response body is received. It provides three arguments: the chunk,
406
+ # the number of bytes received, and the total number of
407
+ # bytes in the response (or nil if the server did not send a `content-length`).
408
+ #
409
+ # @option options [Proc] :on_chunk_sent
410
+ # When a Proc object is provided, it will be used as callback when each chunk
411
+ # of the request body is sent. It provides three arguments: the chunk,
412
+ # the number of bytes read from the body, and the total number of
413
+ # bytes in the body.
414
+ #
415
+ # @option options [Boolean] :raise_response_errors (true)
416
+ # When `true`, response errors are raised.
417
+ #
418
+ # @option options [String] :ssl_ca_bundle
419
+ # Full path to the SSL certificate authority bundle file that should be used when
420
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
421
+ # `:ssl_ca_directory` the the system default will be used if available.
422
+ #
423
+ # @option options [String] :ssl_ca_directory
424
+ # Full path of the directory that contains the unbundled SSL certificate
425
+ # authority files for verifying peer certificates. If you do
426
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
427
+ # default will be used if available.
428
+ #
429
+ # @option options [String] :ssl_ca_store
430
+ # Sets the X509::Store to verify peer certificate.
431
+ #
432
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
433
+ # Sets a client certificate when creating http connections.
434
+ #
435
+ # @option options [OpenSSL::PKey] :ssl_key
436
+ # Sets a client key when creating http connections.
437
+ #
438
+ # @option options [Float] :ssl_timeout
439
+ # Sets the SSL timeout in seconds
440
+ #
441
+ # @option options [Boolean] :ssl_verify_peer (true)
442
+ # When `true`, SSL peer certificates are verified when establishing a connection.
443
+ #
444
+ def initialize(*args)
445
+ super
446
+ end
447
+
448
+ # @!group API Operations
449
+
450
+ # Creates a campaign for the specified Amazon Connect account. This API
451
+ # is idempotent.
452
+ #
453
+ # @option params [required, String] :name
454
+ # The name of an Amazon Connect Campaign name.
455
+ #
456
+ # @option params [required, String] :connect_instance_id
457
+ # Amazon Connect Instance Id
458
+ #
459
+ # @option params [required, Types::ChannelSubtypeConfig] :channel_subtype_config
460
+ # Campaign Channel Subtype config
461
+ #
462
+ # @option params [Types::Source] :source
463
+ # Source of the campaign
464
+ #
465
+ # @option params [String] :connect_campaign_flow_arn
466
+ # Amazon Resource Names(ARN)
467
+ #
468
+ # @option params [Types::Schedule] :schedule
469
+ # Campaign schedule
470
+ #
471
+ # @option params [Types::CommunicationTimeConfig] :communication_time_config
472
+ # Campaign communication time config
473
+ #
474
+ # @option params [Types::CommunicationLimitsConfig] :communication_limits_override
475
+ # Communication limits config
476
+ #
477
+ # @option params [Hash<String,String>] :tags
478
+ # Tag map with key and value.
479
+ #
480
+ # @return [Types::CreateCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
481
+ #
482
+ # * {Types::CreateCampaignResponse#id #id} => String
483
+ # * {Types::CreateCampaignResponse#arn #arn} => String
484
+ # * {Types::CreateCampaignResponse#tags #tags} => Hash&lt;String,String&gt;
485
+ #
486
+ # @example Request syntax with placeholder values
487
+ #
488
+ # resp = client.create_campaign({
489
+ # name: "CampaignName", # required
490
+ # connect_instance_id: "InstanceId", # required
491
+ # channel_subtype_config: { # required
492
+ # telephony: {
493
+ # capacity: 1.0,
494
+ # connect_queue_id: "QueueId",
495
+ # outbound_mode: { # required
496
+ # progressive: {
497
+ # bandwidth_allocation: 1.0, # required
498
+ # },
499
+ # predictive: {
500
+ # bandwidth_allocation: 1.0, # required
501
+ # },
502
+ # agentless: {
503
+ # },
504
+ # },
505
+ # default_outbound_config: { # required
506
+ # connect_contact_flow_id: "ContactFlowId", # required
507
+ # connect_source_phone_number: "SourcePhoneNumber",
508
+ # answer_machine_detection_config: {
509
+ # enable_answer_machine_detection: false, # required
510
+ # await_answer_machine_prompt: false,
511
+ # },
512
+ # },
513
+ # },
514
+ # sms: {
515
+ # capacity: 1.0,
516
+ # outbound_mode: { # required
517
+ # agentless: {
518
+ # },
519
+ # },
520
+ # default_outbound_config: { # required
521
+ # connect_source_phone_number_arn: "Arn", # required
522
+ # wisdom_template_arn: "Arn", # required
523
+ # },
524
+ # },
525
+ # email: {
526
+ # capacity: 1.0,
527
+ # outbound_mode: { # required
528
+ # agentless: {
529
+ # },
530
+ # },
531
+ # default_outbound_config: { # required
532
+ # connect_source_email_address: "EmailAddress", # required
533
+ # source_email_address_display_name: "EmailDisplayName",
534
+ # wisdom_template_arn: "Arn", # required
535
+ # },
536
+ # },
537
+ # },
538
+ # source: {
539
+ # customer_profiles_segment_arn: "Arn",
540
+ # },
541
+ # connect_campaign_flow_arn: "Arn",
542
+ # schedule: {
543
+ # start_time: Time.now, # required
544
+ # end_time: Time.now, # required
545
+ # refresh_frequency: "Iso8601Duration",
546
+ # },
547
+ # communication_time_config: {
548
+ # local_time_zone_config: { # required
549
+ # default_time_zone: "TimeZone",
550
+ # local_time_zone_detection: ["ZIP_CODE"], # accepts ZIP_CODE, AREA_CODE
551
+ # },
552
+ # telephony: {
553
+ # open_hours: { # required
554
+ # daily_hours: {
555
+ # "MONDAY" => [
556
+ # {
557
+ # start_time: "Iso8601Time", # required
558
+ # end_time: "Iso8601Time", # required
559
+ # },
560
+ # ],
561
+ # },
562
+ # },
563
+ # restricted_periods: {
564
+ # restricted_period_list: [
565
+ # {
566
+ # name: "RestrictedPeriodName",
567
+ # start_date: "Iso8601Date", # required
568
+ # end_date: "Iso8601Date", # required
569
+ # },
570
+ # ],
571
+ # },
572
+ # },
573
+ # sms: {
574
+ # open_hours: { # required
575
+ # daily_hours: {
576
+ # "MONDAY" => [
577
+ # {
578
+ # start_time: "Iso8601Time", # required
579
+ # end_time: "Iso8601Time", # required
580
+ # },
581
+ # ],
582
+ # },
583
+ # },
584
+ # restricted_periods: {
585
+ # restricted_period_list: [
586
+ # {
587
+ # name: "RestrictedPeriodName",
588
+ # start_date: "Iso8601Date", # required
589
+ # end_date: "Iso8601Date", # required
590
+ # },
591
+ # ],
592
+ # },
593
+ # },
594
+ # email: {
595
+ # open_hours: { # required
596
+ # daily_hours: {
597
+ # "MONDAY" => [
598
+ # {
599
+ # start_time: "Iso8601Time", # required
600
+ # end_time: "Iso8601Time", # required
601
+ # },
602
+ # ],
603
+ # },
604
+ # },
605
+ # restricted_periods: {
606
+ # restricted_period_list: [
607
+ # {
608
+ # name: "RestrictedPeriodName",
609
+ # start_date: "Iso8601Date", # required
610
+ # end_date: "Iso8601Date", # required
611
+ # },
612
+ # ],
613
+ # },
614
+ # },
615
+ # },
616
+ # communication_limits_override: {
617
+ # all_channel_subtypes: {
618
+ # communication_limits_list: [
619
+ # {
620
+ # max_count_per_recipient: 1, # required
621
+ # frequency: 1, # required
622
+ # unit: "DAY", # required, accepts DAY
623
+ # },
624
+ # ],
625
+ # },
626
+ # },
627
+ # tags: {
628
+ # "TagKey" => "TagValue",
629
+ # },
630
+ # })
631
+ #
632
+ # @example Response structure
633
+ #
634
+ # resp.id #=> String
635
+ # resp.arn #=> String
636
+ # resp.tags #=> Hash
637
+ # resp.tags["TagKey"] #=> String
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CreateCampaign AWS API Documentation
640
+ #
641
+ # @overload create_campaign(params = {})
642
+ # @param [Hash] params ({})
643
+ def create_campaign(params = {}, options = {})
644
+ req = build_request(:create_campaign, params)
645
+ req.send_request(options)
646
+ end
647
+
648
+ # Deletes a campaign from the specified Amazon Connect account.
649
+ #
650
+ # @option params [required, String] :id
651
+ # Identifier representing a Campaign
652
+ #
653
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
654
+ #
655
+ # @example Request syntax with placeholder values
656
+ #
657
+ # resp = client.delete_campaign({
658
+ # id: "CampaignId", # required
659
+ # })
660
+ #
661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaign AWS API Documentation
662
+ #
663
+ # @overload delete_campaign(params = {})
664
+ # @param [Hash] params ({})
665
+ def delete_campaign(params = {}, options = {})
666
+ req = build_request(:delete_campaign, params)
667
+ req.send_request(options)
668
+ end
669
+
670
+ # Deletes the channel subtype config of a campaign. This API is
671
+ # idempotent.
672
+ #
673
+ # @option params [required, String] :id
674
+ # Identifier representing a Campaign
675
+ #
676
+ # @option params [required, String] :channel_subtype
677
+ # The type of campaign channel subtype.
678
+ #
679
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
680
+ #
681
+ # @example Request syntax with placeholder values
682
+ #
683
+ # resp = client.delete_campaign_channel_subtype_config({
684
+ # id: "CampaignId", # required
685
+ # channel_subtype: "TELEPHONY", # required, accepts TELEPHONY, SMS, EMAIL
686
+ # })
687
+ #
688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig AWS API Documentation
689
+ #
690
+ # @overload delete_campaign_channel_subtype_config(params = {})
691
+ # @param [Hash] params ({})
692
+ def delete_campaign_channel_subtype_config(params = {}, options = {})
693
+ req = build_request(:delete_campaign_channel_subtype_config, params)
694
+ req.send_request(options)
695
+ end
696
+
697
+ # Deletes the communication limits config for a campaign. This API is
698
+ # idempotent.
699
+ #
700
+ # @option params [required, String] :id
701
+ # Identifier representing a Campaign
702
+ #
703
+ # @option params [required, String] :config
704
+ # The type of campaign communication limits config.
705
+ #
706
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
707
+ #
708
+ # @example Request syntax with placeholder values
709
+ #
710
+ # resp = client.delete_campaign_communication_limits({
711
+ # id: "CampaignId", # required
712
+ # config: "ALL_CHANNEL_SUBTYPES", # required, accepts ALL_CHANNEL_SUBTYPES
713
+ # })
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits AWS API Documentation
716
+ #
717
+ # @overload delete_campaign_communication_limits(params = {})
718
+ # @param [Hash] params ({})
719
+ def delete_campaign_communication_limits(params = {}, options = {})
720
+ req = build_request(:delete_campaign_communication_limits, params)
721
+ req.send_request(options)
722
+ end
723
+
724
+ # Deletes the communication time config for a campaign. This API is
725
+ # idempotent.
726
+ #
727
+ # @option params [required, String] :id
728
+ # Identifier representing a Campaign
729
+ #
730
+ # @option params [required, String] :config
731
+ # The type of campaign communication time config
732
+ #
733
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
734
+ #
735
+ # @example Request syntax with placeholder values
736
+ #
737
+ # resp = client.delete_campaign_communication_time({
738
+ # id: "CampaignId", # required
739
+ # config: "TELEPHONY", # required, accepts TELEPHONY, SMS, EMAIL
740
+ # })
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime AWS API Documentation
743
+ #
744
+ # @overload delete_campaign_communication_time(params = {})
745
+ # @param [Hash] params ({})
746
+ def delete_campaign_communication_time(params = {}, options = {})
747
+ req = build_request(:delete_campaign_communication_time, params)
748
+ req.send_request(options)
749
+ end
750
+
751
+ # Deletes a connect instance config from the specified AWS account.
752
+ #
753
+ # @option params [required, String] :connect_instance_id
754
+ # Amazon Connect Instance Id
755
+ #
756
+ # @option params [String] :campaign_deletion_policy
757
+ # Enumeration of the policies to enact on existing campaigns during
758
+ # instance config deletion
759
+ #
760
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
761
+ #
762
+ # @example Request syntax with placeholder values
763
+ #
764
+ # resp = client.delete_connect_instance_config({
765
+ # connect_instance_id: "InstanceId", # required
766
+ # campaign_deletion_policy: "RETAIN_ALL", # accepts RETAIN_ALL, DELETE_ALL
767
+ # })
768
+ #
769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig AWS API Documentation
770
+ #
771
+ # @overload delete_connect_instance_config(params = {})
772
+ # @param [Hash] params ({})
773
+ def delete_connect_instance_config(params = {}, options = {})
774
+ req = build_request(:delete_connect_instance_config, params)
775
+ req.send_request(options)
776
+ end
777
+
778
+ # Delete the integration for the specified Amazon Connect instance.
779
+ #
780
+ # @option params [required, String] :connect_instance_id
781
+ # Amazon Connect Instance Id
782
+ #
783
+ # @option params [required, Types::IntegrationIdentifier] :integration_identifier
784
+ # Integration identifier for Connect instance
785
+ #
786
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
787
+ #
788
+ # @example Request syntax with placeholder values
789
+ #
790
+ # resp = client.delete_connect_instance_integration({
791
+ # connect_instance_id: "InstanceId", # required
792
+ # integration_identifier: { # required
793
+ # customer_profiles: {
794
+ # domain_arn: "Arn", # required
795
+ # },
796
+ # q_connect: {
797
+ # knowledge_base_arn: "Arn", # required
798
+ # },
799
+ # },
800
+ # })
801
+ #
802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration AWS API Documentation
803
+ #
804
+ # @overload delete_connect_instance_integration(params = {})
805
+ # @param [Hash] params ({})
806
+ def delete_connect_instance_integration(params = {}, options = {})
807
+ req = build_request(:delete_connect_instance_integration, params)
808
+ req.send_request(options)
809
+ end
810
+
811
+ # Delete the Connect Campaigns onboarding job for the specified Amazon
812
+ # Connect instance.
813
+ #
814
+ # @option params [required, String] :connect_instance_id
815
+ # Amazon Connect Instance Id
816
+ #
817
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
818
+ #
819
+ # @example Request syntax with placeholder values
820
+ #
821
+ # resp = client.delete_instance_onboarding_job({
822
+ # connect_instance_id: "InstanceId", # required
823
+ # })
824
+ #
825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob AWS API Documentation
826
+ #
827
+ # @overload delete_instance_onboarding_job(params = {})
828
+ # @param [Hash] params ({})
829
+ def delete_instance_onboarding_job(params = {}, options = {})
830
+ req = build_request(:delete_instance_onboarding_job, params)
831
+ req.send_request(options)
832
+ end
833
+
834
+ # Describes the specific campaign.
835
+ #
836
+ # @option params [required, String] :id
837
+ # Identifier representing a Campaign
838
+ #
839
+ # @return [Types::DescribeCampaignResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
840
+ #
841
+ # * {Types::DescribeCampaignResponse#campaign #campaign} => Types::Campaign
842
+ #
843
+ # @example Request syntax with placeholder values
844
+ #
845
+ # resp = client.describe_campaign({
846
+ # id: "CampaignId", # required
847
+ # })
848
+ #
849
+ # @example Response structure
850
+ #
851
+ # resp.campaign.id #=> String
852
+ # resp.campaign.arn #=> String
853
+ # resp.campaign.name #=> String
854
+ # resp.campaign.connect_instance_id #=> String
855
+ # resp.campaign.channel_subtype_config.telephony.capacity #=> Float
856
+ # resp.campaign.channel_subtype_config.telephony.connect_queue_id #=> String
857
+ # resp.campaign.channel_subtype_config.telephony.outbound_mode.progressive.bandwidth_allocation #=> Float
858
+ # resp.campaign.channel_subtype_config.telephony.outbound_mode.predictive.bandwidth_allocation #=> Float
859
+ # resp.campaign.channel_subtype_config.telephony.default_outbound_config.connect_contact_flow_id #=> String
860
+ # resp.campaign.channel_subtype_config.telephony.default_outbound_config.connect_source_phone_number #=> String
861
+ # resp.campaign.channel_subtype_config.telephony.default_outbound_config.answer_machine_detection_config.enable_answer_machine_detection #=> Boolean
862
+ # resp.campaign.channel_subtype_config.telephony.default_outbound_config.answer_machine_detection_config.await_answer_machine_prompt #=> Boolean
863
+ # resp.campaign.channel_subtype_config.sms.capacity #=> Float
864
+ # resp.campaign.channel_subtype_config.sms.default_outbound_config.connect_source_phone_number_arn #=> String
865
+ # resp.campaign.channel_subtype_config.sms.default_outbound_config.wisdom_template_arn #=> String
866
+ # resp.campaign.channel_subtype_config.email.capacity #=> Float
867
+ # resp.campaign.channel_subtype_config.email.default_outbound_config.connect_source_email_address #=> String
868
+ # resp.campaign.channel_subtype_config.email.default_outbound_config.source_email_address_display_name #=> String
869
+ # resp.campaign.channel_subtype_config.email.default_outbound_config.wisdom_template_arn #=> String
870
+ # resp.campaign.source.customer_profiles_segment_arn #=> String
871
+ # resp.campaign.connect_campaign_flow_arn #=> String
872
+ # resp.campaign.schedule.start_time #=> Time
873
+ # resp.campaign.schedule.end_time #=> Time
874
+ # resp.campaign.schedule.refresh_frequency #=> String
875
+ # resp.campaign.communication_time_config.local_time_zone_config.default_time_zone #=> String
876
+ # resp.campaign.communication_time_config.local_time_zone_config.local_time_zone_detection #=> Array
877
+ # resp.campaign.communication_time_config.local_time_zone_config.local_time_zone_detection[0] #=> String, one of "ZIP_CODE", "AREA_CODE"
878
+ # resp.campaign.communication_time_config.telephony.open_hours.daily_hours #=> Hash
879
+ # resp.campaign.communication_time_config.telephony.open_hours.daily_hours["DayOfWeek"] #=> Array
880
+ # resp.campaign.communication_time_config.telephony.open_hours.daily_hours["DayOfWeek"][0].start_time #=> String
881
+ # resp.campaign.communication_time_config.telephony.open_hours.daily_hours["DayOfWeek"][0].end_time #=> String
882
+ # resp.campaign.communication_time_config.telephony.restricted_periods.restricted_period_list #=> Array
883
+ # resp.campaign.communication_time_config.telephony.restricted_periods.restricted_period_list[0].name #=> String
884
+ # resp.campaign.communication_time_config.telephony.restricted_periods.restricted_period_list[0].start_date #=> String
885
+ # resp.campaign.communication_time_config.telephony.restricted_periods.restricted_period_list[0].end_date #=> String
886
+ # resp.campaign.communication_time_config.sms.open_hours.daily_hours #=> Hash
887
+ # resp.campaign.communication_time_config.sms.open_hours.daily_hours["DayOfWeek"] #=> Array
888
+ # resp.campaign.communication_time_config.sms.open_hours.daily_hours["DayOfWeek"][0].start_time #=> String
889
+ # resp.campaign.communication_time_config.sms.open_hours.daily_hours["DayOfWeek"][0].end_time #=> String
890
+ # resp.campaign.communication_time_config.sms.restricted_periods.restricted_period_list #=> Array
891
+ # resp.campaign.communication_time_config.sms.restricted_periods.restricted_period_list[0].name #=> String
892
+ # resp.campaign.communication_time_config.sms.restricted_periods.restricted_period_list[0].start_date #=> String
893
+ # resp.campaign.communication_time_config.sms.restricted_periods.restricted_period_list[0].end_date #=> String
894
+ # resp.campaign.communication_time_config.email.open_hours.daily_hours #=> Hash
895
+ # resp.campaign.communication_time_config.email.open_hours.daily_hours["DayOfWeek"] #=> Array
896
+ # resp.campaign.communication_time_config.email.open_hours.daily_hours["DayOfWeek"][0].start_time #=> String
897
+ # resp.campaign.communication_time_config.email.open_hours.daily_hours["DayOfWeek"][0].end_time #=> String
898
+ # resp.campaign.communication_time_config.email.restricted_periods.restricted_period_list #=> Array
899
+ # resp.campaign.communication_time_config.email.restricted_periods.restricted_period_list[0].name #=> String
900
+ # resp.campaign.communication_time_config.email.restricted_periods.restricted_period_list[0].start_date #=> String
901
+ # resp.campaign.communication_time_config.email.restricted_periods.restricted_period_list[0].end_date #=> String
902
+ # resp.campaign.communication_limits_override.all_channel_subtypes.communication_limits_list #=> Array
903
+ # resp.campaign.communication_limits_override.all_channel_subtypes.communication_limits_list[0].max_count_per_recipient #=> Integer
904
+ # resp.campaign.communication_limits_override.all_channel_subtypes.communication_limits_list[0].frequency #=> Integer
905
+ # resp.campaign.communication_limits_override.all_channel_subtypes.communication_limits_list[0].unit #=> String, one of "DAY"
906
+ # resp.campaign.tags #=> Hash
907
+ # resp.campaign.tags["TagKey"] #=> String
908
+ #
909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DescribeCampaign AWS API Documentation
910
+ #
911
+ # @overload describe_campaign(params = {})
912
+ # @param [Hash] params ({})
913
+ def describe_campaign(params = {}, options = {})
914
+ req = build_request(:describe_campaign, params)
915
+ req.send_request(options)
916
+ end
917
+
918
+ # Get state of a campaign for the specified Amazon Connect account.
919
+ #
920
+ # @option params [required, String] :id
921
+ # Identifier representing a Campaign
922
+ #
923
+ # @return [Types::GetCampaignStateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
924
+ #
925
+ # * {Types::GetCampaignStateResponse#state #state} => String
926
+ #
927
+ # @example Request syntax with placeholder values
928
+ #
929
+ # resp = client.get_campaign_state({
930
+ # id: "CampaignId", # required
931
+ # })
932
+ #
933
+ # @example Response structure
934
+ #
935
+ # resp.state #=> String, one of "Initialized", "Running", "Paused", "Stopped", "Failed", "Completed"
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignState AWS API Documentation
938
+ #
939
+ # @overload get_campaign_state(params = {})
940
+ # @param [Hash] params ({})
941
+ def get_campaign_state(params = {}, options = {})
942
+ req = build_request(:get_campaign_state, params)
943
+ req.send_request(options)
944
+ end
945
+
946
+ # Get state of campaigns for the specified Amazon Connect account.
947
+ #
948
+ # @option params [required, Array<String>] :campaign_ids
949
+ # List of CampaignId
950
+ #
951
+ # @return [Types::GetCampaignStateBatchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
952
+ #
953
+ # * {Types::GetCampaignStateBatchResponse#successful_requests #successful_requests} => Array&lt;Types::SuccessfulCampaignStateResponse&gt;
954
+ # * {Types::GetCampaignStateBatchResponse#failed_requests #failed_requests} => Array&lt;Types::FailedCampaignStateResponse&gt;
955
+ #
956
+ # @example Request syntax with placeholder values
957
+ #
958
+ # resp = client.get_campaign_state_batch({
959
+ # campaign_ids: ["CampaignId"], # required
960
+ # })
961
+ #
962
+ # @example Response structure
963
+ #
964
+ # resp.successful_requests #=> Array
965
+ # resp.successful_requests[0].campaign_id #=> String
966
+ # resp.successful_requests[0].state #=> String, one of "Initialized", "Running", "Paused", "Stopped", "Failed", "Completed"
967
+ # resp.failed_requests #=> Array
968
+ # resp.failed_requests[0].campaign_id #=> String
969
+ # resp.failed_requests[0].failure_code #=> String, one of "ResourceNotFound", "UnknownError"
970
+ #
971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateBatch AWS API Documentation
972
+ #
973
+ # @overload get_campaign_state_batch(params = {})
974
+ # @param [Hash] params ({})
975
+ def get_campaign_state_batch(params = {}, options = {})
976
+ req = build_request(:get_campaign_state_batch, params)
977
+ req.send_request(options)
978
+ end
979
+
980
+ # Get the specific Connect instance config.
981
+ #
982
+ # @option params [required, String] :connect_instance_id
983
+ # Amazon Connect Instance Id
984
+ #
985
+ # @return [Types::GetConnectInstanceConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
986
+ #
987
+ # * {Types::GetConnectInstanceConfigResponse#connect_instance_config #connect_instance_config} => Types::InstanceConfig
988
+ #
989
+ # @example Request syntax with placeholder values
990
+ #
991
+ # resp = client.get_connect_instance_config({
992
+ # connect_instance_id: "InstanceId", # required
993
+ # })
994
+ #
995
+ # @example Response structure
996
+ #
997
+ # resp.connect_instance_config.connect_instance_id #=> String
998
+ # resp.connect_instance_config.service_linked_role_arn #=> String
999
+ # resp.connect_instance_config.encryption_config.enabled #=> Boolean
1000
+ # resp.connect_instance_config.encryption_config.encryption_type #=> String, one of "KMS"
1001
+ # resp.connect_instance_config.encryption_config.key_arn #=> String
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig AWS API Documentation
1004
+ #
1005
+ # @overload get_connect_instance_config(params = {})
1006
+ # @param [Hash] params ({})
1007
+ def get_connect_instance_config(params = {}, options = {})
1008
+ req = build_request(:get_connect_instance_config, params)
1009
+ req.send_request(options)
1010
+ end
1011
+
1012
+ # Get the specific instance onboarding job status.
1013
+ #
1014
+ # @option params [required, String] :connect_instance_id
1015
+ # Amazon Connect Instance Id
1016
+ #
1017
+ # @return [Types::GetInstanceOnboardingJobStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1018
+ #
1019
+ # * {Types::GetInstanceOnboardingJobStatusResponse#connect_instance_onboarding_job_status #connect_instance_onboarding_job_status} => Types::InstanceOnboardingJobStatus
1020
+ #
1021
+ # @example Request syntax with placeholder values
1022
+ #
1023
+ # resp = client.get_instance_onboarding_job_status({
1024
+ # connect_instance_id: "InstanceId", # required
1025
+ # })
1026
+ #
1027
+ # @example Response structure
1028
+ #
1029
+ # resp.connect_instance_onboarding_job_status.connect_instance_id #=> String
1030
+ # resp.connect_instance_onboarding_job_status.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
1031
+ # resp.connect_instance_onboarding_job_status.failure_code #=> String, one of "EVENT_BRIDGE_ACCESS_DENIED", "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "IAM_ACCESS_DENIED", "KMS_ACCESS_DENIED", "KMS_KEY_NOT_FOUND", "INTERNAL_FAILURE"
1032
+ #
1033
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus AWS API Documentation
1034
+ #
1035
+ # @overload get_instance_onboarding_job_status(params = {})
1036
+ # @param [Hash] params ({})
1037
+ def get_instance_onboarding_job_status(params = {}, options = {})
1038
+ req = build_request(:get_instance_onboarding_job_status, params)
1039
+ req.send_request(options)
1040
+ end
1041
+
1042
+ # Provides summary information about the campaigns under the specified
1043
+ # Amazon Connect account.
1044
+ #
1045
+ # @option params [Integer] :max_results
1046
+ # The maximum number of results to return per page.
1047
+ #
1048
+ # @option params [String] :next_token
1049
+ # The token for the next set of results.
1050
+ #
1051
+ # @option params [Types::CampaignFilters] :filters
1052
+ # Filter model by type
1053
+ #
1054
+ # @return [Types::ListCampaignsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1055
+ #
1056
+ # * {Types::ListCampaignsResponse#next_token #next_token} => String
1057
+ # * {Types::ListCampaignsResponse#campaign_summary_list #campaign_summary_list} => Array&lt;Types::CampaignSummary&gt;
1058
+ #
1059
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1060
+ #
1061
+ # @example Request syntax with placeholder values
1062
+ #
1063
+ # resp = client.list_campaigns({
1064
+ # max_results: 1,
1065
+ # next_token: "NextToken",
1066
+ # filters: {
1067
+ # instance_id_filter: {
1068
+ # value: "InstanceId", # required
1069
+ # operator: "Eq", # required, accepts Eq
1070
+ # },
1071
+ # },
1072
+ # })
1073
+ #
1074
+ # @example Response structure
1075
+ #
1076
+ # resp.next_token #=> String
1077
+ # resp.campaign_summary_list #=> Array
1078
+ # resp.campaign_summary_list[0].id #=> String
1079
+ # resp.campaign_summary_list[0].arn #=> String
1080
+ # resp.campaign_summary_list[0].name #=> String
1081
+ # resp.campaign_summary_list[0].connect_instance_id #=> String
1082
+ # resp.campaign_summary_list[0].channel_subtypes #=> Array
1083
+ # resp.campaign_summary_list[0].channel_subtypes[0] #=> String, one of "TELEPHONY", "SMS", "EMAIL"
1084
+ # resp.campaign_summary_list[0].schedule.start_time #=> Time
1085
+ # resp.campaign_summary_list[0].schedule.end_time #=> Time
1086
+ # resp.campaign_summary_list[0].schedule.refresh_frequency #=> String
1087
+ # resp.campaign_summary_list[0].connect_campaign_flow_arn #=> String
1088
+ #
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListCampaigns AWS API Documentation
1090
+ #
1091
+ # @overload list_campaigns(params = {})
1092
+ # @param [Hash] params ({})
1093
+ def list_campaigns(params = {}, options = {})
1094
+ req = build_request(:list_campaigns, params)
1095
+ req.send_request(options)
1096
+ end
1097
+
1098
+ # Provides summary information about the integration under the specified
1099
+ # Connect instance.
1100
+ #
1101
+ # @option params [required, String] :connect_instance_id
1102
+ # Amazon Connect Instance Id
1103
+ #
1104
+ # @option params [Integer] :max_results
1105
+ # The maximum number of results to return per page.
1106
+ #
1107
+ # @option params [String] :next_token
1108
+ # The token for the next set of results.
1109
+ #
1110
+ # @return [Types::ListConnectInstanceIntegrationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1111
+ #
1112
+ # * {Types::ListConnectInstanceIntegrationsResponse#next_token #next_token} => String
1113
+ # * {Types::ListConnectInstanceIntegrationsResponse#integration_summary_list #integration_summary_list} => Array&lt;Types::IntegrationSummary&gt;
1114
+ #
1115
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1116
+ #
1117
+ # @example Request syntax with placeholder values
1118
+ #
1119
+ # resp = client.list_connect_instance_integrations({
1120
+ # connect_instance_id: "InstanceId", # required
1121
+ # max_results: 1,
1122
+ # next_token: "NextToken",
1123
+ # })
1124
+ #
1125
+ # @example Response structure
1126
+ #
1127
+ # resp.next_token #=> String
1128
+ # resp.integration_summary_list #=> Array
1129
+ # resp.integration_summary_list[0].customer_profiles.domain_arn #=> String
1130
+ # resp.integration_summary_list[0].customer_profiles.object_type_names #=> Hash
1131
+ # resp.integration_summary_list[0].customer_profiles.object_type_names["EventType"] #=> String
1132
+ # resp.integration_summary_list[0].q_connect.knowledge_base_arn #=> String
1133
+ #
1134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations AWS API Documentation
1135
+ #
1136
+ # @overload list_connect_instance_integrations(params = {})
1137
+ # @param [Hash] params ({})
1138
+ def list_connect_instance_integrations(params = {}, options = {})
1139
+ req = build_request(:list_connect_instance_integrations, params)
1140
+ req.send_request(options)
1141
+ end
1142
+
1143
+ # List tags for a resource.
1144
+ #
1145
+ # @option params [required, String] :arn
1146
+ # Amazon Resource Names(ARN)
1147
+ #
1148
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1149
+ #
1150
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1151
+ #
1152
+ # @example Request syntax with placeholder values
1153
+ #
1154
+ # resp = client.list_tags_for_resource({
1155
+ # arn: "Arn", # required
1156
+ # })
1157
+ #
1158
+ # @example Response structure
1159
+ #
1160
+ # resp.tags #=> Hash
1161
+ # resp.tags["TagKey"] #=> String
1162
+ #
1163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListTagsForResource AWS API Documentation
1164
+ #
1165
+ # @overload list_tags_for_resource(params = {})
1166
+ # @param [Hash] params ({})
1167
+ def list_tags_for_resource(params = {}, options = {})
1168
+ req = build_request(:list_tags_for_resource, params)
1169
+ req.send_request(options)
1170
+ end
1171
+
1172
+ # Pauses a campaign for the specified Amazon Connect account.
1173
+ #
1174
+ # @option params [required, String] :id
1175
+ # Identifier representing a Campaign
1176
+ #
1177
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1178
+ #
1179
+ # @example Request syntax with placeholder values
1180
+ #
1181
+ # resp = client.pause_campaign({
1182
+ # id: "CampaignId", # required
1183
+ # })
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PauseCampaign AWS API Documentation
1186
+ #
1187
+ # @overload pause_campaign(params = {})
1188
+ # @param [Hash] params ({})
1189
+ def pause_campaign(params = {}, options = {})
1190
+ req = build_request(:pause_campaign, params)
1191
+ req.send_request(options)
1192
+ end
1193
+
1194
+ # Put or update the integration for the specified Amazon Connect
1195
+ # instance.
1196
+ #
1197
+ # @option params [required, String] :connect_instance_id
1198
+ # Amazon Connect Instance Id
1199
+ #
1200
+ # @option params [required, Types::IntegrationConfig] :integration_config
1201
+ # Integration config for Connect Instance
1202
+ #
1203
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1204
+ #
1205
+ # @example Request syntax with placeholder values
1206
+ #
1207
+ # resp = client.put_connect_instance_integration({
1208
+ # connect_instance_id: "InstanceId", # required
1209
+ # integration_config: { # required
1210
+ # customer_profiles: {
1211
+ # domain_arn: "Arn", # required
1212
+ # object_type_names: { # required
1213
+ # "Campaign-Email" => "ObjectTypeName",
1214
+ # },
1215
+ # },
1216
+ # q_connect: {
1217
+ # knowledge_base_arn: "Arn", # required
1218
+ # },
1219
+ # },
1220
+ # })
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration AWS API Documentation
1223
+ #
1224
+ # @overload put_connect_instance_integration(params = {})
1225
+ # @param [Hash] params ({})
1226
+ def put_connect_instance_integration(params = {}, options = {})
1227
+ req = build_request(:put_connect_instance_integration, params)
1228
+ req.send_request(options)
1229
+ end
1230
+
1231
+ # Creates outbound requests for the specified campaign Amazon Connect
1232
+ # account. This API is idempotent.
1233
+ #
1234
+ # @option params [required, String] :id
1235
+ # Identifier representing a Campaign
1236
+ #
1237
+ # @option params [required, Array<Types::OutboundRequest>] :outbound_requests
1238
+ # A list of outbound requests.
1239
+ #
1240
+ # @return [Types::PutOutboundRequestBatchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1241
+ #
1242
+ # * {Types::PutOutboundRequestBatchResponse#successful_requests #successful_requests} => Array&lt;Types::SuccessfulRequest&gt;
1243
+ # * {Types::PutOutboundRequestBatchResponse#failed_requests #failed_requests} => Array&lt;Types::FailedRequest&gt;
1244
+ #
1245
+ # @example Request syntax with placeholder values
1246
+ #
1247
+ # resp = client.put_outbound_request_batch({
1248
+ # id: "CampaignId", # required
1249
+ # outbound_requests: [ # required
1250
+ # {
1251
+ # client_token: "ClientToken", # required
1252
+ # expiration_time: Time.now, # required
1253
+ # channel_subtype_parameters: { # required
1254
+ # telephony: {
1255
+ # destination_phone_number: "DestinationPhoneNumber", # required
1256
+ # attributes: { # required
1257
+ # "AttributeName" => "AttributeValue",
1258
+ # },
1259
+ # connect_source_phone_number: "SourcePhoneNumber",
1260
+ # answer_machine_detection_config: {
1261
+ # enable_answer_machine_detection: false, # required
1262
+ # await_answer_machine_prompt: false,
1263
+ # },
1264
+ # },
1265
+ # sms: {
1266
+ # destination_phone_number: "DestinationPhoneNumber", # required
1267
+ # connect_source_phone_number_arn: "Arn",
1268
+ # template_arn: "Arn",
1269
+ # template_parameters: { # required
1270
+ # "AttributeName" => "AttributeValue",
1271
+ # },
1272
+ # },
1273
+ # email: {
1274
+ # destination_email_address: "EmailAddress", # required
1275
+ # connect_source_email_address: "EmailAddress",
1276
+ # template_arn: "Arn",
1277
+ # template_parameters: { # required
1278
+ # "AttributeName" => "AttributeValue",
1279
+ # },
1280
+ # },
1281
+ # },
1282
+ # },
1283
+ # ],
1284
+ # })
1285
+ #
1286
+ # @example Response structure
1287
+ #
1288
+ # resp.successful_requests #=> Array
1289
+ # resp.successful_requests[0].client_token #=> String
1290
+ # resp.successful_requests[0].id #=> String
1291
+ # resp.failed_requests #=> Array
1292
+ # resp.failed_requests[0].client_token #=> String
1293
+ # resp.failed_requests[0].id #=> String
1294
+ # resp.failed_requests[0].failure_code #=> String, one of "InvalidInput", "RequestThrottled", "UnknownError", "BufferLimitExceeded"
1295
+ #
1296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch AWS API Documentation
1297
+ #
1298
+ # @overload put_outbound_request_batch(params = {})
1299
+ # @param [Hash] params ({})
1300
+ def put_outbound_request_batch(params = {}, options = {})
1301
+ req = build_request(:put_outbound_request_batch, params)
1302
+ req.send_request(options)
1303
+ end
1304
+
1305
+ # Stops a campaign for the specified Amazon Connect account.
1306
+ #
1307
+ # @option params [required, String] :id
1308
+ # Identifier representing a Campaign
1309
+ #
1310
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1311
+ #
1312
+ # @example Request syntax with placeholder values
1313
+ #
1314
+ # resp = client.resume_campaign({
1315
+ # id: "CampaignId", # required
1316
+ # })
1317
+ #
1318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ResumeCampaign AWS API Documentation
1319
+ #
1320
+ # @overload resume_campaign(params = {})
1321
+ # @param [Hash] params ({})
1322
+ def resume_campaign(params = {}, options = {})
1323
+ req = build_request(:resume_campaign, params)
1324
+ req.send_request(options)
1325
+ end
1326
+
1327
+ # Starts a campaign for the specified Amazon Connect account.
1328
+ #
1329
+ # @option params [required, String] :id
1330
+ # Identifier representing a Campaign
1331
+ #
1332
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1333
+ #
1334
+ # @example Request syntax with placeholder values
1335
+ #
1336
+ # resp = client.start_campaign({
1337
+ # id: "CampaignId", # required
1338
+ # })
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StartCampaign AWS API Documentation
1341
+ #
1342
+ # @overload start_campaign(params = {})
1343
+ # @param [Hash] params ({})
1344
+ def start_campaign(params = {}, options = {})
1345
+ req = build_request(:start_campaign, params)
1346
+ req.send_request(options)
1347
+ end
1348
+
1349
+ # Onboard the specific Amazon Connect instance to Connect Campaigns.
1350
+ #
1351
+ # @option params [required, String] :connect_instance_id
1352
+ # Amazon Connect Instance Id
1353
+ #
1354
+ # @option params [required, Types::EncryptionConfig] :encryption_config
1355
+ # Encryption config for Connect Instance. Note that sensitive data will
1356
+ # always be encrypted. If disabled, service will perform encryption with
1357
+ # its own key. If enabled, a KMS key id needs to be provided and KMS
1358
+ # charges will apply. KMS is only type supported
1359
+ #
1360
+ # @return [Types::StartInstanceOnboardingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1361
+ #
1362
+ # * {Types::StartInstanceOnboardingJobResponse#connect_instance_onboarding_job_status #connect_instance_onboarding_job_status} => Types::InstanceOnboardingJobStatus
1363
+ #
1364
+ # @example Request syntax with placeholder values
1365
+ #
1366
+ # resp = client.start_instance_onboarding_job({
1367
+ # connect_instance_id: "InstanceId", # required
1368
+ # encryption_config: { # required
1369
+ # enabled: false, # required
1370
+ # encryption_type: "KMS", # accepts KMS
1371
+ # key_arn: "EncryptionKey",
1372
+ # },
1373
+ # })
1374
+ #
1375
+ # @example Response structure
1376
+ #
1377
+ # resp.connect_instance_onboarding_job_status.connect_instance_id #=> String
1378
+ # resp.connect_instance_onboarding_job_status.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
1379
+ # resp.connect_instance_onboarding_job_status.failure_code #=> String, one of "EVENT_BRIDGE_ACCESS_DENIED", "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", "IAM_ACCESS_DENIED", "KMS_ACCESS_DENIED", "KMS_KEY_NOT_FOUND", "INTERNAL_FAILURE"
1380
+ #
1381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob AWS API Documentation
1382
+ #
1383
+ # @overload start_instance_onboarding_job(params = {})
1384
+ # @param [Hash] params ({})
1385
+ def start_instance_onboarding_job(params = {}, options = {})
1386
+ req = build_request(:start_instance_onboarding_job, params)
1387
+ req.send_request(options)
1388
+ end
1389
+
1390
+ # Stops a campaign for the specified Amazon Connect account.
1391
+ #
1392
+ # @option params [required, String] :id
1393
+ # Identifier representing a Campaign
1394
+ #
1395
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1396
+ #
1397
+ # @example Request syntax with placeholder values
1398
+ #
1399
+ # resp = client.stop_campaign({
1400
+ # id: "CampaignId", # required
1401
+ # })
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StopCampaign AWS API Documentation
1404
+ #
1405
+ # @overload stop_campaign(params = {})
1406
+ # @param [Hash] params ({})
1407
+ def stop_campaign(params = {}, options = {})
1408
+ req = build_request(:stop_campaign, params)
1409
+ req.send_request(options)
1410
+ end
1411
+
1412
+ # Tag a resource.
1413
+ #
1414
+ # @option params [required, String] :arn
1415
+ # Amazon Resource Names(ARN)
1416
+ #
1417
+ # @option params [required, Hash<String,String>] :tags
1418
+ # Tag map with key and value.
1419
+ #
1420
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1421
+ #
1422
+ # @example Request syntax with placeholder values
1423
+ #
1424
+ # resp = client.tag_resource({
1425
+ # arn: "Arn", # required
1426
+ # tags: { # required
1427
+ # "TagKey" => "TagValue",
1428
+ # },
1429
+ # })
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TagResource AWS API Documentation
1432
+ #
1433
+ # @overload tag_resource(params = {})
1434
+ # @param [Hash] params ({})
1435
+ def tag_resource(params = {}, options = {})
1436
+ req = build_request(:tag_resource, params)
1437
+ req.send_request(options)
1438
+ end
1439
+
1440
+ # Untag a resource.
1441
+ #
1442
+ # @option params [required, String] :arn
1443
+ # Amazon Resource Names(ARN)
1444
+ #
1445
+ # @option params [required, Array<String>] :tag_keys
1446
+ # List of tag keys.
1447
+ #
1448
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1449
+ #
1450
+ # @example Request syntax with placeholder values
1451
+ #
1452
+ # resp = client.untag_resource({
1453
+ # arn: "Arn", # required
1454
+ # tag_keys: ["TagKey"], # required
1455
+ # })
1456
+ #
1457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UntagResource AWS API Documentation
1458
+ #
1459
+ # @overload untag_resource(params = {})
1460
+ # @param [Hash] params ({})
1461
+ def untag_resource(params = {}, options = {})
1462
+ req = build_request(:untag_resource, params)
1463
+ req.send_request(options)
1464
+ end
1465
+
1466
+ # Updates the channel subtype config of a campaign. This API is
1467
+ # idempotent.
1468
+ #
1469
+ # @option params [required, String] :id
1470
+ # Identifier representing a Campaign
1471
+ #
1472
+ # @option params [required, Types::ChannelSubtypeConfig] :channel_subtype_config
1473
+ # Campaign Channel Subtype config
1474
+ #
1475
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1476
+ #
1477
+ # @example Request syntax with placeholder values
1478
+ #
1479
+ # resp = client.update_campaign_channel_subtype_config({
1480
+ # id: "CampaignId", # required
1481
+ # channel_subtype_config: { # required
1482
+ # telephony: {
1483
+ # capacity: 1.0,
1484
+ # connect_queue_id: "QueueId",
1485
+ # outbound_mode: { # required
1486
+ # progressive: {
1487
+ # bandwidth_allocation: 1.0, # required
1488
+ # },
1489
+ # predictive: {
1490
+ # bandwidth_allocation: 1.0, # required
1491
+ # },
1492
+ # agentless: {
1493
+ # },
1494
+ # },
1495
+ # default_outbound_config: { # required
1496
+ # connect_contact_flow_id: "ContactFlowId", # required
1497
+ # connect_source_phone_number: "SourcePhoneNumber",
1498
+ # answer_machine_detection_config: {
1499
+ # enable_answer_machine_detection: false, # required
1500
+ # await_answer_machine_prompt: false,
1501
+ # },
1502
+ # },
1503
+ # },
1504
+ # sms: {
1505
+ # capacity: 1.0,
1506
+ # outbound_mode: { # required
1507
+ # agentless: {
1508
+ # },
1509
+ # },
1510
+ # default_outbound_config: { # required
1511
+ # connect_source_phone_number_arn: "Arn", # required
1512
+ # wisdom_template_arn: "Arn", # required
1513
+ # },
1514
+ # },
1515
+ # email: {
1516
+ # capacity: 1.0,
1517
+ # outbound_mode: { # required
1518
+ # agentless: {
1519
+ # },
1520
+ # },
1521
+ # default_outbound_config: { # required
1522
+ # connect_source_email_address: "EmailAddress", # required
1523
+ # source_email_address_display_name: "EmailDisplayName",
1524
+ # wisdom_template_arn: "Arn", # required
1525
+ # },
1526
+ # },
1527
+ # },
1528
+ # })
1529
+ #
1530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig AWS API Documentation
1531
+ #
1532
+ # @overload update_campaign_channel_subtype_config(params = {})
1533
+ # @param [Hash] params ({})
1534
+ def update_campaign_channel_subtype_config(params = {}, options = {})
1535
+ req = build_request(:update_campaign_channel_subtype_config, params)
1536
+ req.send_request(options)
1537
+ end
1538
+
1539
+ # Updates the communication limits config for a campaign. This API is
1540
+ # idempotent.
1541
+ #
1542
+ # @option params [required, String] :id
1543
+ # Identifier representing a Campaign
1544
+ #
1545
+ # @option params [required, Types::CommunicationLimitsConfig] :communication_limits_override
1546
+ # Communication limits config
1547
+ #
1548
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1549
+ #
1550
+ # @example Request syntax with placeholder values
1551
+ #
1552
+ # resp = client.update_campaign_communication_limits({
1553
+ # id: "CampaignId", # required
1554
+ # communication_limits_override: { # required
1555
+ # all_channel_subtypes: {
1556
+ # communication_limits_list: [
1557
+ # {
1558
+ # max_count_per_recipient: 1, # required
1559
+ # frequency: 1, # required
1560
+ # unit: "DAY", # required, accepts DAY
1561
+ # },
1562
+ # ],
1563
+ # },
1564
+ # },
1565
+ # })
1566
+ #
1567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits AWS API Documentation
1568
+ #
1569
+ # @overload update_campaign_communication_limits(params = {})
1570
+ # @param [Hash] params ({})
1571
+ def update_campaign_communication_limits(params = {}, options = {})
1572
+ req = build_request(:update_campaign_communication_limits, params)
1573
+ req.send_request(options)
1574
+ end
1575
+
1576
+ # Updates the communication time config for a campaign. This API is
1577
+ # idempotent.
1578
+ #
1579
+ # @option params [required, String] :id
1580
+ # Identifier representing a Campaign
1581
+ #
1582
+ # @option params [required, Types::CommunicationTimeConfig] :communication_time_config
1583
+ # Campaign communication time config
1584
+ #
1585
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1586
+ #
1587
+ # @example Request syntax with placeholder values
1588
+ #
1589
+ # resp = client.update_campaign_communication_time({
1590
+ # id: "CampaignId", # required
1591
+ # communication_time_config: { # required
1592
+ # local_time_zone_config: { # required
1593
+ # default_time_zone: "TimeZone",
1594
+ # local_time_zone_detection: ["ZIP_CODE"], # accepts ZIP_CODE, AREA_CODE
1595
+ # },
1596
+ # telephony: {
1597
+ # open_hours: { # required
1598
+ # daily_hours: {
1599
+ # "MONDAY" => [
1600
+ # {
1601
+ # start_time: "Iso8601Time", # required
1602
+ # end_time: "Iso8601Time", # required
1603
+ # },
1604
+ # ],
1605
+ # },
1606
+ # },
1607
+ # restricted_periods: {
1608
+ # restricted_period_list: [
1609
+ # {
1610
+ # name: "RestrictedPeriodName",
1611
+ # start_date: "Iso8601Date", # required
1612
+ # end_date: "Iso8601Date", # required
1613
+ # },
1614
+ # ],
1615
+ # },
1616
+ # },
1617
+ # sms: {
1618
+ # open_hours: { # required
1619
+ # daily_hours: {
1620
+ # "MONDAY" => [
1621
+ # {
1622
+ # start_time: "Iso8601Time", # required
1623
+ # end_time: "Iso8601Time", # required
1624
+ # },
1625
+ # ],
1626
+ # },
1627
+ # },
1628
+ # restricted_periods: {
1629
+ # restricted_period_list: [
1630
+ # {
1631
+ # name: "RestrictedPeriodName",
1632
+ # start_date: "Iso8601Date", # required
1633
+ # end_date: "Iso8601Date", # required
1634
+ # },
1635
+ # ],
1636
+ # },
1637
+ # },
1638
+ # email: {
1639
+ # open_hours: { # required
1640
+ # daily_hours: {
1641
+ # "MONDAY" => [
1642
+ # {
1643
+ # start_time: "Iso8601Time", # required
1644
+ # end_time: "Iso8601Time", # required
1645
+ # },
1646
+ # ],
1647
+ # },
1648
+ # },
1649
+ # restricted_periods: {
1650
+ # restricted_period_list: [
1651
+ # {
1652
+ # name: "RestrictedPeriodName",
1653
+ # start_date: "Iso8601Date", # required
1654
+ # end_date: "Iso8601Date", # required
1655
+ # },
1656
+ # ],
1657
+ # },
1658
+ # },
1659
+ # },
1660
+ # })
1661
+ #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime AWS API Documentation
1663
+ #
1664
+ # @overload update_campaign_communication_time(params = {})
1665
+ # @param [Hash] params ({})
1666
+ def update_campaign_communication_time(params = {}, options = {})
1667
+ req = build_request(:update_campaign_communication_time, params)
1668
+ req.send_request(options)
1669
+ end
1670
+
1671
+ # Updates the campaign flow associated with a campaign. This API is
1672
+ # idempotent.
1673
+ #
1674
+ # @option params [required, String] :id
1675
+ # Identifier representing a Campaign
1676
+ #
1677
+ # @option params [required, String] :connect_campaign_flow_arn
1678
+ # Amazon Resource Names(ARN)
1679
+ #
1680
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1681
+ #
1682
+ # @example Request syntax with placeholder values
1683
+ #
1684
+ # resp = client.update_campaign_flow_association({
1685
+ # id: "CampaignId", # required
1686
+ # connect_campaign_flow_arn: "Arn", # required
1687
+ # })
1688
+ #
1689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation AWS API Documentation
1690
+ #
1691
+ # @overload update_campaign_flow_association(params = {})
1692
+ # @param [Hash] params ({})
1693
+ def update_campaign_flow_association(params = {}, options = {})
1694
+ req = build_request(:update_campaign_flow_association, params)
1695
+ req.send_request(options)
1696
+ end
1697
+
1698
+ # Updates the name of a campaign. This API is idempotent.
1699
+ #
1700
+ # @option params [required, String] :id
1701
+ # Identifier representing a Campaign
1702
+ #
1703
+ # @option params [required, String] :name
1704
+ # The name of an Amazon Connect Campaign name.
1705
+ #
1706
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1707
+ #
1708
+ # @example Request syntax with placeholder values
1709
+ #
1710
+ # resp = client.update_campaign_name({
1711
+ # id: "CampaignId", # required
1712
+ # name: "CampaignName", # required
1713
+ # })
1714
+ #
1715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignName AWS API Documentation
1716
+ #
1717
+ # @overload update_campaign_name(params = {})
1718
+ # @param [Hash] params ({})
1719
+ def update_campaign_name(params = {}, options = {})
1720
+ req = build_request(:update_campaign_name, params)
1721
+ req.send_request(options)
1722
+ end
1723
+
1724
+ # Updates the schedule for a campaign. This API is idempotent.
1725
+ #
1726
+ # @option params [required, String] :id
1727
+ # Identifier representing a Campaign
1728
+ #
1729
+ # @option params [required, Types::Schedule] :schedule
1730
+ # Campaign schedule
1731
+ #
1732
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1733
+ #
1734
+ # @example Request syntax with placeholder values
1735
+ #
1736
+ # resp = client.update_campaign_schedule({
1737
+ # id: "CampaignId", # required
1738
+ # schedule: { # required
1739
+ # start_time: Time.now, # required
1740
+ # end_time: Time.now, # required
1741
+ # refresh_frequency: "Iso8601Duration",
1742
+ # },
1743
+ # })
1744
+ #
1745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule AWS API Documentation
1746
+ #
1747
+ # @overload update_campaign_schedule(params = {})
1748
+ # @param [Hash] params ({})
1749
+ def update_campaign_schedule(params = {}, options = {})
1750
+ req = build_request(:update_campaign_schedule, params)
1751
+ req.send_request(options)
1752
+ end
1753
+
1754
+ # Updates the campaign source with a campaign. This API is idempotent.
1755
+ #
1756
+ # @option params [required, String] :id
1757
+ # Identifier representing a Campaign
1758
+ #
1759
+ # @option params [required, Types::Source] :source
1760
+ # Source of the campaign
1761
+ #
1762
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1763
+ #
1764
+ # @example Request syntax with placeholder values
1765
+ #
1766
+ # resp = client.update_campaign_source({
1767
+ # id: "CampaignId", # required
1768
+ # source: { # required
1769
+ # customer_profiles_segment_arn: "Arn",
1770
+ # },
1771
+ # })
1772
+ #
1773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignSource AWS API Documentation
1774
+ #
1775
+ # @overload update_campaign_source(params = {})
1776
+ # @param [Hash] params ({})
1777
+ def update_campaign_source(params = {}, options = {})
1778
+ req = build_request(:update_campaign_source, params)
1779
+ req.send_request(options)
1780
+ end
1781
+
1782
+ # @!endgroup
1783
+
1784
+ # @param params ({})
1785
+ # @api private
1786
+ def build_request(operation_name, params = {})
1787
+ handlers = @handlers.for(operation_name)
1788
+ tracer = config.telemetry_provider.tracer_provider.tracer(
1789
+ Aws::Telemetry.module_to_tracer_name('Aws::ConnectCampaignsV2')
1790
+ )
1791
+ context = Seahorse::Client::RequestContext.new(
1792
+ operation_name: operation_name,
1793
+ operation: config.api.operation(operation_name),
1794
+ client: self,
1795
+ params: params,
1796
+ config: config,
1797
+ tracer: tracer
1798
+ )
1799
+ context[:gem_name] = 'aws-sdk-connectcampaignsv2'
1800
+ context[:gem_version] = '1.0.0'
1801
+ Seahorse::Client::Request.new(handlers, context)
1802
+ end
1803
+
1804
+ # @api private
1805
+ # @deprecated
1806
+ def waiter_names
1807
+ []
1808
+ end
1809
+
1810
+ class << self
1811
+
1812
+ # @api private
1813
+ attr_reader :identifier
1814
+
1815
+ # @api private
1816
+ def errors_module
1817
+ Errors
1818
+ end
1819
+
1820
+ end
1821
+ end
1822
+ end