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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-connectcampaignsv2/client.rb +1822 -0
- data/lib/aws-sdk-connectcampaignsv2/client_api.rb +1163 -0
- data/lib/aws-sdk-connectcampaignsv2/customizations.rb +0 -0
- data/lib/aws-sdk-connectcampaignsv2/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-connectcampaignsv2/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-connectcampaignsv2/endpoints.rb +20 -0
- data/lib/aws-sdk-connectcampaignsv2/errors.rb +240 -0
- data/lib/aws-sdk-connectcampaignsv2/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-connectcampaignsv2/resource.rb +26 -0
- data/lib/aws-sdk-connectcampaignsv2/types.rb +2187 -0
- data/lib/aws-sdk-connectcampaignsv2.rb +61 -0
- data/sig/client.rbs +651 -0
- data/sig/errors.rbs +53 -0
- data/sig/resource.rbs +82 -0
- data/sig/types.rbs +724 -0
- data/sig/waiters.rbs +13 -0
- metadata +99 -0
@@ -0,0 +1,2187 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectCampaignsV2
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @!attribute [rw] x_amz_error_type
|
19
|
+
# A header that defines the error encountered while processing the
|
20
|
+
# request.
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/AccessDeniedException AWS API Documentation
|
24
|
+
#
|
25
|
+
class AccessDeniedException < Struct.new(
|
26
|
+
:message,
|
27
|
+
:x_amz_error_type)
|
28
|
+
SENSITIVE = []
|
29
|
+
include Aws::Structure
|
30
|
+
end
|
31
|
+
|
32
|
+
# Agentless config
|
33
|
+
#
|
34
|
+
# @api private
|
35
|
+
#
|
36
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/AgentlessConfig AWS API Documentation
|
37
|
+
#
|
38
|
+
class AgentlessConfig < Aws::EmptyStructure; end
|
39
|
+
|
40
|
+
# Answering Machine Detection config
|
41
|
+
#
|
42
|
+
# @!attribute [rw] enable_answer_machine_detection
|
43
|
+
# Enable or disable answering machine detection
|
44
|
+
# @return [Boolean]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] await_answer_machine_prompt
|
47
|
+
# Enable or disable await answer machine prompt
|
48
|
+
# @return [Boolean]
|
49
|
+
#
|
50
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/AnswerMachineDetectionConfig AWS API Documentation
|
51
|
+
#
|
52
|
+
class AnswerMachineDetectionConfig < Struct.new(
|
53
|
+
:enable_answer_machine_detection,
|
54
|
+
:await_answer_machine_prompt)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# An Amazon Connect campaign.
|
60
|
+
#
|
61
|
+
# @!attribute [rw] id
|
62
|
+
# Identifier representing a Campaign
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] arn
|
66
|
+
# The resource name of an Amazon Connect campaign.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] name
|
70
|
+
# The name of an Amazon Connect Campaign name.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] connect_instance_id
|
74
|
+
# Amazon Connect Instance Id
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] channel_subtype_config
|
78
|
+
# Campaign Channel Subtype config
|
79
|
+
# @return [Types::ChannelSubtypeConfig]
|
80
|
+
#
|
81
|
+
# @!attribute [rw] source
|
82
|
+
# Source of the campaign
|
83
|
+
# @return [Types::Source]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] connect_campaign_flow_arn
|
86
|
+
# Amazon Resource Names(ARN)
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] schedule
|
90
|
+
# Campaign schedule
|
91
|
+
# @return [Types::Schedule]
|
92
|
+
#
|
93
|
+
# @!attribute [rw] communication_time_config
|
94
|
+
# Campaign communication time config
|
95
|
+
# @return [Types::CommunicationTimeConfig]
|
96
|
+
#
|
97
|
+
# @!attribute [rw] communication_limits_override
|
98
|
+
# Communication limits config
|
99
|
+
# @return [Types::CommunicationLimitsConfig]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] tags
|
102
|
+
# Tag map with key and value.
|
103
|
+
# @return [Hash<String,String>]
|
104
|
+
#
|
105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/Campaign AWS API Documentation
|
106
|
+
#
|
107
|
+
class Campaign < Struct.new(
|
108
|
+
:id,
|
109
|
+
:arn,
|
110
|
+
:name,
|
111
|
+
:connect_instance_id,
|
112
|
+
:channel_subtype_config,
|
113
|
+
:source,
|
114
|
+
:connect_campaign_flow_arn,
|
115
|
+
:schedule,
|
116
|
+
:communication_time_config,
|
117
|
+
:communication_limits_override,
|
118
|
+
:tags)
|
119
|
+
SENSITIVE = []
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
123
|
+
# Filter model by type
|
124
|
+
#
|
125
|
+
# @!attribute [rw] instance_id_filter
|
126
|
+
# Connect instance identifier filter
|
127
|
+
# @return [Types::InstanceIdFilter]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CampaignFilters AWS API Documentation
|
130
|
+
#
|
131
|
+
class CampaignFilters < Struct.new(
|
132
|
+
:instance_id_filter)
|
133
|
+
SENSITIVE = []
|
134
|
+
include Aws::Structure
|
135
|
+
end
|
136
|
+
|
137
|
+
# An Amazon Connect campaign summary.
|
138
|
+
#
|
139
|
+
# @!attribute [rw] id
|
140
|
+
# Identifier representing a Campaign
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] arn
|
144
|
+
# The resource name of an Amazon Connect campaign.
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] name
|
148
|
+
# The name of an Amazon Connect Campaign name.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] connect_instance_id
|
152
|
+
# Amazon Connect Instance Id
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] channel_subtypes
|
156
|
+
# Channel subtype list
|
157
|
+
# @return [Array<String>]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] schedule
|
160
|
+
# Campaign schedule
|
161
|
+
# @return [Types::Schedule]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] connect_campaign_flow_arn
|
164
|
+
# Amazon Resource Names(ARN)
|
165
|
+
# @return [String]
|
166
|
+
#
|
167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CampaignSummary AWS API Documentation
|
168
|
+
#
|
169
|
+
class CampaignSummary < Struct.new(
|
170
|
+
:id,
|
171
|
+
:arn,
|
172
|
+
:name,
|
173
|
+
:connect_instance_id,
|
174
|
+
:channel_subtypes,
|
175
|
+
:schedule,
|
176
|
+
:connect_campaign_flow_arn)
|
177
|
+
SENSITIVE = []
|
178
|
+
include Aws::Structure
|
179
|
+
end
|
180
|
+
|
181
|
+
# Campaign Channel Subtype config
|
182
|
+
#
|
183
|
+
# @!attribute [rw] telephony
|
184
|
+
# Telephony Channel Subtype config
|
185
|
+
# @return [Types::TelephonyChannelSubtypeConfig]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] sms
|
188
|
+
# SMS Channel Subtype config
|
189
|
+
# @return [Types::SmsChannelSubtypeConfig]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] email
|
192
|
+
# Email Channel Subtype config
|
193
|
+
# @return [Types::EmailChannelSubtypeConfig]
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ChannelSubtypeConfig AWS API Documentation
|
196
|
+
#
|
197
|
+
class ChannelSubtypeConfig < Struct.new(
|
198
|
+
:telephony,
|
199
|
+
:sms,
|
200
|
+
:email)
|
201
|
+
SENSITIVE = []
|
202
|
+
include Aws::Structure
|
203
|
+
end
|
204
|
+
|
205
|
+
# ChannelSubtypeParameters for an outbound request
|
206
|
+
#
|
207
|
+
# @note ChannelSubtypeParameters is a union - when making an API calls you must set exactly one of the members.
|
208
|
+
#
|
209
|
+
# @!attribute [rw] telephony
|
210
|
+
# Parameters for the Telephony Channel Subtype
|
211
|
+
# @return [Types::TelephonyChannelSubtypeParameters]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] sms
|
214
|
+
# Parameters for the SMS Channel Subtype
|
215
|
+
# @return [Types::SmsChannelSubtypeParameters]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] email
|
218
|
+
# Parameters for the Email Channel Subtype
|
219
|
+
# @return [Types::EmailChannelSubtypeParameters]
|
220
|
+
#
|
221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ChannelSubtypeParameters AWS API Documentation
|
222
|
+
#
|
223
|
+
class ChannelSubtypeParameters < Struct.new(
|
224
|
+
:telephony,
|
225
|
+
:sms,
|
226
|
+
:email,
|
227
|
+
:unknown)
|
228
|
+
SENSITIVE = []
|
229
|
+
include Aws::Structure
|
230
|
+
include Aws::Structure::Union
|
231
|
+
|
232
|
+
class Telephony < ChannelSubtypeParameters; end
|
233
|
+
class Sms < ChannelSubtypeParameters; end
|
234
|
+
class Email < ChannelSubtypeParameters; end
|
235
|
+
class Unknown < ChannelSubtypeParameters; end
|
236
|
+
end
|
237
|
+
|
238
|
+
# Communication Limit
|
239
|
+
#
|
240
|
+
# @!attribute [rw] max_count_per_recipient
|
241
|
+
# Maximum number of contacts allowed for a given target within the
|
242
|
+
# given frequency.
|
243
|
+
# @return [Integer]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] frequency
|
246
|
+
# The number of days to consider with regards to this limit.
|
247
|
+
# @return [Integer]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] unit
|
250
|
+
# The communication limit time unit.
|
251
|
+
# @return [String]
|
252
|
+
#
|
253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CommunicationLimit AWS API Documentation
|
254
|
+
#
|
255
|
+
class CommunicationLimit < Struct.new(
|
256
|
+
:max_count_per_recipient,
|
257
|
+
:frequency,
|
258
|
+
:unit)
|
259
|
+
SENSITIVE = []
|
260
|
+
include Aws::Structure
|
261
|
+
end
|
262
|
+
|
263
|
+
# Communication limits
|
264
|
+
#
|
265
|
+
# @note CommunicationLimits is a union - when making an API calls you must set exactly one of the members.
|
266
|
+
#
|
267
|
+
# @note CommunicationLimits is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CommunicationLimits corresponding to the set member.
|
268
|
+
#
|
269
|
+
# @!attribute [rw] communication_limits_list
|
270
|
+
# List of communication limit
|
271
|
+
# @return [Array<Types::CommunicationLimit>]
|
272
|
+
#
|
273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CommunicationLimits AWS API Documentation
|
274
|
+
#
|
275
|
+
class CommunicationLimits < Struct.new(
|
276
|
+
:communication_limits_list,
|
277
|
+
:unknown)
|
278
|
+
SENSITIVE = []
|
279
|
+
include Aws::Structure
|
280
|
+
include Aws::Structure::Union
|
281
|
+
|
282
|
+
class CommunicationLimitsList < CommunicationLimits; end
|
283
|
+
class Unknown < CommunicationLimits; end
|
284
|
+
end
|
285
|
+
|
286
|
+
# Communication limits config
|
287
|
+
#
|
288
|
+
# @!attribute [rw] all_channel_subtypes
|
289
|
+
# Communication limits
|
290
|
+
# @return [Types::CommunicationLimits]
|
291
|
+
#
|
292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CommunicationLimitsConfig AWS API Documentation
|
293
|
+
#
|
294
|
+
class CommunicationLimitsConfig < Struct.new(
|
295
|
+
:all_channel_subtypes)
|
296
|
+
SENSITIVE = []
|
297
|
+
include Aws::Structure
|
298
|
+
end
|
299
|
+
|
300
|
+
# Campaign communication time config
|
301
|
+
#
|
302
|
+
# @!attribute [rw] local_time_zone_config
|
303
|
+
# Local time zone config
|
304
|
+
# @return [Types::LocalTimeZoneConfig]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] telephony
|
307
|
+
# Time window config
|
308
|
+
# @return [Types::TimeWindow]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] sms
|
311
|
+
# Time window config
|
312
|
+
# @return [Types::TimeWindow]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] email
|
315
|
+
# Time window config
|
316
|
+
# @return [Types::TimeWindow]
|
317
|
+
#
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CommunicationTimeConfig AWS API Documentation
|
319
|
+
#
|
320
|
+
class CommunicationTimeConfig < Struct.new(
|
321
|
+
:local_time_zone_config,
|
322
|
+
:telephony,
|
323
|
+
:sms,
|
324
|
+
:email)
|
325
|
+
SENSITIVE = []
|
326
|
+
include Aws::Structure
|
327
|
+
end
|
328
|
+
|
329
|
+
# The request could not be processed because of conflict in the current
|
330
|
+
# state of the resource.
|
331
|
+
#
|
332
|
+
# @!attribute [rw] message
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] x_amz_error_type
|
336
|
+
# A header that defines the error encountered while processing the
|
337
|
+
# request.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ConflictException AWS API Documentation
|
341
|
+
#
|
342
|
+
class ConflictException < Struct.new(
|
343
|
+
:message,
|
344
|
+
:x_amz_error_type)
|
345
|
+
SENSITIVE = []
|
346
|
+
include Aws::Structure
|
347
|
+
end
|
348
|
+
|
349
|
+
# The request for CreateCampaign API.
|
350
|
+
#
|
351
|
+
# @!attribute [rw] name
|
352
|
+
# The name of an Amazon Connect Campaign name.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] connect_instance_id
|
356
|
+
# Amazon Connect Instance Id
|
357
|
+
# @return [String]
|
358
|
+
#
|
359
|
+
# @!attribute [rw] channel_subtype_config
|
360
|
+
# Campaign Channel Subtype config
|
361
|
+
# @return [Types::ChannelSubtypeConfig]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] source
|
364
|
+
# Source of the campaign
|
365
|
+
# @return [Types::Source]
|
366
|
+
#
|
367
|
+
# @!attribute [rw] connect_campaign_flow_arn
|
368
|
+
# Amazon Resource Names(ARN)
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] schedule
|
372
|
+
# Campaign schedule
|
373
|
+
# @return [Types::Schedule]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] communication_time_config
|
376
|
+
# Campaign communication time config
|
377
|
+
# @return [Types::CommunicationTimeConfig]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] communication_limits_override
|
380
|
+
# Communication limits config
|
381
|
+
# @return [Types::CommunicationLimitsConfig]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] tags
|
384
|
+
# Tag map with key and value.
|
385
|
+
# @return [Hash<String,String>]
|
386
|
+
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CreateCampaignRequest AWS API Documentation
|
388
|
+
#
|
389
|
+
class CreateCampaignRequest < Struct.new(
|
390
|
+
:name,
|
391
|
+
:connect_instance_id,
|
392
|
+
:channel_subtype_config,
|
393
|
+
:source,
|
394
|
+
:connect_campaign_flow_arn,
|
395
|
+
:schedule,
|
396
|
+
:communication_time_config,
|
397
|
+
:communication_limits_override,
|
398
|
+
:tags)
|
399
|
+
SENSITIVE = []
|
400
|
+
include Aws::Structure
|
401
|
+
end
|
402
|
+
|
403
|
+
# The response for Create Campaign API
|
404
|
+
#
|
405
|
+
# @!attribute [rw] id
|
406
|
+
# Identifier representing a Campaign
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] arn
|
410
|
+
# The resource name of an Amazon Connect campaign.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] tags
|
414
|
+
# Tag map with key and value.
|
415
|
+
# @return [Hash<String,String>]
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CreateCampaignResponse AWS API Documentation
|
418
|
+
#
|
419
|
+
class CreateCampaignResponse < Struct.new(
|
420
|
+
:id,
|
421
|
+
:arn,
|
422
|
+
:tags)
|
423
|
+
SENSITIVE = []
|
424
|
+
include Aws::Structure
|
425
|
+
end
|
426
|
+
|
427
|
+
# Customer Profiles integration config
|
428
|
+
#
|
429
|
+
# @!attribute [rw] domain_arn
|
430
|
+
# Amazon Resource Names(ARN)
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] object_type_names
|
434
|
+
# Object type names map.
|
435
|
+
# @return [Hash<String,String>]
|
436
|
+
#
|
437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CustomerProfilesIntegrationConfig AWS API Documentation
|
438
|
+
#
|
439
|
+
class CustomerProfilesIntegrationConfig < Struct.new(
|
440
|
+
:domain_arn,
|
441
|
+
:object_type_names)
|
442
|
+
SENSITIVE = []
|
443
|
+
include Aws::Structure
|
444
|
+
end
|
445
|
+
|
446
|
+
# Customer Profiles integration identifier
|
447
|
+
#
|
448
|
+
# @!attribute [rw] domain_arn
|
449
|
+
# Amazon Resource Names(ARN)
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CustomerProfilesIntegrationIdentifier AWS API Documentation
|
453
|
+
#
|
454
|
+
class CustomerProfilesIntegrationIdentifier < Struct.new(
|
455
|
+
:domain_arn)
|
456
|
+
SENSITIVE = []
|
457
|
+
include Aws::Structure
|
458
|
+
end
|
459
|
+
|
460
|
+
# Customer Profiles integration summary
|
461
|
+
#
|
462
|
+
# @!attribute [rw] domain_arn
|
463
|
+
# Amazon Resource Names(ARN)
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] object_type_names
|
467
|
+
# Object type names map.
|
468
|
+
# @return [Hash<String,String>]
|
469
|
+
#
|
470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/CustomerProfilesIntegrationSummary AWS API Documentation
|
471
|
+
#
|
472
|
+
class CustomerProfilesIntegrationSummary < Struct.new(
|
473
|
+
:domain_arn,
|
474
|
+
:object_type_names)
|
475
|
+
SENSITIVE = []
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
479
|
+
# The request for DeleteCampaignChannelSubtypeConfig API.
|
480
|
+
#
|
481
|
+
# @!attribute [rw] id
|
482
|
+
# Identifier representing a Campaign
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @!attribute [rw] channel_subtype
|
486
|
+
# The type of campaign channel subtype.
|
487
|
+
# @return [String]
|
488
|
+
#
|
489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfigRequest AWS API Documentation
|
490
|
+
#
|
491
|
+
class DeleteCampaignChannelSubtypeConfigRequest < Struct.new(
|
492
|
+
:id,
|
493
|
+
:channel_subtype)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# The request for DeleteCampaignCommunicationLimits API.
|
499
|
+
#
|
500
|
+
# @!attribute [rw] id
|
501
|
+
# Identifier representing a Campaign
|
502
|
+
# @return [String]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] config
|
505
|
+
# The type of campaign communication limits config.
|
506
|
+
# @return [String]
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimitsRequest AWS API Documentation
|
509
|
+
#
|
510
|
+
class DeleteCampaignCommunicationLimitsRequest < Struct.new(
|
511
|
+
:id,
|
512
|
+
:config)
|
513
|
+
SENSITIVE = []
|
514
|
+
include Aws::Structure
|
515
|
+
end
|
516
|
+
|
517
|
+
# The request for DeleteCampaignCommunicationTime API.
|
518
|
+
#
|
519
|
+
# @!attribute [rw] id
|
520
|
+
# Identifier representing a Campaign
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] config
|
524
|
+
# The type of campaign communication time config
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTimeRequest AWS API Documentation
|
528
|
+
#
|
529
|
+
class DeleteCampaignCommunicationTimeRequest < Struct.new(
|
530
|
+
:id,
|
531
|
+
:config)
|
532
|
+
SENSITIVE = []
|
533
|
+
include Aws::Structure
|
534
|
+
end
|
535
|
+
|
536
|
+
# The request for DeleteCampaign API.
|
537
|
+
#
|
538
|
+
# @!attribute [rw] id
|
539
|
+
# Identifier representing a Campaign
|
540
|
+
# @return [String]
|
541
|
+
#
|
542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteCampaignRequest AWS API Documentation
|
543
|
+
#
|
544
|
+
class DeleteCampaignRequest < Struct.new(
|
545
|
+
:id)
|
546
|
+
SENSITIVE = []
|
547
|
+
include Aws::Structure
|
548
|
+
end
|
549
|
+
|
550
|
+
# The request for DeleteConnectInstanceConfig API.
|
551
|
+
#
|
552
|
+
# @!attribute [rw] connect_instance_id
|
553
|
+
# Amazon Connect Instance Id
|
554
|
+
# @return [String]
|
555
|
+
#
|
556
|
+
# @!attribute [rw] campaign_deletion_policy
|
557
|
+
# Enumeration of the policies to enact on existing campaigns during
|
558
|
+
# instance config deletion
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfigRequest AWS API Documentation
|
562
|
+
#
|
563
|
+
class DeleteConnectInstanceConfigRequest < Struct.new(
|
564
|
+
:connect_instance_id,
|
565
|
+
:campaign_deletion_policy)
|
566
|
+
SENSITIVE = []
|
567
|
+
include Aws::Structure
|
568
|
+
end
|
569
|
+
|
570
|
+
# The request for DeleteConnectInstanceIntegration API.
|
571
|
+
#
|
572
|
+
# @!attribute [rw] connect_instance_id
|
573
|
+
# Amazon Connect Instance Id
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] integration_identifier
|
577
|
+
# Integration identifier for Connect instance
|
578
|
+
# @return [Types::IntegrationIdentifier]
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegrationRequest AWS API Documentation
|
581
|
+
#
|
582
|
+
class DeleteConnectInstanceIntegrationRequest < Struct.new(
|
583
|
+
:connect_instance_id,
|
584
|
+
:integration_identifier)
|
585
|
+
SENSITIVE = []
|
586
|
+
include Aws::Structure
|
587
|
+
end
|
588
|
+
|
589
|
+
# The request for DeleteInstanceOnboardingJob API.
|
590
|
+
#
|
591
|
+
# @!attribute [rw] connect_instance_id
|
592
|
+
# Amazon Connect Instance Id
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJobRequest AWS API Documentation
|
596
|
+
#
|
597
|
+
class DeleteInstanceOnboardingJobRequest < Struct.new(
|
598
|
+
:connect_instance_id)
|
599
|
+
SENSITIVE = []
|
600
|
+
include Aws::Structure
|
601
|
+
end
|
602
|
+
|
603
|
+
# The request for DescribeCampaign API.
|
604
|
+
#
|
605
|
+
# @!attribute [rw] id
|
606
|
+
# Identifier representing a Campaign
|
607
|
+
# @return [String]
|
608
|
+
#
|
609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DescribeCampaignRequest AWS API Documentation
|
610
|
+
#
|
611
|
+
class DescribeCampaignRequest < Struct.new(
|
612
|
+
:id)
|
613
|
+
SENSITIVE = []
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
617
|
+
# The response for DescribeCampaign API.
|
618
|
+
#
|
619
|
+
# @!attribute [rw] campaign
|
620
|
+
# An Amazon Connect campaign.
|
621
|
+
# @return [Types::Campaign]
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/DescribeCampaignResponse AWS API Documentation
|
624
|
+
#
|
625
|
+
class DescribeCampaignResponse < Struct.new(
|
626
|
+
:campaign)
|
627
|
+
SENSITIVE = []
|
628
|
+
include Aws::Structure
|
629
|
+
end
|
630
|
+
|
631
|
+
# Email Channel Subtype config
|
632
|
+
#
|
633
|
+
# @!attribute [rw] capacity
|
634
|
+
# Allocates outbound capacity for the specific channel subtype of this
|
635
|
+
# campaign between multiple active campaigns
|
636
|
+
# @return [Float]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] outbound_mode
|
639
|
+
# Email Outbound Mode
|
640
|
+
# @return [Types::EmailOutboundMode]
|
641
|
+
#
|
642
|
+
# @!attribute [rw] default_outbound_config
|
643
|
+
# Default Email Outbound config
|
644
|
+
# @return [Types::EmailOutboundConfig]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EmailChannelSubtypeConfig AWS API Documentation
|
647
|
+
#
|
648
|
+
class EmailChannelSubtypeConfig < Struct.new(
|
649
|
+
:capacity,
|
650
|
+
:outbound_mode,
|
651
|
+
:default_outbound_config)
|
652
|
+
SENSITIVE = []
|
653
|
+
include Aws::Structure
|
654
|
+
end
|
655
|
+
|
656
|
+
# Parameters for the Email Channel Subtype
|
657
|
+
#
|
658
|
+
# @!attribute [rw] destination_email_address
|
659
|
+
# Source/Destination Email address used for Email messages
|
660
|
+
# @return [String]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] connect_source_email_address
|
663
|
+
# Source/Destination Email address used for Email messages
|
664
|
+
# @return [String]
|
665
|
+
#
|
666
|
+
# @!attribute [rw] template_arn
|
667
|
+
# Amazon Resource Names(ARN)
|
668
|
+
# @return [String]
|
669
|
+
#
|
670
|
+
# @!attribute [rw] template_parameters
|
671
|
+
# A custom key-value pair using an attribute map. The attributes are
|
672
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
673
|
+
# flows just like any other contact attributes.
|
674
|
+
# @return [Hash<String,String>]
|
675
|
+
#
|
676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EmailChannelSubtypeParameters AWS API Documentation
|
677
|
+
#
|
678
|
+
class EmailChannelSubtypeParameters < Struct.new(
|
679
|
+
:destination_email_address,
|
680
|
+
:connect_source_email_address,
|
681
|
+
:template_arn,
|
682
|
+
:template_parameters)
|
683
|
+
SENSITIVE = [:destination_email_address, :connect_source_email_address, :template_parameters]
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
687
|
+
# Default Email Outbound config
|
688
|
+
#
|
689
|
+
# @!attribute [rw] connect_source_email_address
|
690
|
+
# Source/Destination Email address used for Email messages
|
691
|
+
# @return [String]
|
692
|
+
#
|
693
|
+
# @!attribute [rw] source_email_address_display_name
|
694
|
+
# Display name for Email Address
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] wisdom_template_arn
|
698
|
+
# Amazon Resource Names(ARN)
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EmailOutboundConfig AWS API Documentation
|
702
|
+
#
|
703
|
+
class EmailOutboundConfig < Struct.new(
|
704
|
+
:connect_source_email_address,
|
705
|
+
:source_email_address_display_name,
|
706
|
+
:wisdom_template_arn)
|
707
|
+
SENSITIVE = [:connect_source_email_address, :source_email_address_display_name]
|
708
|
+
include Aws::Structure
|
709
|
+
end
|
710
|
+
|
711
|
+
# Email Outbound Mode
|
712
|
+
#
|
713
|
+
# @note EmailOutboundMode is a union - when making an API calls you must set exactly one of the members.
|
714
|
+
#
|
715
|
+
# @note EmailOutboundMode is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EmailOutboundMode corresponding to the set member.
|
716
|
+
#
|
717
|
+
# @!attribute [rw] agentless
|
718
|
+
# Agentless config
|
719
|
+
# @return [Types::AgentlessConfig]
|
720
|
+
#
|
721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EmailOutboundMode AWS API Documentation
|
722
|
+
#
|
723
|
+
class EmailOutboundMode < Struct.new(
|
724
|
+
:agentless,
|
725
|
+
:unknown)
|
726
|
+
SENSITIVE = []
|
727
|
+
include Aws::Structure
|
728
|
+
include Aws::Structure::Union
|
729
|
+
|
730
|
+
class Agentless < EmailOutboundMode; end
|
731
|
+
class Unknown < EmailOutboundMode; end
|
732
|
+
end
|
733
|
+
|
734
|
+
# Encryption config for Connect Instance. Note that sensitive data will
|
735
|
+
# always be encrypted. If disabled, service will perform encryption with
|
736
|
+
# its own key. If enabled, a KMS key id needs to be provided and KMS
|
737
|
+
# charges will apply. KMS is only type supported
|
738
|
+
#
|
739
|
+
# @!attribute [rw] enabled
|
740
|
+
# Boolean to indicate if custom encryption has been enabled.
|
741
|
+
# @return [Boolean]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] encryption_type
|
744
|
+
# Server-side encryption type.
|
745
|
+
# @return [String]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] key_arn
|
748
|
+
# KMS key id/arn for encryption config.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EncryptionConfig AWS API Documentation
|
752
|
+
#
|
753
|
+
class EncryptionConfig < Struct.new(
|
754
|
+
:enabled,
|
755
|
+
:encryption_type,
|
756
|
+
:key_arn)
|
757
|
+
SENSITIVE = []
|
758
|
+
include Aws::Structure
|
759
|
+
end
|
760
|
+
|
761
|
+
# Failed response of campaign state
|
762
|
+
#
|
763
|
+
# @!attribute [rw] campaign_id
|
764
|
+
# Identifier representing a Campaign
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @!attribute [rw] failure_code
|
768
|
+
# A predefined code indicating the error that caused the failure in
|
769
|
+
# getting state of campaigns
|
770
|
+
# @return [String]
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/FailedCampaignStateResponse AWS API Documentation
|
773
|
+
#
|
774
|
+
class FailedCampaignStateResponse < Struct.new(
|
775
|
+
:campaign_id,
|
776
|
+
:failure_code)
|
777
|
+
SENSITIVE = []
|
778
|
+
include Aws::Structure
|
779
|
+
end
|
780
|
+
|
781
|
+
# A failed request identified by the unique client token.
|
782
|
+
#
|
783
|
+
# @!attribute [rw] client_token
|
784
|
+
# Client provided parameter used for idempotency. Its value must be
|
785
|
+
# unique for each request.
|
786
|
+
# @return [String]
|
787
|
+
#
|
788
|
+
# @!attribute [rw] id
|
789
|
+
# Identifier representing a Dial request
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] failure_code
|
793
|
+
# A predefined code indicating the error that caused the failure.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/FailedRequest AWS API Documentation
|
797
|
+
#
|
798
|
+
class FailedRequest < Struct.new(
|
799
|
+
:client_token,
|
800
|
+
:id,
|
801
|
+
:failure_code)
|
802
|
+
SENSITIVE = []
|
803
|
+
include Aws::Structure
|
804
|
+
end
|
805
|
+
|
806
|
+
# The request for GetCampaignStateBatch API.
|
807
|
+
#
|
808
|
+
# @!attribute [rw] campaign_ids
|
809
|
+
# List of CampaignId
|
810
|
+
# @return [Array<String>]
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateBatchRequest AWS API Documentation
|
813
|
+
#
|
814
|
+
class GetCampaignStateBatchRequest < Struct.new(
|
815
|
+
:campaign_ids)
|
816
|
+
SENSITIVE = []
|
817
|
+
include Aws::Structure
|
818
|
+
end
|
819
|
+
|
820
|
+
# The response for GetCampaignStateBatch API.
|
821
|
+
#
|
822
|
+
# @!attribute [rw] successful_requests
|
823
|
+
# List of successful response of campaign state
|
824
|
+
# @return [Array<Types::SuccessfulCampaignStateResponse>]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] failed_requests
|
827
|
+
# List of failed requests of campaign state
|
828
|
+
# @return [Array<Types::FailedCampaignStateResponse>]
|
829
|
+
#
|
830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateBatchResponse AWS API Documentation
|
831
|
+
#
|
832
|
+
class GetCampaignStateBatchResponse < Struct.new(
|
833
|
+
:successful_requests,
|
834
|
+
:failed_requests)
|
835
|
+
SENSITIVE = []
|
836
|
+
include Aws::Structure
|
837
|
+
end
|
838
|
+
|
839
|
+
# The request for GetCampaignState API.
|
840
|
+
#
|
841
|
+
# @!attribute [rw] id
|
842
|
+
# Identifier representing a Campaign
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateRequest AWS API Documentation
|
846
|
+
#
|
847
|
+
class GetCampaignStateRequest < Struct.new(
|
848
|
+
:id)
|
849
|
+
SENSITIVE = []
|
850
|
+
include Aws::Structure
|
851
|
+
end
|
852
|
+
|
853
|
+
# The response for GetCampaignState API.
|
854
|
+
#
|
855
|
+
# @!attribute [rw] state
|
856
|
+
# State of a campaign
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetCampaignStateResponse AWS API Documentation
|
860
|
+
#
|
861
|
+
class GetCampaignStateResponse < Struct.new(
|
862
|
+
:state)
|
863
|
+
SENSITIVE = []
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
867
|
+
# The request for GetConnectInstanceConfig API.
|
868
|
+
#
|
869
|
+
# @!attribute [rw] connect_instance_id
|
870
|
+
# Amazon Connect Instance Id
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetConnectInstanceConfigRequest AWS API Documentation
|
874
|
+
#
|
875
|
+
class GetConnectInstanceConfigRequest < Struct.new(
|
876
|
+
:connect_instance_id)
|
877
|
+
SENSITIVE = []
|
878
|
+
include Aws::Structure
|
879
|
+
end
|
880
|
+
|
881
|
+
# The response for GetConnectInstanceConfig API.
|
882
|
+
#
|
883
|
+
# @!attribute [rw] connect_instance_config
|
884
|
+
# Instance config object
|
885
|
+
# @return [Types::InstanceConfig]
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetConnectInstanceConfigResponse AWS API Documentation
|
888
|
+
#
|
889
|
+
class GetConnectInstanceConfigResponse < Struct.new(
|
890
|
+
:connect_instance_config)
|
891
|
+
SENSITIVE = []
|
892
|
+
include Aws::Structure
|
893
|
+
end
|
894
|
+
|
895
|
+
# The request for GetInstanceOnboardingJobStatus API.
|
896
|
+
#
|
897
|
+
# @!attribute [rw] connect_instance_id
|
898
|
+
# Amazon Connect Instance Id
|
899
|
+
# @return [String]
|
900
|
+
#
|
901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatusRequest AWS API Documentation
|
902
|
+
#
|
903
|
+
class GetInstanceOnboardingJobStatusRequest < Struct.new(
|
904
|
+
:connect_instance_id)
|
905
|
+
SENSITIVE = []
|
906
|
+
include Aws::Structure
|
907
|
+
end
|
908
|
+
|
909
|
+
# The response for GetInstanceOnboardingJobStatus API.
|
910
|
+
#
|
911
|
+
# @!attribute [rw] connect_instance_onboarding_job_status
|
912
|
+
# Instance onboarding job status object
|
913
|
+
# @return [Types::InstanceOnboardingJobStatus]
|
914
|
+
#
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatusResponse AWS API Documentation
|
916
|
+
#
|
917
|
+
class GetInstanceOnboardingJobStatusResponse < Struct.new(
|
918
|
+
:connect_instance_onboarding_job_status)
|
919
|
+
SENSITIVE = []
|
920
|
+
include Aws::Structure
|
921
|
+
end
|
922
|
+
|
923
|
+
# Instance config object
|
924
|
+
#
|
925
|
+
# @!attribute [rw] connect_instance_id
|
926
|
+
# Amazon Connect Instance Id
|
927
|
+
# @return [String]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] service_linked_role_arn
|
930
|
+
# Service linked role arn
|
931
|
+
# @return [String]
|
932
|
+
#
|
933
|
+
# @!attribute [rw] encryption_config
|
934
|
+
# Encryption config for Connect Instance. Note that sensitive data
|
935
|
+
# will always be encrypted. If disabled, service will perform
|
936
|
+
# encryption with its own key. If enabled, a KMS key id needs to be
|
937
|
+
# provided and KMS charges will apply. KMS is only type supported
|
938
|
+
# @return [Types::EncryptionConfig]
|
939
|
+
#
|
940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InstanceConfig AWS API Documentation
|
941
|
+
#
|
942
|
+
class InstanceConfig < Struct.new(
|
943
|
+
:connect_instance_id,
|
944
|
+
:service_linked_role_arn,
|
945
|
+
:encryption_config)
|
946
|
+
SENSITIVE = []
|
947
|
+
include Aws::Structure
|
948
|
+
end
|
949
|
+
|
950
|
+
# Connect instance identifier filter
|
951
|
+
#
|
952
|
+
# @!attribute [rw] value
|
953
|
+
# Amazon Connect Instance Id
|
954
|
+
# @return [String]
|
955
|
+
#
|
956
|
+
# @!attribute [rw] operator
|
957
|
+
# Operators for Connect instance identifier filter
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InstanceIdFilter AWS API Documentation
|
961
|
+
#
|
962
|
+
class InstanceIdFilter < Struct.new(
|
963
|
+
:value,
|
964
|
+
:operator)
|
965
|
+
SENSITIVE = []
|
966
|
+
include Aws::Structure
|
967
|
+
end
|
968
|
+
|
969
|
+
# Instance onboarding job status object
|
970
|
+
#
|
971
|
+
# @!attribute [rw] connect_instance_id
|
972
|
+
# Amazon Connect Instance Id
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] status
|
976
|
+
# Enumeration of the possible states for instance onboarding job
|
977
|
+
# @return [String]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] failure_code
|
980
|
+
# Enumeration of the possible failure codes for instance onboarding
|
981
|
+
# job
|
982
|
+
# @return [String]
|
983
|
+
#
|
984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InstanceOnboardingJobStatus AWS API Documentation
|
985
|
+
#
|
986
|
+
class InstanceOnboardingJobStatus < Struct.new(
|
987
|
+
:connect_instance_id,
|
988
|
+
:status,
|
989
|
+
:failure_code)
|
990
|
+
SENSITIVE = []
|
991
|
+
include Aws::Structure
|
992
|
+
end
|
993
|
+
|
994
|
+
# Integration config for Connect Instance
|
995
|
+
#
|
996
|
+
# @note IntegrationConfig is a union - when making an API calls you must set exactly one of the members.
|
997
|
+
#
|
998
|
+
# @!attribute [rw] customer_profiles
|
999
|
+
# Customer Profiles integration config
|
1000
|
+
# @return [Types::CustomerProfilesIntegrationConfig]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] q_connect
|
1003
|
+
# Q Connect integration config
|
1004
|
+
# @return [Types::QConnectIntegrationConfig]
|
1005
|
+
#
|
1006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/IntegrationConfig AWS API Documentation
|
1007
|
+
#
|
1008
|
+
class IntegrationConfig < Struct.new(
|
1009
|
+
:customer_profiles,
|
1010
|
+
:q_connect,
|
1011
|
+
:unknown)
|
1012
|
+
SENSITIVE = []
|
1013
|
+
include Aws::Structure
|
1014
|
+
include Aws::Structure::Union
|
1015
|
+
|
1016
|
+
class CustomerProfiles < IntegrationConfig; end
|
1017
|
+
class QConnect < IntegrationConfig; end
|
1018
|
+
class Unknown < IntegrationConfig; end
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# Integration identifier for Connect instance
|
1022
|
+
#
|
1023
|
+
# @note IntegrationIdentifier is a union - when making an API calls you must set exactly one of the members.
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] customer_profiles
|
1026
|
+
# Customer Profiles integration identifier
|
1027
|
+
# @return [Types::CustomerProfilesIntegrationIdentifier]
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] q_connect
|
1030
|
+
# Q Connect integration identifier
|
1031
|
+
# @return [Types::QConnectIntegrationIdentifier]
|
1032
|
+
#
|
1033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/IntegrationIdentifier AWS API Documentation
|
1034
|
+
#
|
1035
|
+
class IntegrationIdentifier < Struct.new(
|
1036
|
+
:customer_profiles,
|
1037
|
+
:q_connect,
|
1038
|
+
:unknown)
|
1039
|
+
SENSITIVE = []
|
1040
|
+
include Aws::Structure
|
1041
|
+
include Aws::Structure::Union
|
1042
|
+
|
1043
|
+
class CustomerProfiles < IntegrationIdentifier; end
|
1044
|
+
class QConnect < IntegrationIdentifier; end
|
1045
|
+
class Unknown < IntegrationIdentifier; end
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# Integration summary for Connect instance.
|
1049
|
+
#
|
1050
|
+
# @note IntegrationSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IntegrationSummary corresponding to the set member.
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] customer_profiles
|
1053
|
+
# Customer Profiles integration summary
|
1054
|
+
# @return [Types::CustomerProfilesIntegrationSummary]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] q_connect
|
1057
|
+
# Q Connect integration summary
|
1058
|
+
# @return [Types::QConnectIntegrationSummary]
|
1059
|
+
#
|
1060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/IntegrationSummary AWS API Documentation
|
1061
|
+
#
|
1062
|
+
class IntegrationSummary < Struct.new(
|
1063
|
+
:customer_profiles,
|
1064
|
+
:q_connect,
|
1065
|
+
:unknown)
|
1066
|
+
SENSITIVE = []
|
1067
|
+
include Aws::Structure
|
1068
|
+
include Aws::Structure::Union
|
1069
|
+
|
1070
|
+
class CustomerProfiles < IntegrationSummary; end
|
1071
|
+
class QConnect < IntegrationSummary; end
|
1072
|
+
class Unknown < IntegrationSummary; end
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
# Request processing failed because of an error or failure with the
|
1076
|
+
# service.
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] message
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @!attribute [rw] x_amz_error_type
|
1082
|
+
# A header that defines the error encountered while processing the
|
1083
|
+
# request.
|
1084
|
+
# @return [String]
|
1085
|
+
#
|
1086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InternalServerException AWS API Documentation
|
1087
|
+
#
|
1088
|
+
class InternalServerException < Struct.new(
|
1089
|
+
:message,
|
1090
|
+
:x_amz_error_type)
|
1091
|
+
SENSITIVE = []
|
1092
|
+
include Aws::Structure
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# The request could not be processed because of conflict in the current
|
1096
|
+
# state of the campaign.
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] state
|
1099
|
+
# State of a campaign
|
1100
|
+
# @return [String]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] message
|
1103
|
+
# @return [String]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] x_amz_error_type
|
1106
|
+
# A header that defines the error encountered while processing the
|
1107
|
+
# request.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InvalidCampaignStateException AWS API Documentation
|
1111
|
+
#
|
1112
|
+
class InvalidCampaignStateException < Struct.new(
|
1113
|
+
:state,
|
1114
|
+
:message,
|
1115
|
+
:x_amz_error_type)
|
1116
|
+
SENSITIVE = []
|
1117
|
+
include Aws::Structure
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
# The request could not be processed because of conflict in the current
|
1121
|
+
# state.
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] message
|
1124
|
+
# @return [String]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] x_amz_error_type
|
1127
|
+
# A header that defines the error encountered while processing the
|
1128
|
+
# request.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/InvalidStateException AWS API Documentation
|
1132
|
+
#
|
1133
|
+
class InvalidStateException < Struct.new(
|
1134
|
+
:message,
|
1135
|
+
:x_amz_error_type)
|
1136
|
+
SENSITIVE = []
|
1137
|
+
include Aws::Structure
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
# The request for ListCampaigns API.
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] max_results
|
1143
|
+
# The maximum number of results to return per page.
|
1144
|
+
# @return [Integer]
|
1145
|
+
#
|
1146
|
+
# @!attribute [rw] next_token
|
1147
|
+
# The token for the next set of results.
|
1148
|
+
# @return [String]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] filters
|
1151
|
+
# Filter model by type
|
1152
|
+
# @return [Types::CampaignFilters]
|
1153
|
+
#
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListCampaignsRequest AWS API Documentation
|
1155
|
+
#
|
1156
|
+
class ListCampaignsRequest < Struct.new(
|
1157
|
+
:max_results,
|
1158
|
+
:next_token,
|
1159
|
+
:filters)
|
1160
|
+
SENSITIVE = []
|
1161
|
+
include Aws::Structure
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# The response for ListCampaigns API.
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] next_token
|
1167
|
+
# The token for the next set of results.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] campaign_summary_list
|
1171
|
+
# A list of Amazon Connect campaigns.
|
1172
|
+
# @return [Array<Types::CampaignSummary>]
|
1173
|
+
#
|
1174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListCampaignsResponse AWS API Documentation
|
1175
|
+
#
|
1176
|
+
class ListCampaignsResponse < Struct.new(
|
1177
|
+
:next_token,
|
1178
|
+
:campaign_summary_list)
|
1179
|
+
SENSITIVE = []
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# The request for ListConnectInstanceIntegrations API.
|
1184
|
+
#
|
1185
|
+
# @!attribute [rw] connect_instance_id
|
1186
|
+
# Amazon Connect Instance Id
|
1187
|
+
# @return [String]
|
1188
|
+
#
|
1189
|
+
# @!attribute [rw] max_results
|
1190
|
+
# The maximum number of results to return per page.
|
1191
|
+
# @return [Integer]
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] next_token
|
1194
|
+
# The token for the next set of results.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrationsRequest AWS API Documentation
|
1198
|
+
#
|
1199
|
+
class ListConnectInstanceIntegrationsRequest < Struct.new(
|
1200
|
+
:connect_instance_id,
|
1201
|
+
:max_results,
|
1202
|
+
:next_token)
|
1203
|
+
SENSITIVE = []
|
1204
|
+
include Aws::Structure
|
1205
|
+
end
|
1206
|
+
|
1207
|
+
# The response for ListConnectInstanceIntegrations API.
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] next_token
|
1210
|
+
# The token for the next set of results.
|
1211
|
+
# @return [String]
|
1212
|
+
#
|
1213
|
+
# @!attribute [rw] integration_summary_list
|
1214
|
+
# A list of Amazon Connect Instance Integrations.
|
1215
|
+
# @return [Array<Types::IntegrationSummary>]
|
1216
|
+
#
|
1217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrationsResponse AWS API Documentation
|
1218
|
+
#
|
1219
|
+
class ListConnectInstanceIntegrationsResponse < Struct.new(
|
1220
|
+
:next_token,
|
1221
|
+
:integration_summary_list)
|
1222
|
+
SENSITIVE = []
|
1223
|
+
include Aws::Structure
|
1224
|
+
end
|
1225
|
+
|
1226
|
+
# The request for ListTagsForResource API.
|
1227
|
+
#
|
1228
|
+
# @!attribute [rw] arn
|
1229
|
+
# Amazon Resource Names(ARN)
|
1230
|
+
# @return [String]
|
1231
|
+
#
|
1232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListTagsForResourceRequest AWS API Documentation
|
1233
|
+
#
|
1234
|
+
class ListTagsForResourceRequest < Struct.new(
|
1235
|
+
:arn)
|
1236
|
+
SENSITIVE = []
|
1237
|
+
include Aws::Structure
|
1238
|
+
end
|
1239
|
+
|
1240
|
+
# The request for ListTagsForResource API.
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] tags
|
1243
|
+
# Tag map with key and value.
|
1244
|
+
# @return [Hash<String,String>]
|
1245
|
+
#
|
1246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ListTagsForResourceResponse AWS API Documentation
|
1247
|
+
#
|
1248
|
+
class ListTagsForResourceResponse < Struct.new(
|
1249
|
+
:tags)
|
1250
|
+
SENSITIVE = []
|
1251
|
+
include Aws::Structure
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
# Local time zone config
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] default_time_zone
|
1257
|
+
# Time Zone Id in the IANA format
|
1258
|
+
# @return [String]
|
1259
|
+
#
|
1260
|
+
# @!attribute [rw] local_time_zone_detection
|
1261
|
+
# Local TimeZone Detection method list
|
1262
|
+
# @return [Array<String>]
|
1263
|
+
#
|
1264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/LocalTimeZoneConfig AWS API Documentation
|
1265
|
+
#
|
1266
|
+
class LocalTimeZoneConfig < Struct.new(
|
1267
|
+
:default_time_zone,
|
1268
|
+
:local_time_zone_detection)
|
1269
|
+
SENSITIVE = []
|
1270
|
+
include Aws::Structure
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
# Open Hours config
|
1274
|
+
#
|
1275
|
+
# @note OpenHours is a union - when making an API calls you must set exactly one of the members.
|
1276
|
+
#
|
1277
|
+
# @note OpenHours is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OpenHours corresponding to the set member.
|
1278
|
+
#
|
1279
|
+
# @!attribute [rw] daily_hours
|
1280
|
+
# Daily Hours map
|
1281
|
+
# @return [Hash<String,Array<Types::TimeRange>>]
|
1282
|
+
#
|
1283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/OpenHours AWS API Documentation
|
1284
|
+
#
|
1285
|
+
class OpenHours < Struct.new(
|
1286
|
+
:daily_hours,
|
1287
|
+
:unknown)
|
1288
|
+
SENSITIVE = []
|
1289
|
+
include Aws::Structure
|
1290
|
+
include Aws::Structure::Union
|
1291
|
+
|
1292
|
+
class DailyHours < OpenHours; end
|
1293
|
+
class Unknown < OpenHours; end
|
1294
|
+
end
|
1295
|
+
|
1296
|
+
# An outbound request for a campaign.
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] client_token
|
1299
|
+
# Client provided parameter used for idempotency. Its value must be
|
1300
|
+
# unique for each request.
|
1301
|
+
# @return [String]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] expiration_time
|
1304
|
+
# Timestamp with no UTC offset or timezone
|
1305
|
+
# @return [Time]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] channel_subtype_parameters
|
1308
|
+
# ChannelSubtypeParameters for an outbound request
|
1309
|
+
# @return [Types::ChannelSubtypeParameters]
|
1310
|
+
#
|
1311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/OutboundRequest AWS API Documentation
|
1312
|
+
#
|
1313
|
+
class OutboundRequest < Struct.new(
|
1314
|
+
:client_token,
|
1315
|
+
:expiration_time,
|
1316
|
+
:channel_subtype_parameters)
|
1317
|
+
SENSITIVE = []
|
1318
|
+
include Aws::Structure
|
1319
|
+
end
|
1320
|
+
|
1321
|
+
# The request for PauseCampaign API.
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] id
|
1324
|
+
# Identifier representing a Campaign
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PauseCampaignRequest AWS API Documentation
|
1328
|
+
#
|
1329
|
+
class PauseCampaignRequest < Struct.new(
|
1330
|
+
:id)
|
1331
|
+
SENSITIVE = []
|
1332
|
+
include Aws::Structure
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# Predictive config
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] bandwidth_allocation
|
1338
|
+
# The bandwidth allocation of a queue resource.
|
1339
|
+
# @return [Float]
|
1340
|
+
#
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PredictiveConfig AWS API Documentation
|
1342
|
+
#
|
1343
|
+
class PredictiveConfig < Struct.new(
|
1344
|
+
:bandwidth_allocation)
|
1345
|
+
SENSITIVE = []
|
1346
|
+
include Aws::Structure
|
1347
|
+
end
|
1348
|
+
|
1349
|
+
# Progressive config
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] bandwidth_allocation
|
1352
|
+
# The bandwidth allocation of a queue resource.
|
1353
|
+
# @return [Float]
|
1354
|
+
#
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ProgressiveConfig AWS API Documentation
|
1356
|
+
#
|
1357
|
+
class ProgressiveConfig < Struct.new(
|
1358
|
+
:bandwidth_allocation)
|
1359
|
+
SENSITIVE = []
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
# The request for PutConnectInstanceIntegration API.
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] connect_instance_id
|
1366
|
+
# Amazon Connect Instance Id
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] integration_config
|
1370
|
+
# Integration config for Connect Instance
|
1371
|
+
# @return [Types::IntegrationConfig]
|
1372
|
+
#
|
1373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegrationRequest AWS API Documentation
|
1374
|
+
#
|
1375
|
+
class PutConnectInstanceIntegrationRequest < Struct.new(
|
1376
|
+
:connect_instance_id,
|
1377
|
+
:integration_config)
|
1378
|
+
SENSITIVE = []
|
1379
|
+
include Aws::Structure
|
1380
|
+
end
|
1381
|
+
|
1382
|
+
# The request for PutOutboundRequestBatch API.
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] id
|
1385
|
+
# Identifier representing a Campaign
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1388
|
+
# @!attribute [rw] outbound_requests
|
1389
|
+
# A list of outbound requests.
|
1390
|
+
# @return [Array<Types::OutboundRequest>]
|
1391
|
+
#
|
1392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutOutboundRequestBatchRequest AWS API Documentation
|
1393
|
+
#
|
1394
|
+
class PutOutboundRequestBatchRequest < Struct.new(
|
1395
|
+
:id,
|
1396
|
+
:outbound_requests)
|
1397
|
+
SENSITIVE = []
|
1398
|
+
include Aws::Structure
|
1399
|
+
end
|
1400
|
+
|
1401
|
+
# The response for PutOutboundRequestBatch API.
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] successful_requests
|
1404
|
+
# A list of successful requests identified by the unique client token.
|
1405
|
+
# @return [Array<Types::SuccessfulRequest>]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] failed_requests
|
1408
|
+
# A list of failed requests.
|
1409
|
+
# @return [Array<Types::FailedRequest>]
|
1410
|
+
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutOutboundRequestBatchResponse AWS API Documentation
|
1412
|
+
#
|
1413
|
+
class PutOutboundRequestBatchResponse < Struct.new(
|
1414
|
+
:successful_requests,
|
1415
|
+
:failed_requests)
|
1416
|
+
SENSITIVE = []
|
1417
|
+
include Aws::Structure
|
1418
|
+
end
|
1419
|
+
|
1420
|
+
# Q Connect integration config
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] knowledge_base_arn
|
1423
|
+
# Amazon Resource Names(ARN)
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/QConnectIntegrationConfig AWS API Documentation
|
1427
|
+
#
|
1428
|
+
class QConnectIntegrationConfig < Struct.new(
|
1429
|
+
:knowledge_base_arn)
|
1430
|
+
SENSITIVE = []
|
1431
|
+
include Aws::Structure
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
# Q Connect integration identifier
|
1435
|
+
#
|
1436
|
+
# @!attribute [rw] knowledge_base_arn
|
1437
|
+
# Amazon Resource Names(ARN)
|
1438
|
+
# @return [String]
|
1439
|
+
#
|
1440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/QConnectIntegrationIdentifier AWS API Documentation
|
1441
|
+
#
|
1442
|
+
class QConnectIntegrationIdentifier < Struct.new(
|
1443
|
+
:knowledge_base_arn)
|
1444
|
+
SENSITIVE = []
|
1445
|
+
include Aws::Structure
|
1446
|
+
end
|
1447
|
+
|
1448
|
+
# Q Connect integration summary
|
1449
|
+
#
|
1450
|
+
# @!attribute [rw] knowledge_base_arn
|
1451
|
+
# Amazon Resource Names(ARN)
|
1452
|
+
# @return [String]
|
1453
|
+
#
|
1454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/QConnectIntegrationSummary AWS API Documentation
|
1455
|
+
#
|
1456
|
+
class QConnectIntegrationSummary < Struct.new(
|
1457
|
+
:knowledge_base_arn)
|
1458
|
+
SENSITIVE = []
|
1459
|
+
include Aws::Structure
|
1460
|
+
end
|
1461
|
+
|
1462
|
+
# The specified resource was not found.
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] message
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] x_amz_error_type
|
1468
|
+
# A header that defines the error encountered while processing the
|
1469
|
+
# request.
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ResourceNotFoundException AWS API Documentation
|
1473
|
+
#
|
1474
|
+
class ResourceNotFoundException < Struct.new(
|
1475
|
+
:message,
|
1476
|
+
:x_amz_error_type)
|
1477
|
+
SENSITIVE = []
|
1478
|
+
include Aws::Structure
|
1479
|
+
end
|
1480
|
+
|
1481
|
+
# Restricted period
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] name
|
1484
|
+
# The name of a restricted period.
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @!attribute [rw] start_date
|
1488
|
+
# Date in ISO 8601 format, e.g. 2024-01-01
|
1489
|
+
# @return [String]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] end_date
|
1492
|
+
# Date in ISO 8601 format, e.g. 2024-01-01
|
1493
|
+
# @return [String]
|
1494
|
+
#
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/RestrictedPeriod AWS API Documentation
|
1496
|
+
#
|
1497
|
+
class RestrictedPeriod < Struct.new(
|
1498
|
+
:name,
|
1499
|
+
:start_date,
|
1500
|
+
:end_date)
|
1501
|
+
SENSITIVE = []
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# Restricted period config
|
1506
|
+
#
|
1507
|
+
# @note RestrictedPeriods is a union - when making an API calls you must set exactly one of the members.
|
1508
|
+
#
|
1509
|
+
# @note RestrictedPeriods is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RestrictedPeriods corresponding to the set member.
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] restricted_period_list
|
1512
|
+
# List of restricted period
|
1513
|
+
# @return [Array<Types::RestrictedPeriod>]
|
1514
|
+
#
|
1515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/RestrictedPeriods AWS API Documentation
|
1516
|
+
#
|
1517
|
+
class RestrictedPeriods < Struct.new(
|
1518
|
+
:restricted_period_list,
|
1519
|
+
:unknown)
|
1520
|
+
SENSITIVE = []
|
1521
|
+
include Aws::Structure
|
1522
|
+
include Aws::Structure::Union
|
1523
|
+
|
1524
|
+
class RestrictedPeriodList < RestrictedPeriods; end
|
1525
|
+
class Unknown < RestrictedPeriods; end
|
1526
|
+
end
|
1527
|
+
|
1528
|
+
# The request for ResumeCampaign API.
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] id
|
1531
|
+
# Identifier representing a Campaign
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ResumeCampaignRequest AWS API Documentation
|
1535
|
+
#
|
1536
|
+
class ResumeCampaignRequest < Struct.new(
|
1537
|
+
:id)
|
1538
|
+
SENSITIVE = []
|
1539
|
+
include Aws::Structure
|
1540
|
+
end
|
1541
|
+
|
1542
|
+
# Campaign schedule
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] start_time
|
1545
|
+
# Timestamp with no UTC offset or timezone
|
1546
|
+
# @return [Time]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] end_time
|
1549
|
+
# Timestamp with no UTC offset or timezone
|
1550
|
+
# @return [Time]
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] refresh_frequency
|
1553
|
+
# Time duration in ISO 8601 format
|
1554
|
+
# @return [String]
|
1555
|
+
#
|
1556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/Schedule AWS API Documentation
|
1557
|
+
#
|
1558
|
+
class Schedule < Struct.new(
|
1559
|
+
:start_time,
|
1560
|
+
:end_time,
|
1561
|
+
:refresh_frequency)
|
1562
|
+
SENSITIVE = []
|
1563
|
+
include Aws::Structure
|
1564
|
+
end
|
1565
|
+
|
1566
|
+
# Request would cause a service quota to be exceeded.
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] message
|
1569
|
+
# @return [String]
|
1570
|
+
#
|
1571
|
+
# @!attribute [rw] x_amz_error_type
|
1572
|
+
# A header that defines the error encountered while processing the
|
1573
|
+
# request.
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ServiceQuotaExceededException AWS API Documentation
|
1577
|
+
#
|
1578
|
+
class ServiceQuotaExceededException < Struct.new(
|
1579
|
+
:message,
|
1580
|
+
:x_amz_error_type)
|
1581
|
+
SENSITIVE = []
|
1582
|
+
include Aws::Structure
|
1583
|
+
end
|
1584
|
+
|
1585
|
+
# SMS Channel Subtype config
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] capacity
|
1588
|
+
# Allocates outbound capacity for the specific channel subtype of this
|
1589
|
+
# campaign between multiple active campaigns
|
1590
|
+
# @return [Float]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] outbound_mode
|
1593
|
+
# SMS Outbound Mode
|
1594
|
+
# @return [Types::SmsOutboundMode]
|
1595
|
+
#
|
1596
|
+
# @!attribute [rw] default_outbound_config
|
1597
|
+
# Default SMS Outbound config
|
1598
|
+
# @return [Types::SmsOutboundConfig]
|
1599
|
+
#
|
1600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SmsChannelSubtypeConfig AWS API Documentation
|
1601
|
+
#
|
1602
|
+
class SmsChannelSubtypeConfig < Struct.new(
|
1603
|
+
:capacity,
|
1604
|
+
:outbound_mode,
|
1605
|
+
:default_outbound_config)
|
1606
|
+
SENSITIVE = []
|
1607
|
+
include Aws::Structure
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
# Parameters for the SMS Channel Subtype
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] destination_phone_number
|
1613
|
+
# The phone number of the customer, in E.164 format.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] connect_source_phone_number_arn
|
1617
|
+
# Amazon Resource Names(ARN)
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] template_arn
|
1621
|
+
# Amazon Resource Names(ARN)
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] template_parameters
|
1625
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1626
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
1627
|
+
# flows just like any other contact attributes.
|
1628
|
+
# @return [Hash<String,String>]
|
1629
|
+
#
|
1630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SmsChannelSubtypeParameters AWS API Documentation
|
1631
|
+
#
|
1632
|
+
class SmsChannelSubtypeParameters < Struct.new(
|
1633
|
+
:destination_phone_number,
|
1634
|
+
:connect_source_phone_number_arn,
|
1635
|
+
:template_arn,
|
1636
|
+
:template_parameters)
|
1637
|
+
SENSITIVE = [:destination_phone_number, :template_parameters]
|
1638
|
+
include Aws::Structure
|
1639
|
+
end
|
1640
|
+
|
1641
|
+
# Default SMS Outbound config
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] connect_source_phone_number_arn
|
1644
|
+
# Amazon Resource Names(ARN)
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] wisdom_template_arn
|
1648
|
+
# Amazon Resource Names(ARN)
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SmsOutboundConfig AWS API Documentation
|
1652
|
+
#
|
1653
|
+
class SmsOutboundConfig < Struct.new(
|
1654
|
+
:connect_source_phone_number_arn,
|
1655
|
+
:wisdom_template_arn)
|
1656
|
+
SENSITIVE = []
|
1657
|
+
include Aws::Structure
|
1658
|
+
end
|
1659
|
+
|
1660
|
+
# SMS Outbound Mode
|
1661
|
+
#
|
1662
|
+
# @note SmsOutboundMode is a union - when making an API calls you must set exactly one of the members.
|
1663
|
+
#
|
1664
|
+
# @note SmsOutboundMode is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SmsOutboundMode corresponding to the set member.
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] agentless
|
1667
|
+
# Agentless config
|
1668
|
+
# @return [Types::AgentlessConfig]
|
1669
|
+
#
|
1670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SmsOutboundMode AWS API Documentation
|
1671
|
+
#
|
1672
|
+
class SmsOutboundMode < Struct.new(
|
1673
|
+
:agentless,
|
1674
|
+
:unknown)
|
1675
|
+
SENSITIVE = []
|
1676
|
+
include Aws::Structure
|
1677
|
+
include Aws::Structure::Union
|
1678
|
+
|
1679
|
+
class Agentless < SmsOutboundMode; end
|
1680
|
+
class Unknown < SmsOutboundMode; end
|
1681
|
+
end
|
1682
|
+
|
1683
|
+
# Source of the campaign
|
1684
|
+
#
|
1685
|
+
# @note Source is a union - when making an API calls you must set exactly one of the members.
|
1686
|
+
#
|
1687
|
+
# @note Source is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Source corresponding to the set member.
|
1688
|
+
#
|
1689
|
+
# @!attribute [rw] customer_profiles_segment_arn
|
1690
|
+
# Amazon Resource Names(ARN)
|
1691
|
+
# @return [String]
|
1692
|
+
#
|
1693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/Source AWS API Documentation
|
1694
|
+
#
|
1695
|
+
class Source < Struct.new(
|
1696
|
+
:customer_profiles_segment_arn,
|
1697
|
+
:unknown)
|
1698
|
+
SENSITIVE = []
|
1699
|
+
include Aws::Structure
|
1700
|
+
include Aws::Structure::Union
|
1701
|
+
|
1702
|
+
class CustomerProfilesSegmentArn < Source; end
|
1703
|
+
class Unknown < Source; end
|
1704
|
+
end
|
1705
|
+
|
1706
|
+
# The request for StartCampaign API.
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] id
|
1709
|
+
# Identifier representing a Campaign
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StartCampaignRequest AWS API Documentation
|
1713
|
+
#
|
1714
|
+
class StartCampaignRequest < Struct.new(
|
1715
|
+
:id)
|
1716
|
+
SENSITIVE = []
|
1717
|
+
include Aws::Structure
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# The request for StartInstanceOnboardingJob API.
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] connect_instance_id
|
1723
|
+
# Amazon Connect Instance Id
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] encryption_config
|
1727
|
+
# Encryption config for Connect Instance. Note that sensitive data
|
1728
|
+
# will always be encrypted. If disabled, service will perform
|
1729
|
+
# encryption with its own key. If enabled, a KMS key id needs to be
|
1730
|
+
# provided and KMS charges will apply. KMS is only type supported
|
1731
|
+
# @return [Types::EncryptionConfig]
|
1732
|
+
#
|
1733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJobRequest AWS API Documentation
|
1734
|
+
#
|
1735
|
+
class StartInstanceOnboardingJobRequest < Struct.new(
|
1736
|
+
:connect_instance_id,
|
1737
|
+
:encryption_config)
|
1738
|
+
SENSITIVE = []
|
1739
|
+
include Aws::Structure
|
1740
|
+
end
|
1741
|
+
|
1742
|
+
# The response for StartInstanceOnboardingJob API.
|
1743
|
+
#
|
1744
|
+
# @!attribute [rw] connect_instance_onboarding_job_status
|
1745
|
+
# Instance onboarding job status object
|
1746
|
+
# @return [Types::InstanceOnboardingJobStatus]
|
1747
|
+
#
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJobResponse AWS API Documentation
|
1749
|
+
#
|
1750
|
+
class StartInstanceOnboardingJobResponse < Struct.new(
|
1751
|
+
:connect_instance_onboarding_job_status)
|
1752
|
+
SENSITIVE = []
|
1753
|
+
include Aws::Structure
|
1754
|
+
end
|
1755
|
+
|
1756
|
+
# The request for StopCampaign API.
|
1757
|
+
#
|
1758
|
+
# @!attribute [rw] id
|
1759
|
+
# Identifier representing a Campaign
|
1760
|
+
# @return [String]
|
1761
|
+
#
|
1762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/StopCampaignRequest AWS API Documentation
|
1763
|
+
#
|
1764
|
+
class StopCampaignRequest < Struct.new(
|
1765
|
+
:id)
|
1766
|
+
SENSITIVE = []
|
1767
|
+
include Aws::Structure
|
1768
|
+
end
|
1769
|
+
|
1770
|
+
# Successful response of campaign state
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] campaign_id
|
1773
|
+
# Identifier representing a Campaign
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] state
|
1777
|
+
# State of a campaign
|
1778
|
+
# @return [String]
|
1779
|
+
#
|
1780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SuccessfulCampaignStateResponse AWS API Documentation
|
1781
|
+
#
|
1782
|
+
class SuccessfulCampaignStateResponse < Struct.new(
|
1783
|
+
:campaign_id,
|
1784
|
+
:state)
|
1785
|
+
SENSITIVE = []
|
1786
|
+
include Aws::Structure
|
1787
|
+
end
|
1788
|
+
|
1789
|
+
# A successful request identified by the unique client token.
|
1790
|
+
#
|
1791
|
+
# @!attribute [rw] client_token
|
1792
|
+
# Client provided parameter used for idempotency. Its value must be
|
1793
|
+
# unique for each request.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] id
|
1797
|
+
# Identifier representing a Dial request
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SuccessfulRequest AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class SuccessfulRequest < Struct.new(
|
1803
|
+
:client_token,
|
1804
|
+
:id)
|
1805
|
+
SENSITIVE = []
|
1806
|
+
include Aws::Structure
|
1807
|
+
end
|
1808
|
+
|
1809
|
+
# The request for TagResource API.
|
1810
|
+
#
|
1811
|
+
# @!attribute [rw] arn
|
1812
|
+
# Amazon Resource Names(ARN)
|
1813
|
+
# @return [String]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] tags
|
1816
|
+
# Tag map with key and value.
|
1817
|
+
# @return [Hash<String,String>]
|
1818
|
+
#
|
1819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TagResourceRequest AWS API Documentation
|
1820
|
+
#
|
1821
|
+
class TagResourceRequest < Struct.new(
|
1822
|
+
:arn,
|
1823
|
+
:tags)
|
1824
|
+
SENSITIVE = []
|
1825
|
+
include Aws::Structure
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# Telephony Channel Subtype config
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] capacity
|
1831
|
+
# Allocates outbound capacity for the specific channel subtype of this
|
1832
|
+
# campaign between multiple active campaigns
|
1833
|
+
# @return [Float]
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] connect_queue_id
|
1836
|
+
# The queue for the call. If you specify a queue, the phone displayed
|
1837
|
+
# for caller ID is the phone number specified in the queue. If you do
|
1838
|
+
# not specify a queue, the queue defined in the contact flow is used.
|
1839
|
+
# If you do not specify a queue, you must specify a source phone
|
1840
|
+
# number.
|
1841
|
+
# @return [String]
|
1842
|
+
#
|
1843
|
+
# @!attribute [rw] outbound_mode
|
1844
|
+
# Telephony Outbound Mode
|
1845
|
+
# @return [Types::TelephonyOutboundMode]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] default_outbound_config
|
1848
|
+
# Default Telephony Outbound config
|
1849
|
+
# @return [Types::TelephonyOutboundConfig]
|
1850
|
+
#
|
1851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TelephonyChannelSubtypeConfig AWS API Documentation
|
1852
|
+
#
|
1853
|
+
class TelephonyChannelSubtypeConfig < Struct.new(
|
1854
|
+
:capacity,
|
1855
|
+
:connect_queue_id,
|
1856
|
+
:outbound_mode,
|
1857
|
+
:default_outbound_config)
|
1858
|
+
SENSITIVE = []
|
1859
|
+
include Aws::Structure
|
1860
|
+
end
|
1861
|
+
|
1862
|
+
# Parameters for the Telephony Channel Subtype
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] destination_phone_number
|
1865
|
+
# The phone number of the customer, in E.164 format.
|
1866
|
+
# @return [String]
|
1867
|
+
#
|
1868
|
+
# @!attribute [rw] attributes
|
1869
|
+
# A custom key-value pair using an attribute map. The attributes are
|
1870
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
1871
|
+
# flows just like any other contact attributes.
|
1872
|
+
# @return [Hash<String,String>]
|
1873
|
+
#
|
1874
|
+
# @!attribute [rw] connect_source_phone_number
|
1875
|
+
# The phone number associated with the Amazon Connect instance, in
|
1876
|
+
# E.164 format. If you do not specify a source phone number, you must
|
1877
|
+
# specify a queue.
|
1878
|
+
# @return [String]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] answer_machine_detection_config
|
1881
|
+
# Answering Machine Detection config
|
1882
|
+
# @return [Types::AnswerMachineDetectionConfig]
|
1883
|
+
#
|
1884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TelephonyChannelSubtypeParameters AWS API Documentation
|
1885
|
+
#
|
1886
|
+
class TelephonyChannelSubtypeParameters < Struct.new(
|
1887
|
+
:destination_phone_number,
|
1888
|
+
:attributes,
|
1889
|
+
:connect_source_phone_number,
|
1890
|
+
:answer_machine_detection_config)
|
1891
|
+
SENSITIVE = [:destination_phone_number, :attributes]
|
1892
|
+
include Aws::Structure
|
1893
|
+
end
|
1894
|
+
|
1895
|
+
# Default Telephony Outbound config
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] connect_contact_flow_id
|
1898
|
+
# The identifier of the contact flow for the outbound call.
|
1899
|
+
# @return [String]
|
1900
|
+
#
|
1901
|
+
# @!attribute [rw] connect_source_phone_number
|
1902
|
+
# The phone number associated with the Amazon Connect instance, in
|
1903
|
+
# E.164 format. If you do not specify a source phone number, you must
|
1904
|
+
# specify a queue.
|
1905
|
+
# @return [String]
|
1906
|
+
#
|
1907
|
+
# @!attribute [rw] answer_machine_detection_config
|
1908
|
+
# Answering Machine Detection config
|
1909
|
+
# @return [Types::AnswerMachineDetectionConfig]
|
1910
|
+
#
|
1911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TelephonyOutboundConfig AWS API Documentation
|
1912
|
+
#
|
1913
|
+
class TelephonyOutboundConfig < Struct.new(
|
1914
|
+
:connect_contact_flow_id,
|
1915
|
+
:connect_source_phone_number,
|
1916
|
+
:answer_machine_detection_config)
|
1917
|
+
SENSITIVE = []
|
1918
|
+
include Aws::Structure
|
1919
|
+
end
|
1920
|
+
|
1921
|
+
# Telephony Outbound Mode
|
1922
|
+
#
|
1923
|
+
# @note TelephonyOutboundMode is a union - when making an API calls you must set exactly one of the members.
|
1924
|
+
#
|
1925
|
+
# @note TelephonyOutboundMode is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TelephonyOutboundMode corresponding to the set member.
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] progressive
|
1928
|
+
# Progressive config
|
1929
|
+
# @return [Types::ProgressiveConfig]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] predictive
|
1932
|
+
# Predictive config
|
1933
|
+
# @return [Types::PredictiveConfig]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] agentless
|
1936
|
+
# Agentless config
|
1937
|
+
# @return [Types::AgentlessConfig]
|
1938
|
+
#
|
1939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TelephonyOutboundMode AWS API Documentation
|
1940
|
+
#
|
1941
|
+
class TelephonyOutboundMode < Struct.new(
|
1942
|
+
:progressive,
|
1943
|
+
:predictive,
|
1944
|
+
:agentless,
|
1945
|
+
:unknown)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
include Aws::Structure::Union
|
1949
|
+
|
1950
|
+
class Progressive < TelephonyOutboundMode; end
|
1951
|
+
class Predictive < TelephonyOutboundMode; end
|
1952
|
+
class Agentless < TelephonyOutboundMode; end
|
1953
|
+
class Unknown < TelephonyOutboundMode; end
|
1954
|
+
end
|
1955
|
+
|
1956
|
+
# The request was denied due to request throttling.
|
1957
|
+
#
|
1958
|
+
# @!attribute [rw] message
|
1959
|
+
# @return [String]
|
1960
|
+
#
|
1961
|
+
# @!attribute [rw] x_amz_error_type
|
1962
|
+
# A header that defines the error encountered while processing the
|
1963
|
+
# request.
|
1964
|
+
# @return [String]
|
1965
|
+
#
|
1966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ThrottlingException AWS API Documentation
|
1967
|
+
#
|
1968
|
+
class ThrottlingException < Struct.new(
|
1969
|
+
:message,
|
1970
|
+
:x_amz_error_type)
|
1971
|
+
SENSITIVE = []
|
1972
|
+
include Aws::Structure
|
1973
|
+
end
|
1974
|
+
|
1975
|
+
# Time range in 24 hour format
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] start_time
|
1978
|
+
# Time in ISO 8601 format, e.g. T23:11
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] end_time
|
1982
|
+
# Time in ISO 8601 format, e.g. T23:11
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TimeRange AWS API Documentation
|
1986
|
+
#
|
1987
|
+
class TimeRange < Struct.new(
|
1988
|
+
:start_time,
|
1989
|
+
:end_time)
|
1990
|
+
SENSITIVE = []
|
1991
|
+
include Aws::Structure
|
1992
|
+
end
|
1993
|
+
|
1994
|
+
# Time window config
|
1995
|
+
#
|
1996
|
+
# @!attribute [rw] open_hours
|
1997
|
+
# Open Hours config
|
1998
|
+
# @return [Types::OpenHours]
|
1999
|
+
#
|
2000
|
+
# @!attribute [rw] restricted_periods
|
2001
|
+
# Restricted period config
|
2002
|
+
# @return [Types::RestrictedPeriods]
|
2003
|
+
#
|
2004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/TimeWindow AWS API Documentation
|
2005
|
+
#
|
2006
|
+
class TimeWindow < Struct.new(
|
2007
|
+
:open_hours,
|
2008
|
+
:restricted_periods)
|
2009
|
+
SENSITIVE = []
|
2010
|
+
include Aws::Structure
|
2011
|
+
end
|
2012
|
+
|
2013
|
+
# The request for UntagResource API.
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] arn
|
2016
|
+
# Amazon Resource Names(ARN)
|
2017
|
+
# @return [String]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] tag_keys
|
2020
|
+
# List of tag keys.
|
2021
|
+
# @return [Array<String>]
|
2022
|
+
#
|
2023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UntagResourceRequest AWS API Documentation
|
2024
|
+
#
|
2025
|
+
class UntagResourceRequest < Struct.new(
|
2026
|
+
:arn,
|
2027
|
+
:tag_keys)
|
2028
|
+
SENSITIVE = []
|
2029
|
+
include Aws::Structure
|
2030
|
+
end
|
2031
|
+
|
2032
|
+
# The request for UpdateCampaignChannelSubtypeConfig API.
|
2033
|
+
#
|
2034
|
+
# @!attribute [rw] id
|
2035
|
+
# Identifier representing a Campaign
|
2036
|
+
# @return [String]
|
2037
|
+
#
|
2038
|
+
# @!attribute [rw] channel_subtype_config
|
2039
|
+
# Campaign Channel Subtype config
|
2040
|
+
# @return [Types::ChannelSubtypeConfig]
|
2041
|
+
#
|
2042
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfigRequest AWS API Documentation
|
2043
|
+
#
|
2044
|
+
class UpdateCampaignChannelSubtypeConfigRequest < Struct.new(
|
2045
|
+
:id,
|
2046
|
+
:channel_subtype_config)
|
2047
|
+
SENSITIVE = []
|
2048
|
+
include Aws::Structure
|
2049
|
+
end
|
2050
|
+
|
2051
|
+
# The request for UpdateCampaignCommunicationLimits API.
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] id
|
2054
|
+
# Identifier representing a Campaign
|
2055
|
+
# @return [String]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] communication_limits_override
|
2058
|
+
# Communication limits config
|
2059
|
+
# @return [Types::CommunicationLimitsConfig]
|
2060
|
+
#
|
2061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimitsRequest AWS API Documentation
|
2062
|
+
#
|
2063
|
+
class UpdateCampaignCommunicationLimitsRequest < Struct.new(
|
2064
|
+
:id,
|
2065
|
+
:communication_limits_override)
|
2066
|
+
SENSITIVE = []
|
2067
|
+
include Aws::Structure
|
2068
|
+
end
|
2069
|
+
|
2070
|
+
# The request for UpdateCampaignCommunicationTime API.
|
2071
|
+
#
|
2072
|
+
# @!attribute [rw] id
|
2073
|
+
# Identifier representing a Campaign
|
2074
|
+
# @return [String]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] communication_time_config
|
2077
|
+
# Campaign communication time config
|
2078
|
+
# @return [Types::CommunicationTimeConfig]
|
2079
|
+
#
|
2080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTimeRequest AWS API Documentation
|
2081
|
+
#
|
2082
|
+
class UpdateCampaignCommunicationTimeRequest < Struct.new(
|
2083
|
+
:id,
|
2084
|
+
:communication_time_config)
|
2085
|
+
SENSITIVE = []
|
2086
|
+
include Aws::Structure
|
2087
|
+
end
|
2088
|
+
|
2089
|
+
# The request for UpdateCampaignFlowAssociation API.
|
2090
|
+
#
|
2091
|
+
# @!attribute [rw] id
|
2092
|
+
# Identifier representing a Campaign
|
2093
|
+
# @return [String]
|
2094
|
+
#
|
2095
|
+
# @!attribute [rw] connect_campaign_flow_arn
|
2096
|
+
# Amazon Resource Names(ARN)
|
2097
|
+
# @return [String]
|
2098
|
+
#
|
2099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociationRequest AWS API Documentation
|
2100
|
+
#
|
2101
|
+
class UpdateCampaignFlowAssociationRequest < Struct.new(
|
2102
|
+
:id,
|
2103
|
+
:connect_campaign_flow_arn)
|
2104
|
+
SENSITIVE = []
|
2105
|
+
include Aws::Structure
|
2106
|
+
end
|
2107
|
+
|
2108
|
+
# The request for UpdateCampaignName API.
|
2109
|
+
#
|
2110
|
+
# @!attribute [rw] id
|
2111
|
+
# Identifier representing a Campaign
|
2112
|
+
# @return [String]
|
2113
|
+
#
|
2114
|
+
# @!attribute [rw] name
|
2115
|
+
# The name of an Amazon Connect Campaign name.
|
2116
|
+
# @return [String]
|
2117
|
+
#
|
2118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignNameRequest AWS API Documentation
|
2119
|
+
#
|
2120
|
+
class UpdateCampaignNameRequest < Struct.new(
|
2121
|
+
:id,
|
2122
|
+
:name)
|
2123
|
+
SENSITIVE = []
|
2124
|
+
include Aws::Structure
|
2125
|
+
end
|
2126
|
+
|
2127
|
+
# The request for UpdateCampaignSchedule API.
|
2128
|
+
#
|
2129
|
+
# @!attribute [rw] id
|
2130
|
+
# Identifier representing a Campaign
|
2131
|
+
# @return [String]
|
2132
|
+
#
|
2133
|
+
# @!attribute [rw] schedule
|
2134
|
+
# Campaign schedule
|
2135
|
+
# @return [Types::Schedule]
|
2136
|
+
#
|
2137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignScheduleRequest AWS API Documentation
|
2138
|
+
#
|
2139
|
+
class UpdateCampaignScheduleRequest < Struct.new(
|
2140
|
+
:id,
|
2141
|
+
:schedule)
|
2142
|
+
SENSITIVE = []
|
2143
|
+
include Aws::Structure
|
2144
|
+
end
|
2145
|
+
|
2146
|
+
# The request for UpdateCampaignSource API.
|
2147
|
+
#
|
2148
|
+
# @!attribute [rw] id
|
2149
|
+
# Identifier representing a Campaign
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
2152
|
+
# @!attribute [rw] source
|
2153
|
+
# Source of the campaign
|
2154
|
+
# @return [Types::Source]
|
2155
|
+
#
|
2156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/UpdateCampaignSourceRequest AWS API Documentation
|
2157
|
+
#
|
2158
|
+
class UpdateCampaignSourceRequest < Struct.new(
|
2159
|
+
:id,
|
2160
|
+
:source)
|
2161
|
+
SENSITIVE = []
|
2162
|
+
include Aws::Structure
|
2163
|
+
end
|
2164
|
+
|
2165
|
+
# The input fails to satisfy the constraints specified by an AWS
|
2166
|
+
# service.
|
2167
|
+
#
|
2168
|
+
# @!attribute [rw] message
|
2169
|
+
# @return [String]
|
2170
|
+
#
|
2171
|
+
# @!attribute [rw] x_amz_error_type
|
2172
|
+
# A header that defines the error encountered while processing the
|
2173
|
+
# request.
|
2174
|
+
# @return [String]
|
2175
|
+
#
|
2176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ValidationException AWS API Documentation
|
2177
|
+
#
|
2178
|
+
class ValidationException < Struct.new(
|
2179
|
+
:message,
|
2180
|
+
:x_amz_error_type)
|
2181
|
+
SENSITIVE = []
|
2182
|
+
include Aws::Structure
|
2183
|
+
end
|
2184
|
+
|
2185
|
+
end
|
2186
|
+
end
|
2187
|
+
|