aws-sdk-endusermessaging 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,2249 @@
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::EndUserMessaging
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
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # Specifies an attribute to create for a brand profile.
27
+ #
28
+ # @!attribute [rw] attribute_name
29
+ # The name of the brand profile attribute. The name is unique within a
30
+ # brand profile.
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] attribute_type
34
+ # The type of the attribute. TEXT stores an inline value. IMAGE and
35
+ # DOCUMENT store binary media that you upload.
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] attribute_value
39
+ # The text value for the attribute. This value applies to attributes
40
+ # of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the
41
+ # media through the attachment body instead.
42
+ # @return [String]
43
+ #
44
+ # @!attribute [rw] attachment_body
45
+ # The binary content for an attribute of type IMAGE or DOCUMENT. The
46
+ # content is base64-encoded when it is sent over the wire.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] description
50
+ # A description of the attribute.
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] category
54
+ # The category of the attribute.
55
+ # @return [String]
56
+ #
57
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/BrandProfileAttributeInput AWS API Documentation
58
+ #
59
+ class BrandProfileAttributeInput < Struct.new(
60
+ :attribute_name,
61
+ :attribute_type,
62
+ :attribute_value,
63
+ :attachment_body,
64
+ :description,
65
+ :category)
66
+ SENSITIVE = [:attribute_name, :attribute_value, :attachment_body, :description]
67
+ include Aws::Structure
68
+ end
69
+
70
+ # Contains information about an attribute that was created for a brand
71
+ # profile.
72
+ #
73
+ # @!attribute [rw] attribute_name
74
+ # The name of the brand profile attribute. The name is unique within a
75
+ # brand profile.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] attribute_type
79
+ # The type of the attribute. TEXT stores an inline value. IMAGE and
80
+ # DOCUMENT store binary media that you upload.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] media_download_url
84
+ # A presigned Amazon S3 URL that you can use to download the attribute
85
+ # media. The URL is valid for one hour and is present only for
86
+ # attributes of type IMAGE or DOCUMENT.
87
+ # @return [String]
88
+ #
89
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/BrandProfileAttributeOutput AWS API Documentation
90
+ #
91
+ class BrandProfileAttributeOutput < Struct.new(
92
+ :attribute_name,
93
+ :attribute_type,
94
+ :media_download_url)
95
+ SENSITIVE = [:attribute_name, :media_download_url]
96
+ include Aws::Structure
97
+ end
98
+
99
+ # Contains summary information about a brand profile attribute in a list
100
+ # response.
101
+ #
102
+ # @!attribute [rw] attribute_name
103
+ # The name of the brand profile attribute. The name is unique within a
104
+ # brand profile.
105
+ # @return [String]
106
+ #
107
+ # @!attribute [rw] attribute_type
108
+ # The type of the attribute. TEXT stores an inline value. IMAGE and
109
+ # DOCUMENT store binary media that you upload.
110
+ # @return [String]
111
+ #
112
+ # @!attribute [rw] description
113
+ # A description of the attribute.
114
+ # @return [String]
115
+ #
116
+ # @!attribute [rw] category
117
+ # The category of the attribute.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] created_at
121
+ # The time when the resource was created, in Unix epoch time.
122
+ # @return [Time]
123
+ #
124
+ # @!attribute [rw] updated_at
125
+ # The time when the resource was last updated, in Unix epoch time.
126
+ # @return [Time]
127
+ #
128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/BrandProfileAttributeSummary AWS API Documentation
129
+ #
130
+ class BrandProfileAttributeSummary < Struct.new(
131
+ :attribute_name,
132
+ :attribute_type,
133
+ :description,
134
+ :category,
135
+ :created_at,
136
+ :updated_at)
137
+ SENSITIVE = [:attribute_name, :description]
138
+ include Aws::Structure
139
+ end
140
+
141
+ # Contains information about a brand profile.
142
+ #
143
+ # @!attribute [rw] brand_profile_id
144
+ # The unique identifier of the brand profile.
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] brand_profile_arn
148
+ # The Amazon Resource Name (ARN) of the brand profile.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] brand_profile_name
152
+ # The name of the brand profile. The name can contain alphanumeric
153
+ # characters, underscores, hyphens, and spaces.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] status
157
+ # The current lifecycle status of the brand profile.
158
+ # @return [String]
159
+ #
160
+ # @!attribute [rw] deletion_protection_enabled
161
+ # Specifies whether deletion protection is enabled. When enabled, the
162
+ # resource cannot be deleted until deletion protection is turned off.
163
+ # @return [Boolean]
164
+ #
165
+ # @!attribute [rw] created_at
166
+ # The time when the resource was created, in Unix epoch time.
167
+ # @return [Time]
168
+ #
169
+ # @!attribute [rw] updated_at
170
+ # The time when the resource was last updated, in Unix epoch time.
171
+ # @return [Time]
172
+ #
173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/BrandProfileInfo AWS API Documentation
174
+ #
175
+ class BrandProfileInfo < Struct.new(
176
+ :brand_profile_id,
177
+ :brand_profile_arn,
178
+ :brand_profile_name,
179
+ :status,
180
+ :deletion_protection_enabled,
181
+ :created_at,
182
+ :updated_at)
183
+ SENSITIVE = []
184
+ include Aws::Structure
185
+ end
186
+
187
+ # The channel-specific parameters used to render and deliver a one-time
188
+ # passcode. Each member configures the parameters for one delivery
189
+ # route. Populate only the channels that a configuration or send request
190
+ # supports. A notify code configuration can carry every channel at once,
191
+ # and a send request resolves to a single route that selects the
192
+ # matching channel at send time.
193
+ #
194
+ # @!attribute [rw] text
195
+ # The parameters for the text channel, which delivers over SMS or RCS.
196
+ # @return [Types::TextParameters]
197
+ #
198
+ # @!attribute [rw] voice
199
+ # The parameters for the voice channel.
200
+ # @return [Types::VoiceParameters]
201
+ #
202
+ # @!attribute [rw] notify
203
+ # The parameters for the preapproved notify-template route over the
204
+ # SMS or voice channels.
205
+ # @return [Types::NotifyParameters]
206
+ #
207
+ # @!attribute [rw] whats_app
208
+ # The parameters for the WhatsApp channel.
209
+ # @return [Types::WhatsAppParameters]
210
+ #
211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ChannelParameters AWS API Documentation
212
+ #
213
+ class ChannelParameters < Struct.new(
214
+ :text,
215
+ :voice,
216
+ :notify,
217
+ :whats_app)
218
+ SENSITIVE = []
219
+ include Aws::Structure
220
+ end
221
+
222
+ # The passcode policy parameters that are grouped for reuse across a
223
+ # notify code configuration and its create request. Each member is
224
+ # optional. When you omit a member on a create request, no value is
225
+ # applied at create time and the default is applied when a passcode is
226
+ # sent.
227
+ #
228
+ # @!attribute [rw] code_type
229
+ # The character set used to generate the one-time passcode. Valid
230
+ # values are NUMERIC (digits only), ALPHA (uppercase letters only),
231
+ # and ALPHANUMERIC (uppercase letters and digits). When you do not
232
+ # specify a value, the default is applied when a passcode is sent.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] code_length
236
+ # The number of characters in the one-time passcode. Valid values
237
+ # range from 4 through 8. When you do not specify a value, the default
238
+ # is applied when a passcode is sent.
239
+ # @return [Integer]
240
+ #
241
+ # @!attribute [rw] validity_period_minutes
242
+ # The length of time, in minutes, that the one-time passcode remains
243
+ # valid. Valid values range from 1 through 60. When you do not specify
244
+ # a value, the default is applied when a passcode is sent.
245
+ # @return [Integer]
246
+ #
247
+ # @!attribute [rw] max_attempts
248
+ # The maximum number of validation attempts that are allowed before
249
+ # the verification is locked. Valid values range from 1 through 5.
250
+ # When you do not specify a value, the default is applied when a
251
+ # passcode is sent.
252
+ # @return [Integer]
253
+ #
254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CodeConfigurationParameters AWS API Documentation
255
+ #
256
+ class CodeConfigurationParameters < Struct.new(
257
+ :code_type,
258
+ :code_length,
259
+ :validity_period_minutes,
260
+ :max_attempts)
261
+ SENSITIVE = []
262
+ include Aws::Structure
263
+ end
264
+
265
+ # The request conflicts with the current state of the resource.
266
+ #
267
+ # @!attribute [rw] message
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] resource_id
271
+ # The identifier of the resource that the request conflicts with.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] resource_type
275
+ # The type of the resource that the request conflicts with.
276
+ # @return [String]
277
+ #
278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ConflictException AWS API Documentation
279
+ #
280
+ class ConflictException < Struct.new(
281
+ :message,
282
+ :resource_id,
283
+ :resource_type)
284
+ SENSITIVE = []
285
+ include Aws::Structure
286
+ end
287
+
288
+ # @!attribute [rw] brand_profile_id
289
+ # The unique identifier of the brand profile. You can specify either
290
+ # the bare ID or the full Amazon Resource Name (ARN).
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] attributes
294
+ # The brand profile attributes.
295
+ # @return [Array<Types::BrandProfileAttributeInput>]
296
+ #
297
+ # @!attribute [rw] client_token
298
+ # A unique, case-sensitive identifier that you provide to ensure the
299
+ # idempotency of the request. If you do not specify a client token,
300
+ # the AWS SDK automatically generates one.
301
+ #
302
+ # **A suitable default value is auto-generated.** You should normally
303
+ # not need to pass this option.
304
+ # @return [String]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileAttributesInput AWS API Documentation
307
+ #
308
+ class CreateBrandProfileAttributesInput < Struct.new(
309
+ :brand_profile_id,
310
+ :attributes,
311
+ :client_token)
312
+ SENSITIVE = [:client_token]
313
+ include Aws::Structure
314
+ end
315
+
316
+ # @!attribute [rw] attributes
317
+ # The brand profile attributes.
318
+ # @return [Array<Types::BrandProfileAttributeOutput>]
319
+ #
320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileAttributesOutput AWS API Documentation
321
+ #
322
+ class CreateBrandProfileAttributesOutput < Struct.new(
323
+ :attributes)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
328
+ # @!attribute [rw] registration_id
329
+ # The identifier or Amazon Resource Name (ARN) of the registration to
330
+ # populate the brand profile from.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] brand_profile_name
334
+ # The name of the brand profile. The name can contain alphanumeric
335
+ # characters, underscores, hyphens, and spaces.
336
+ # @return [String]
337
+ #
338
+ # @!attribute [rw] smart_match
339
+ # Specifies whether to use semantic field mapping between brand
340
+ # profile attributes and registration fields. The default is true.
341
+ # When false, the service maps fields using a fixed set of standard
342
+ # field types.
343
+ # @return [Boolean]
344
+ #
345
+ # @!attribute [rw] tags
346
+ # An array of key and value pair tags that are associated with the
347
+ # resource.
348
+ # @return [Array<Types::Tag>]
349
+ #
350
+ # @!attribute [rw] client_token
351
+ # A unique, case-sensitive identifier that you provide to ensure the
352
+ # idempotency of the request. If you do not specify a client token,
353
+ # the AWS SDK automatically generates one.
354
+ #
355
+ # **A suitable default value is auto-generated.** You should normally
356
+ # not need to pass this option.
357
+ # @return [String]
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileFromRegistrationInput AWS API Documentation
360
+ #
361
+ class CreateBrandProfileFromRegistrationInput < Struct.new(
362
+ :registration_id,
363
+ :brand_profile_name,
364
+ :smart_match,
365
+ :tags,
366
+ :client_token)
367
+ SENSITIVE = [:client_token]
368
+ include Aws::Structure
369
+ end
370
+
371
+ # @!attribute [rw] results
372
+ # The results of the operation. Each result pairs a requested item
373
+ # with the asynchronous job that processes it.
374
+ # @return [Array<Types::JobResult>]
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileFromRegistrationOutput AWS API Documentation
377
+ #
378
+ class CreateBrandProfileFromRegistrationOutput < Struct.new(
379
+ :results)
380
+ SENSITIVE = []
381
+ include Aws::Structure
382
+ end
383
+
384
+ # @!attribute [rw] brand_profile_name
385
+ # The name of the brand profile. The name can contain alphanumeric
386
+ # characters, underscores, hyphens, and spaces.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] client_token
390
+ # A unique, case-sensitive identifier that you provide to ensure the
391
+ # idempotency of the request. If you do not specify a client token,
392
+ # the AWS SDK automatically generates one.
393
+ #
394
+ # **A suitable default value is auto-generated.** You should normally
395
+ # not need to pass this option.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] deletion_protection_enabled
399
+ # Specifies whether deletion protection is enabled. When enabled, the
400
+ # resource cannot be deleted until deletion protection is turned off.
401
+ # @return [Boolean]
402
+ #
403
+ # @!attribute [rw] tags
404
+ # An array of key and value pair tags that are associated with the
405
+ # resource.
406
+ # @return [Array<Types::Tag>]
407
+ #
408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileInput AWS API Documentation
409
+ #
410
+ class CreateBrandProfileInput < Struct.new(
411
+ :brand_profile_name,
412
+ :client_token,
413
+ :deletion_protection_enabled,
414
+ :tags)
415
+ SENSITIVE = [:client_token]
416
+ include Aws::Structure
417
+ end
418
+
419
+ # @!attribute [rw] brand_profile_id
420
+ # The unique identifier of the brand profile.
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] brand_profile_arn
424
+ # The Amazon Resource Name (ARN) of the brand profile.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] brand_profile_name
428
+ # The name of the brand profile. The name can contain alphanumeric
429
+ # characters, underscores, hyphens, and spaces.
430
+ # @return [String]
431
+ #
432
+ # @!attribute [rw] status
433
+ # The current lifecycle status of the brand profile.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] deletion_protection_enabled
437
+ # Specifies whether deletion protection is enabled. When enabled, the
438
+ # resource cannot be deleted until deletion protection is turned off.
439
+ # @return [Boolean]
440
+ #
441
+ # @!attribute [rw] created_at
442
+ # The time when the resource was created, in Unix epoch time.
443
+ # @return [Time]
444
+ #
445
+ # @!attribute [rw] updated_at
446
+ # The time when the resource was last updated, in Unix epoch time.
447
+ # @return [Time]
448
+ #
449
+ # @!attribute [rw] attributes_created
450
+ # The number of default attributes that were created for the brand
451
+ # profile.
452
+ # @return [Integer]
453
+ #
454
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateBrandProfileOutput AWS API Documentation
455
+ #
456
+ class CreateBrandProfileOutput < Struct.new(
457
+ :brand_profile_id,
458
+ :brand_profile_arn,
459
+ :brand_profile_name,
460
+ :status,
461
+ :deletion_protection_enabled,
462
+ :created_at,
463
+ :updated_at,
464
+ :attributes_created)
465
+ SENSITIVE = []
466
+ include Aws::Structure
467
+ end
468
+
469
+ # @!attribute [rw] notify_code_configuration_name
470
+ # The name of the notify code configuration.
471
+ # @return [String]
472
+ #
473
+ # @!attribute [rw] code_configuration_parameters
474
+ # The passcode policy parameters, including the code type, length,
475
+ # validity period, and maximum number of attempts. Each member is
476
+ # optional. When you omit a member, no value is applied at create time
477
+ # and the default is applied when a passcode is sent.
478
+ # @return [Types::CodeConfigurationParameters]
479
+ #
480
+ # @!attribute [rw] channel_parameters
481
+ # The channel-specific parameters used to render and deliver the
482
+ # one-time passcode. Provide parameters for any subset of channels.
483
+ # Each member configures one delivery route, and the route that is
484
+ # selected at send time uses the matching channel.
485
+ # @return [Types::ChannelParameters]
486
+ #
487
+ # @!attribute [rw] deletion_protection_enabled
488
+ # Specifies whether deletion protection is enabled. When enabled, the
489
+ # resource cannot be deleted until deletion protection is turned off.
490
+ # @return [Boolean]
491
+ #
492
+ # @!attribute [rw] client_token
493
+ # A unique, case-sensitive identifier that you provide to ensure the
494
+ # idempotency of the request. If you do not specify a client token,
495
+ # the AWS SDK automatically generates one.
496
+ #
497
+ # **A suitable default value is auto-generated.** You should normally
498
+ # not need to pass this option.
499
+ # @return [String]
500
+ #
501
+ # @!attribute [rw] tags
502
+ # An array of key and value pair tags that are associated with the
503
+ # resource.
504
+ # @return [Array<Types::Tag>]
505
+ #
506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateNotifyCodeConfigurationInput AWS API Documentation
507
+ #
508
+ class CreateNotifyCodeConfigurationInput < Struct.new(
509
+ :notify_code_configuration_name,
510
+ :code_configuration_parameters,
511
+ :channel_parameters,
512
+ :deletion_protection_enabled,
513
+ :client_token,
514
+ :tags)
515
+ SENSITIVE = [:client_token]
516
+ include Aws::Structure
517
+ end
518
+
519
+ # @!attribute [rw] notify_code_configuration
520
+ # The notify code configuration resource.
521
+ # @return [Types::NotifyCodeConfiguration]
522
+ #
523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateNotifyCodeConfigurationOutput AWS API Documentation
524
+ #
525
+ class CreateNotifyCodeConfigurationOutput < Struct.new(
526
+ :notify_code_configuration)
527
+ SENSITIVE = []
528
+ include Aws::Structure
529
+ end
530
+
531
+ # @!attribute [rw] brand_profile_id
532
+ # The unique identifier of the brand profile. You can specify either
533
+ # the bare ID or the full Amazon Resource Name (ARN).
534
+ # @return [String]
535
+ #
536
+ # @!attribute [rw] registration_types
537
+ # The registration types to create, for example
538
+ # US\_TOLL\_FREE\_REGISTRATION or SENDER\_ID.
539
+ # @return [Array<String>]
540
+ #
541
+ # @!attribute [rw] smart_match
542
+ # Specifies whether to use semantic field mapping between brand
543
+ # profile attributes and registration fields. The default is true.
544
+ # When false, the service maps fields using a fixed set of standard
545
+ # field types.
546
+ # @return [Boolean]
547
+ #
548
+ # @!attribute [rw] client_token
549
+ # A unique, case-sensitive identifier that you provide to ensure the
550
+ # idempotency of the request. If you do not specify a client token,
551
+ # the AWS SDK automatically generates one.
552
+ #
553
+ # **A suitable default value is auto-generated.** You should normally
554
+ # not need to pass this option.
555
+ # @return [String]
556
+ #
557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateRegistrationsFromBrandProfileInput AWS API Documentation
558
+ #
559
+ class CreateRegistrationsFromBrandProfileInput < Struct.new(
560
+ :brand_profile_id,
561
+ :registration_types,
562
+ :smart_match,
563
+ :client_token)
564
+ SENSITIVE = [:client_token]
565
+ include Aws::Structure
566
+ end
567
+
568
+ # @!attribute [rw] results
569
+ # The results of the operation. Each result pairs a requested item
570
+ # with the asynchronous job that processes it.
571
+ # @return [Array<Types::JobResult>]
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/CreateRegistrationsFromBrandProfileOutput AWS API Documentation
574
+ #
575
+ class CreateRegistrationsFromBrandProfileOutput < Struct.new(
576
+ :results)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # @!attribute [rw] brand_profile_id
582
+ # The unique identifier of the brand profile. You can specify either
583
+ # the bare ID or the full Amazon Resource Name (ARN).
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] attribute_name
587
+ # The name of the brand profile attribute. The name is unique within a
588
+ # brand profile.
589
+ # @return [String]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteBrandProfileAttributeInput AWS API Documentation
592
+ #
593
+ class DeleteBrandProfileAttributeInput < Struct.new(
594
+ :brand_profile_id,
595
+ :attribute_name)
596
+ SENSITIVE = [:attribute_name]
597
+ include Aws::Structure
598
+ end
599
+
600
+ # @!attribute [rw] brand_profile_id
601
+ # The unique identifier of the brand profile.
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] attribute_name
605
+ # The name of the brand profile attribute. The name is unique within a
606
+ # brand profile.
607
+ # @return [String]
608
+ #
609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteBrandProfileAttributeOutput AWS API Documentation
610
+ #
611
+ class DeleteBrandProfileAttributeOutput < Struct.new(
612
+ :brand_profile_id,
613
+ :attribute_name)
614
+ SENSITIVE = [:attribute_name]
615
+ include Aws::Structure
616
+ end
617
+
618
+ # @!attribute [rw] brand_profile_id
619
+ # The unique identifier of the brand profile. You can specify either
620
+ # the bare ID or the full Amazon Resource Name (ARN).
621
+ # @return [String]
622
+ #
623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteBrandProfileInput AWS API Documentation
624
+ #
625
+ class DeleteBrandProfileInput < Struct.new(
626
+ :brand_profile_id)
627
+ SENSITIVE = []
628
+ include Aws::Structure
629
+ end
630
+
631
+ # @!attribute [rw] brand_profile_id
632
+ # The unique identifier of the brand profile.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] brand_profile_arn
636
+ # The Amazon Resource Name (ARN) of the brand profile.
637
+ # @return [String]
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteBrandProfileOutput AWS API Documentation
640
+ #
641
+ class DeleteBrandProfileOutput < Struct.new(
642
+ :brand_profile_id,
643
+ :brand_profile_arn)
644
+ SENSITIVE = []
645
+ include Aws::Structure
646
+ end
647
+
648
+ # @!attribute [rw] notify_code_configuration_id
649
+ # The unique identifier of the notify code configuration. You can
650
+ # specify either the bare ID or the full Amazon Resource Name (ARN).
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteNotifyCodeConfigurationInput AWS API Documentation
654
+ #
655
+ class DeleteNotifyCodeConfigurationInput < Struct.new(
656
+ :notify_code_configuration_id)
657
+ SENSITIVE = []
658
+ include Aws::Structure
659
+ end
660
+
661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/DeleteNotifyCodeConfigurationOutput AWS API Documentation
662
+ #
663
+ class DeleteNotifyCodeConfigurationOutput < Aws::EmptyStructure; end
664
+
665
+ # @!attribute [rw] brand_profile_id
666
+ # The unique identifier of the brand profile. You can specify either
667
+ # the bare ID or the full Amazon Resource Name (ARN).
668
+ # @return [String]
669
+ #
670
+ # @!attribute [rw] attribute_name
671
+ # The name of the brand profile attribute. The name is unique within a
672
+ # brand profile.
673
+ # @return [String]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetBrandProfileAttributeInput AWS API Documentation
676
+ #
677
+ class GetBrandProfileAttributeInput < Struct.new(
678
+ :brand_profile_id,
679
+ :attribute_name)
680
+ SENSITIVE = [:attribute_name]
681
+ include Aws::Structure
682
+ end
683
+
684
+ # @!attribute [rw] attribute_name
685
+ # The name of the brand profile attribute. The name is unique within a
686
+ # brand profile.
687
+ # @return [String]
688
+ #
689
+ # @!attribute [rw] attribute_type
690
+ # The type of the attribute. TEXT stores an inline value. IMAGE and
691
+ # DOCUMENT store binary media that you upload.
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] attribute_value
695
+ # The text value of the attribute. This value applies to attributes of
696
+ # type TEXT.
697
+ # @return [String]
698
+ #
699
+ # @!attribute [rw] description
700
+ # A description of the attribute.
701
+ # @return [String]
702
+ #
703
+ # @!attribute [rw] category
704
+ # The category of the attribute.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] media_content_type
708
+ # The MIME content type of the attribute media.
709
+ # @return [String]
710
+ #
711
+ # @!attribute [rw] media_size_bytes
712
+ # The size of the attribute media, in bytes.
713
+ # @return [Integer]
714
+ #
715
+ # @!attribute [rw] media_download_url
716
+ # A presigned Amazon S3 URL that you can use to download the attribute
717
+ # media. The URL is valid for one hour and is present only for
718
+ # attributes of type IMAGE or DOCUMENT.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] created_at
722
+ # The time when the resource was created, in Unix epoch time.
723
+ # @return [Time]
724
+ #
725
+ # @!attribute [rw] updated_at
726
+ # The time when the resource was last updated, in Unix epoch time.
727
+ # @return [Time]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetBrandProfileAttributeOutput AWS API Documentation
730
+ #
731
+ class GetBrandProfileAttributeOutput < Struct.new(
732
+ :attribute_name,
733
+ :attribute_type,
734
+ :attribute_value,
735
+ :description,
736
+ :category,
737
+ :media_content_type,
738
+ :media_size_bytes,
739
+ :media_download_url,
740
+ :created_at,
741
+ :updated_at)
742
+ SENSITIVE = [:attribute_name, :attribute_value, :description, :media_download_url]
743
+ include Aws::Structure
744
+ end
745
+
746
+ # @!attribute [rw] brand_profile_id
747
+ # The unique identifier of the brand profile. You can specify either
748
+ # the bare ID or the full Amazon Resource Name (ARN).
749
+ # @return [String]
750
+ #
751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetBrandProfileInput AWS API Documentation
752
+ #
753
+ class GetBrandProfileInput < Struct.new(
754
+ :brand_profile_id)
755
+ SENSITIVE = []
756
+ include Aws::Structure
757
+ end
758
+
759
+ # @!attribute [rw] brand_profile_id
760
+ # The unique identifier of the brand profile.
761
+ # @return [String]
762
+ #
763
+ # @!attribute [rw] brand_profile_arn
764
+ # The Amazon Resource Name (ARN) of the brand profile.
765
+ # @return [String]
766
+ #
767
+ # @!attribute [rw] brand_profile_name
768
+ # The name of the brand profile. The name can contain alphanumeric
769
+ # characters, underscores, hyphens, and spaces.
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] status
773
+ # The current lifecycle status of the brand profile.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] deletion_protection_enabled
777
+ # Specifies whether deletion protection is enabled. When enabled, the
778
+ # resource cannot be deleted until deletion protection is turned off.
779
+ # @return [Boolean]
780
+ #
781
+ # @!attribute [rw] created_at
782
+ # The time when the resource was created, in Unix epoch time.
783
+ # @return [Time]
784
+ #
785
+ # @!attribute [rw] updated_at
786
+ # The time when the resource was last updated, in Unix epoch time.
787
+ # @return [Time]
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetBrandProfileOutput AWS API Documentation
790
+ #
791
+ class GetBrandProfileOutput < Struct.new(
792
+ :brand_profile_id,
793
+ :brand_profile_arn,
794
+ :brand_profile_name,
795
+ :status,
796
+ :deletion_protection_enabled,
797
+ :created_at,
798
+ :updated_at)
799
+ SENSITIVE = []
800
+ include Aws::Structure
801
+ end
802
+
803
+ # @!attribute [rw] job_id
804
+ # The unique identifier of the asynchronous job. Use the GetJob
805
+ # operation to check the status of the job and to retrieve its
806
+ # results.
807
+ # @return [String]
808
+ #
809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetJobInput AWS API Documentation
810
+ #
811
+ class GetJobInput < Struct.new(
812
+ :job_id)
813
+ SENSITIVE = []
814
+ include Aws::Structure
815
+ end
816
+
817
+ # @!attribute [rw] notify_code_configuration_id
818
+ # The unique identifier of the notify code configuration. You can
819
+ # specify either the bare ID or the full Amazon Resource Name (ARN).
820
+ # @return [String]
821
+ #
822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetNotifyCodeConfigurationInput AWS API Documentation
823
+ #
824
+ class GetNotifyCodeConfigurationInput < Struct.new(
825
+ :notify_code_configuration_id)
826
+ SENSITIVE = []
827
+ include Aws::Structure
828
+ end
829
+
830
+ # @!attribute [rw] notify_code_configuration
831
+ # The notify code configuration resource.
832
+ # @return [Types::NotifyCodeConfiguration]
833
+ #
834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/GetNotifyCodeConfigurationOutput AWS API Documentation
835
+ #
836
+ class GetNotifyCodeConfigurationOutput < Struct.new(
837
+ :notify_code_configuration)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # An unexpected error occurred during the processing of the request.
843
+ #
844
+ # @!attribute [rw] message
845
+ # @return [String]
846
+ #
847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/InternalServerException AWS API Documentation
848
+ #
849
+ class InternalServerException < Struct.new(
850
+ :message)
851
+ SENSITIVE = []
852
+ include Aws::Structure
853
+ end
854
+
855
+ # Information about an async job tracked by the service. GetJob returns
856
+ # the full `Job`, which may grow detail-only fields that are not part of
857
+ # the `JobSummary` list view.
858
+ #
859
+ # @!attribute [rw] job_id
860
+ # The unique identifier of the asynchronous job. Use the GetJob
861
+ # operation to check the status of the job and to retrieve its
862
+ # results.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] status
866
+ # The current lifecycle status of the job.
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] operation_type
870
+ # The type of mutating operation that created the job.
871
+ # @return [String]
872
+ #
873
+ # @!attribute [rw] created_at
874
+ # The time when the resource was created, in Unix epoch time.
875
+ # @return [Time]
876
+ #
877
+ # @!attribute [rw] updated_at
878
+ # The time when the resource was last updated, in Unix epoch time.
879
+ # @return [Time]
880
+ #
881
+ # @!attribute [rw] brand_profile_id
882
+ # The brand profile that the job operates on. This value is absent for
883
+ # operations that create a brand profile.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] error_code
887
+ # A machine-readable code that identifies why the job failed. This
888
+ # value is present only when the job status is FAILED.
889
+ # @return [String]
890
+ #
891
+ # @!attribute [rw] error_message
892
+ # A human-readable description of why the job failed. This value is
893
+ # present only when the job status is FAILED.
894
+ # @return [String]
895
+ #
896
+ # @!attribute [rw] resources
897
+ # The resources that were created or updated by the job.
898
+ # @return [Array<Types::JobResource>]
899
+ #
900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/Job AWS API Documentation
901
+ #
902
+ class Job < Struct.new(
903
+ :job_id,
904
+ :status,
905
+ :operation_type,
906
+ :created_at,
907
+ :updated_at,
908
+ :brand_profile_id,
909
+ :error_code,
910
+ :error_message,
911
+ :resources)
912
+ SENSITIVE = []
913
+ include Aws::Structure
914
+ end
915
+
916
+ # Contains information about a resource that was created or updated by
917
+ # an asynchronous job.
918
+ #
919
+ # @!attribute [rw] resource_type
920
+ # The type of the resource that the job created or updated.
921
+ # @return [String]
922
+ #
923
+ # @!attribute [rw] resource_id
924
+ # The identifier of the resource that the job created or updated.
925
+ # @return [String]
926
+ #
927
+ # @!attribute [rw] resource_arn
928
+ # The Amazon Resource Name (ARN) of the resource.
929
+ # @return [String]
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/JobResource AWS API Documentation
932
+ #
933
+ class JobResource < Struct.new(
934
+ :resource_type,
935
+ :resource_id,
936
+ :resource_arn)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
941
+ # Pairs an asynchronous job with the resource identifier from your
942
+ # request that the job processes.
943
+ #
944
+ # @!attribute [rw] job_id
945
+ # The unique identifier of the asynchronous job. Use the GetJob
946
+ # operation to check the status of the job and to retrieve its
947
+ # results.
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] resource_identifier
951
+ # The identifier from your request that this job is processing.
952
+ # @return [String]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/JobResult AWS API Documentation
955
+ #
956
+ class JobResult < Struct.new(
957
+ :job_id,
958
+ :resource_identifier)
959
+ SENSITIVE = []
960
+ include Aws::Structure
961
+ end
962
+
963
+ # Contains summary information about an asynchronous job in a list
964
+ # response.
965
+ #
966
+ # @!attribute [rw] job_id
967
+ # The unique identifier of the asynchronous job. Use the GetJob
968
+ # operation to check the status of the job and to retrieve its
969
+ # results.
970
+ # @return [String]
971
+ #
972
+ # @!attribute [rw] status
973
+ # The current lifecycle status of the job.
974
+ # @return [String]
975
+ #
976
+ # @!attribute [rw] operation_type
977
+ # The type of mutating operation that created the job.
978
+ # @return [String]
979
+ #
980
+ # @!attribute [rw] created_at
981
+ # The time when the resource was created, in Unix epoch time.
982
+ # @return [Time]
983
+ #
984
+ # @!attribute [rw] updated_at
985
+ # The time when the resource was last updated, in Unix epoch time.
986
+ # @return [Time]
987
+ #
988
+ # @!attribute [rw] brand_profile_id
989
+ # The brand profile that the job operates on. This value is absent for
990
+ # operations that create a brand profile.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] error_code
994
+ # A machine-readable code that identifies why the job failed. This
995
+ # value is present only when the job status is FAILED.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] error_message
999
+ # A human-readable description of why the job failed. This value is
1000
+ # present only when the job status is FAILED.
1001
+ # @return [String]
1002
+ #
1003
+ # @!attribute [rw] resources
1004
+ # The resources that were created or updated by the job.
1005
+ # @return [Array<Types::JobResource>]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/JobSummary AWS API Documentation
1008
+ #
1009
+ class JobSummary < Struct.new(
1010
+ :job_id,
1011
+ :status,
1012
+ :operation_type,
1013
+ :created_at,
1014
+ :updated_at,
1015
+ :brand_profile_id,
1016
+ :error_code,
1017
+ :error_message,
1018
+ :resources)
1019
+ SENSITIVE = []
1020
+ include Aws::Structure
1021
+ end
1022
+
1023
+ # @!attribute [rw] brand_profile_id
1024
+ # The unique identifier of the brand profile. You can specify either
1025
+ # the bare ID or the full Amazon Resource Name (ARN).
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] next_token
1029
+ # The token to retrieve the next page of results. This value is
1030
+ # returned when more results are available, and is null when there are
1031
+ # no more results to return.
1032
+ # @return [String]
1033
+ #
1034
+ # @!attribute [rw] max_results
1035
+ # The maximum number of results to return per page.
1036
+ # @return [Integer]
1037
+ #
1038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListBrandProfileAttributesInput AWS API Documentation
1039
+ #
1040
+ class ListBrandProfileAttributesInput < Struct.new(
1041
+ :brand_profile_id,
1042
+ :next_token,
1043
+ :max_results)
1044
+ SENSITIVE = []
1045
+ include Aws::Structure
1046
+ end
1047
+
1048
+ # @!attribute [rw] brand_profile_attributes
1049
+ # The list of brand profile attributes.
1050
+ # @return [Array<Types::BrandProfileAttributeSummary>]
1051
+ #
1052
+ # @!attribute [rw] next_token
1053
+ # The token to retrieve the next page of results. This value is
1054
+ # returned when more results are available, and is null when there are
1055
+ # no more results to return.
1056
+ # @return [String]
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListBrandProfileAttributesOutput AWS API Documentation
1059
+ #
1060
+ class ListBrandProfileAttributesOutput < Struct.new(
1061
+ :brand_profile_attributes,
1062
+ :next_token)
1063
+ SENSITIVE = []
1064
+ include Aws::Structure
1065
+ end
1066
+
1067
+ # @!attribute [rw] next_token
1068
+ # The token to retrieve the next page of results. This value is
1069
+ # returned when more results are available, and is null when there are
1070
+ # no more results to return.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] max_results
1074
+ # The maximum number of results to return per page.
1075
+ # @return [Integer]
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListBrandProfilesInput AWS API Documentation
1078
+ #
1079
+ class ListBrandProfilesInput < Struct.new(
1080
+ :next_token,
1081
+ :max_results)
1082
+ SENSITIVE = []
1083
+ include Aws::Structure
1084
+ end
1085
+
1086
+ # @!attribute [rw] brand_profiles
1087
+ # The list of brand profiles.
1088
+ # @return [Array<Types::BrandProfileInfo>]
1089
+ #
1090
+ # @!attribute [rw] next_token
1091
+ # The token to retrieve the next page of results. This value is
1092
+ # returned when more results are available, and is null when there are
1093
+ # no more results to return.
1094
+ # @return [String]
1095
+ #
1096
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListBrandProfilesOutput AWS API Documentation
1097
+ #
1098
+ class ListBrandProfilesOutput < Struct.new(
1099
+ :brand_profiles,
1100
+ :next_token)
1101
+ SENSITIVE = []
1102
+ include Aws::Structure
1103
+ end
1104
+
1105
+ # @!attribute [rw] max_results
1106
+ # The maximum number of results to return per page.
1107
+ # @return [Integer]
1108
+ #
1109
+ # @!attribute [rw] next_token
1110
+ # The token to retrieve the next page of results. This value is
1111
+ # returned when more results are available, and is null when there are
1112
+ # no more results to return.
1113
+ # @return [String]
1114
+ #
1115
+ # @!attribute [rw] status
1116
+ # Filters the results to jobs that have the specified status.
1117
+ # @return [String]
1118
+ #
1119
+ # @!attribute [rw] brand_profile_id
1120
+ # Filters the results to jobs for the specified brand profile.
1121
+ # @return [String]
1122
+ #
1123
+ # @!attribute [rw] operation_type
1124
+ # Filters the results to jobs of the specified operation type.
1125
+ # @return [String]
1126
+ #
1127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListJobsInput AWS API Documentation
1128
+ #
1129
+ class ListJobsInput < Struct.new(
1130
+ :max_results,
1131
+ :next_token,
1132
+ :status,
1133
+ :brand_profile_id,
1134
+ :operation_type)
1135
+ SENSITIVE = []
1136
+ include Aws::Structure
1137
+ end
1138
+
1139
+ # @!attribute [rw] jobs
1140
+ # The list of asynchronous jobs.
1141
+ # @return [Array<Types::JobSummary>]
1142
+ #
1143
+ # @!attribute [rw] next_token
1144
+ # The token to retrieve the next page of results. This value is
1145
+ # returned when more results are available, and is null when there are
1146
+ # no more results to return.
1147
+ # @return [String]
1148
+ #
1149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListJobsOutput AWS API Documentation
1150
+ #
1151
+ class ListJobsOutput < Struct.new(
1152
+ :jobs,
1153
+ :next_token)
1154
+ SENSITIVE = []
1155
+ include Aws::Structure
1156
+ end
1157
+
1158
+ # @!attribute [rw] max_results
1159
+ # The maximum number of results to return per page.
1160
+ # @return [Integer]
1161
+ #
1162
+ # @!attribute [rw] next_token
1163
+ # The token to retrieve the next page of results. This value is
1164
+ # returned when more results are available, and is null when there are
1165
+ # no more results to return.
1166
+ # @return [String]
1167
+ #
1168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListNotifyCodeConfigurationsInput AWS API Documentation
1169
+ #
1170
+ class ListNotifyCodeConfigurationsInput < Struct.new(
1171
+ :max_results,
1172
+ :next_token)
1173
+ SENSITIVE = []
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # @!attribute [rw] notify_code_configurations
1178
+ # The list of notify code configurations.
1179
+ # @return [Array<Types::NotifyCodeConfiguration>]
1180
+ #
1181
+ # @!attribute [rw] next_token
1182
+ # The token to retrieve the next page of results. This value is
1183
+ # returned when more results are available, and is null when there are
1184
+ # no more results to return.
1185
+ # @return [String]
1186
+ #
1187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListNotifyCodeConfigurationsOutput AWS API Documentation
1188
+ #
1189
+ class ListNotifyCodeConfigurationsOutput < Struct.new(
1190
+ :notify_code_configurations,
1191
+ :next_token)
1192
+ SENSITIVE = []
1193
+ include Aws::Structure
1194
+ end
1195
+
1196
+ # @!attribute [rw] brand_profile_id
1197
+ # The unique identifier of the brand profile. You can specify either
1198
+ # the bare ID or the full Amazon Resource Name (ARN).
1199
+ # @return [String]
1200
+ #
1201
+ # @!attribute [rw] max_results
1202
+ # The maximum number of results to return per page.
1203
+ # @return [Integer]
1204
+ #
1205
+ # @!attribute [rw] next_token
1206
+ # The token to retrieve the next page of results. This value is
1207
+ # returned when more results are available, and is null when there are
1208
+ # no more results to return.
1209
+ # @return [String]
1210
+ #
1211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListRegistrationsFromBrandProfileInput AWS API Documentation
1212
+ #
1213
+ class ListRegistrationsFromBrandProfileInput < Struct.new(
1214
+ :brand_profile_id,
1215
+ :max_results,
1216
+ :next_token)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
1221
+ # @!attribute [rw] registration_associations
1222
+ # The list of registrations that are associated with the brand
1223
+ # profile.
1224
+ # @return [Array<Types::RegistrationAssociationSummary>]
1225
+ #
1226
+ # @!attribute [rw] next_token
1227
+ # The token to retrieve the next page of results. This value is
1228
+ # returned when more results are available, and is null when there are
1229
+ # no more results to return.
1230
+ # @return [String]
1231
+ #
1232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListRegistrationsFromBrandProfileOutput AWS API Documentation
1233
+ #
1234
+ class ListRegistrationsFromBrandProfileOutput < Struct.new(
1235
+ :registration_associations,
1236
+ :next_token)
1237
+ SENSITIVE = []
1238
+ include Aws::Structure
1239
+ end
1240
+
1241
+ # @!attribute [rw] resource_arn
1242
+ # The Amazon Resource Name (ARN) of the resource.
1243
+ # @return [String]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListTagsForResourceInput AWS API Documentation
1246
+ #
1247
+ class ListTagsForResourceInput < Struct.new(
1248
+ :resource_arn)
1249
+ SENSITIVE = []
1250
+ include Aws::Structure
1251
+ end
1252
+
1253
+ # @!attribute [rw] tags
1254
+ # An array of key and value pair tags that are associated with the
1255
+ # resource.
1256
+ # @return [Array<Types::Tag>]
1257
+ #
1258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ListTagsForResourceOutput AWS API Documentation
1259
+ #
1260
+ class ListTagsForResourceOutput < Struct.new(
1261
+ :tags)
1262
+ SENSITIVE = []
1263
+ include Aws::Structure
1264
+ end
1265
+
1266
+ # Contains the settings of a notify code configuration, which is a
1267
+ # reusable one-time passcode policy.
1268
+ #
1269
+ # @!attribute [rw] notify_code_configuration_id
1270
+ # The unique identifier of the notify code configuration.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] notify_code_configuration_arn
1274
+ # The Amazon Resource Name (ARN) of the notify code configuration.
1275
+ # @return [String]
1276
+ #
1277
+ # @!attribute [rw] notify_code_configuration_name
1278
+ # The name of the notify code configuration.
1279
+ # @return [String]
1280
+ #
1281
+ # @!attribute [rw] code_configuration_parameters
1282
+ # The passcode policy parameters, including the code type, length,
1283
+ # validity period, and maximum number of attempts.
1284
+ # @return [Types::CodeConfigurationParameters]
1285
+ #
1286
+ # @!attribute [rw] channel_parameters
1287
+ # The channel-specific parameters used to render and deliver the
1288
+ # one-time passcode. A configuration can carry parameters for every
1289
+ # channel at once, and the send route selects the matching channel at
1290
+ # send time.
1291
+ # @return [Types::ChannelParameters]
1292
+ #
1293
+ # @!attribute [rw] deletion_protection_enabled
1294
+ # Specifies whether deletion protection is enabled. When enabled, the
1295
+ # resource cannot be deleted until deletion protection is turned off.
1296
+ # @return [Boolean]
1297
+ #
1298
+ # @!attribute [rw] created_at
1299
+ # The time when the resource was created, in Unix epoch time.
1300
+ # @return [Time]
1301
+ #
1302
+ # @!attribute [rw] updated_at
1303
+ # The time when the resource was last updated, in Unix epoch time.
1304
+ # @return [Time]
1305
+ #
1306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/NotifyCodeConfiguration AWS API Documentation
1307
+ #
1308
+ class NotifyCodeConfiguration < Struct.new(
1309
+ :notify_code_configuration_id,
1310
+ :notify_code_configuration_arn,
1311
+ :notify_code_configuration_name,
1312
+ :code_configuration_parameters,
1313
+ :channel_parameters,
1314
+ :deletion_protection_enabled,
1315
+ :created_at,
1316
+ :updated_at)
1317
+ SENSITIVE = []
1318
+ include Aws::Structure
1319
+ end
1320
+
1321
+ # The delivery parameters for the preapproved notify-template route over
1322
+ # the SMS or voice channels.
1323
+ #
1324
+ # @!attribute [rw] notify_template_id
1325
+ # The identifier of a preapproved notify template for the SMS or voice
1326
+ # channels.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] voice_id
1330
+ # The Amazon Polly voice ID used when the notify template is delivered
1331
+ # over the voice channel.
1332
+ # @return [String]
1333
+ #
1334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/NotifyParameters AWS API Documentation
1335
+ #
1336
+ class NotifyParameters < Struct.new(
1337
+ :notify_template_id,
1338
+ :voice_id)
1339
+ SENSITIVE = []
1340
+ include Aws::Structure
1341
+ end
1342
+
1343
+ # Contains summary information about a registration that is associated
1344
+ # with a brand profile.
1345
+ #
1346
+ # @!attribute [rw] registration_id
1347
+ # The identifier of the registration.
1348
+ # @return [String]
1349
+ #
1350
+ # @!attribute [rw] registration_type
1351
+ # The type of the registration, for example
1352
+ # US\_TOLL\_FREE\_REGISTRATION or SENDER\_ID.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] created_at
1356
+ # The time when the resource was created, in Unix epoch time.
1357
+ # @return [Time]
1358
+ #
1359
+ # @!attribute [rw] smart_match_used
1360
+ # Specifies whether smart matching was used to create the association.
1361
+ # @return [Boolean]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/RegistrationAssociationSummary AWS API Documentation
1364
+ #
1365
+ class RegistrationAssociationSummary < Struct.new(
1366
+ :registration_id,
1367
+ :registration_type,
1368
+ :created_at,
1369
+ :smart_match_used)
1370
+ SENSITIVE = []
1371
+ include Aws::Structure
1372
+ end
1373
+
1374
+ # The request references a resource that does not exist. Verify that the
1375
+ # resource identifier is correct and try your request again.
1376
+ #
1377
+ # @!attribute [rw] message
1378
+ # @return [String]
1379
+ #
1380
+ # @!attribute [rw] resource_id
1381
+ # The identifier of the resource that could not be found.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] resource_type
1385
+ # The type of the resource that could not be found.
1386
+ # @return [String]
1387
+ #
1388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ResourceNotFoundException AWS API Documentation
1389
+ #
1390
+ class ResourceNotFoundException < Struct.new(
1391
+ :message,
1392
+ :resource_id,
1393
+ :resource_type)
1394
+ SENSITIVE = []
1395
+ include Aws::Structure
1396
+ end
1397
+
1398
+ # @!attribute [rw] channel
1399
+ # The channel used to deliver the one-time passcode to the recipient.
1400
+ # @return [String]
1401
+ #
1402
+ # @!attribute [rw] destination_identity
1403
+ # The recipient identifier. For the TEXT and VOICE channels, specify
1404
+ # an E.164 phone number. For the WhatsApp channel, specify a WhatsApp
1405
+ # address.
1406
+ # @return [String]
1407
+ #
1408
+ # @!attribute [rw] origination_identity
1409
+ # The identity used to send the message, such as a phone number,
1410
+ # sender ID, or pool that is owned by your account.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] notify_code_configuration
1414
+ # The identifier or Amazon Resource Name (ARN) of the notify code
1415
+ # configuration that supplies the passcode policy and template
1416
+ # defaults. When you do not specify a configuration, you must supply
1417
+ # the template in the request.
1418
+ # @return [String]
1419
+ #
1420
+ # @!attribute [rw] override_channel_parameters
1421
+ # The channel-specific parameters used to render and deliver the
1422
+ # one-time passcode for this request. The route that is derived from
1423
+ # the channel and the origination identity selects the matching
1424
+ # channel. When you do not specify channel parameters, the service
1425
+ # uses the parameters from the referenced notify code configuration.
1426
+ # @return [Types::ChannelParameters]
1427
+ #
1428
+ # @!attribute [rw] override_code_configuration_parameters
1429
+ # The per-send overrides for the passcode policy parameters, including
1430
+ # the code type, length, validity period, and maximum number of
1431
+ # attempts. These values override the values from the referenced
1432
+ # notify code configuration. When you do not specify a value, the
1433
+ # value from the configuration is used, and if neither is set, the
1434
+ # service default applies.
1435
+ # @return [Types::CodeConfigurationParameters]
1436
+ #
1437
+ # @!attribute [rw] configuration_set_name
1438
+ # The name of the configuration set used to control how delivery
1439
+ # events for the message are handled.
1440
+ # @return [String]
1441
+ #
1442
+ # @!attribute [rw] context
1443
+ # A map of custom key and value pairs that are propagated to the
1444
+ # delivery events for this verification.
1445
+ # @return [Hash<String,String>]
1446
+ #
1447
+ # @!attribute [rw] reference_id
1448
+ # A caller-supplied reference identifier that binds a send request to
1449
+ # a later validate request. Specify the same value in both requests.
1450
+ # @return [String]
1451
+ #
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/SendNotifyCodeVerificationInput AWS API Documentation
1453
+ #
1454
+ class SendNotifyCodeVerificationInput < Struct.new(
1455
+ :channel,
1456
+ :destination_identity,
1457
+ :origination_identity,
1458
+ :notify_code_configuration,
1459
+ :override_channel_parameters,
1460
+ :override_code_configuration_parameters,
1461
+ :configuration_set_name,
1462
+ :context,
1463
+ :reference_id)
1464
+ SENSITIVE = [:destination_identity, :context]
1465
+ include Aws::Structure
1466
+ end
1467
+
1468
+ # @!attribute [rw] verification_id
1469
+ # The service-generated identifier for the verification.
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] message_id
1473
+ # The service-generated identifier for the message that delivers the
1474
+ # one-time passcode.
1475
+ # @return [String]
1476
+ #
1477
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/SendNotifyCodeVerificationOutput AWS API Documentation
1478
+ #
1479
+ class SendNotifyCodeVerificationOutput < Struct.new(
1480
+ :verification_id,
1481
+ :message_id)
1482
+ SENSITIVE = []
1483
+ include Aws::Structure
1484
+ end
1485
+
1486
+ # The request would exceed a service quota for your account.
1487
+ #
1488
+ # @!attribute [rw] message
1489
+ # @return [String]
1490
+ #
1491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ServiceQuotaExceededException AWS API Documentation
1492
+ #
1493
+ class ServiceQuotaExceededException < Struct.new(
1494
+ :message)
1495
+ SENSITIVE = []
1496
+ include Aws::Structure
1497
+ end
1498
+
1499
+ # Describes a tag as a key and value pair that you can associate with a
1500
+ # resource.
1501
+ #
1502
+ # @!attribute [rw] key
1503
+ # The key of the tag.
1504
+ # @return [String]
1505
+ #
1506
+ # @!attribute [rw] value
1507
+ # The value of the tag.
1508
+ # @return [String]
1509
+ #
1510
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/Tag AWS API Documentation
1511
+ #
1512
+ class Tag < Struct.new(
1513
+ :key,
1514
+ :value)
1515
+ SENSITIVE = []
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # @!attribute [rw] resource_arn
1520
+ # The Amazon Resource Name (ARN) of the resource.
1521
+ # @return [String]
1522
+ #
1523
+ # @!attribute [rw] tags
1524
+ # An array of key and value pair tags that are associated with the
1525
+ # resource.
1526
+ # @return [Array<Types::Tag>]
1527
+ #
1528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/TagResourceInput AWS API Documentation
1529
+ #
1530
+ class TagResourceInput < Struct.new(
1531
+ :resource_arn,
1532
+ :tags)
1533
+ SENSITIVE = []
1534
+ include Aws::Structure
1535
+ end
1536
+
1537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/TagResourceOutput AWS API Documentation
1538
+ #
1539
+ class TagResourceOutput < Aws::EmptyStructure; end
1540
+
1541
+ # The delivery parameters for the text channel, which delivers over SMS
1542
+ # or RCS.
1543
+ #
1544
+ # @!attribute [rw] inline_template_body
1545
+ # The freeform message template used to render the one-time passcode
1546
+ # for the SMS or RCS channels. The template must contain the code
1547
+ # placeholder.
1548
+ # @return [String]
1549
+ #
1550
+ # @!attribute [rw] destination_country_parameters
1551
+ # A map of country-specific parameters that control one-time passcode
1552
+ # delivery.
1553
+ # @return [Hash<String,String>]
1554
+ #
1555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/TextParameters AWS API Documentation
1556
+ #
1557
+ class TextParameters < Struct.new(
1558
+ :inline_template_body,
1559
+ :destination_country_parameters)
1560
+ SENSITIVE = [:inline_template_body, :destination_country_parameters]
1561
+ include Aws::Structure
1562
+ end
1563
+
1564
+ # The request was denied because it exceeded the allowed request rate.
1565
+ #
1566
+ # @!attribute [rw] message
1567
+ # @return [String]
1568
+ #
1569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ThrottlingException AWS API Documentation
1570
+ #
1571
+ class ThrottlingException < Struct.new(
1572
+ :message)
1573
+ SENSITIVE = []
1574
+ include Aws::Structure
1575
+ end
1576
+
1577
+ # @!attribute [rw] resource_arn
1578
+ # The Amazon Resource Name (ARN) of the resource.
1579
+ # @return [String]
1580
+ #
1581
+ # @!attribute [rw] tag_keys
1582
+ # The list of tag keys to remove from the resource.
1583
+ # @return [Array<String>]
1584
+ #
1585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UntagResourceInput AWS API Documentation
1586
+ #
1587
+ class UntagResourceInput < Struct.new(
1588
+ :resource_arn,
1589
+ :tag_keys)
1590
+ SENSITIVE = []
1591
+ include Aws::Structure
1592
+ end
1593
+
1594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UntagResourceOutput AWS API Documentation
1595
+ #
1596
+ class UntagResourceOutput < Aws::EmptyStructure; end
1597
+
1598
+ # @!attribute [rw] brand_profile_id
1599
+ # The unique identifier of the brand profile. You can specify either
1600
+ # the bare ID or the full Amazon Resource Name (ARN).
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] attribute_name
1604
+ # The name of the brand profile attribute. The name is unique within a
1605
+ # brand profile.
1606
+ # @return [String]
1607
+ #
1608
+ # @!attribute [rw] attribute_value
1609
+ # The text value of the attribute. This value applies to attributes of
1610
+ # type TEXT.
1611
+ # @return [String]
1612
+ #
1613
+ # @!attribute [rw] attachment_body
1614
+ # The binary content for an attribute of type IMAGE or DOCUMENT. The
1615
+ # content is base64-encoded when it is sent over the wire.
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] description
1619
+ # A description of the attribute.
1620
+ # @return [String]
1621
+ #
1622
+ # @!attribute [rw] category
1623
+ # The category of the attribute.
1624
+ # @return [String]
1625
+ #
1626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileAttributeInput AWS API Documentation
1627
+ #
1628
+ class UpdateBrandProfileAttributeInput < Struct.new(
1629
+ :brand_profile_id,
1630
+ :attribute_name,
1631
+ :attribute_value,
1632
+ :attachment_body,
1633
+ :description,
1634
+ :category)
1635
+ SENSITIVE = [:attribute_name, :attribute_value, :description]
1636
+ include Aws::Structure
1637
+ end
1638
+
1639
+ # @!attribute [rw] attribute_name
1640
+ # The name of the brand profile attribute. The name is unique within a
1641
+ # brand profile.
1642
+ # @return [String]
1643
+ #
1644
+ # @!attribute [rw] attribute_type
1645
+ # The type of the attribute. TEXT stores an inline value. IMAGE and
1646
+ # DOCUMENT store binary media that you upload.
1647
+ # @return [String]
1648
+ #
1649
+ # @!attribute [rw] attribute_value
1650
+ # The text value of the attribute. This value applies to attributes of
1651
+ # type TEXT.
1652
+ # @return [String]
1653
+ #
1654
+ # @!attribute [rw] description
1655
+ # A description of the attribute.
1656
+ # @return [String]
1657
+ #
1658
+ # @!attribute [rw] category
1659
+ # The category of the attribute.
1660
+ # @return [String]
1661
+ #
1662
+ # @!attribute [rw] media_content_type
1663
+ # The MIME content type of the attribute media.
1664
+ # @return [String]
1665
+ #
1666
+ # @!attribute [rw] media_size_bytes
1667
+ # The size of the attribute media, in bytes.
1668
+ # @return [Integer]
1669
+ #
1670
+ # @!attribute [rw] created_at
1671
+ # The time when the resource was created, in Unix epoch time.
1672
+ # @return [Time]
1673
+ #
1674
+ # @!attribute [rw] updated_at
1675
+ # The time when the resource was last updated, in Unix epoch time.
1676
+ # @return [Time]
1677
+ #
1678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileAttributeOutput AWS API Documentation
1679
+ #
1680
+ class UpdateBrandProfileAttributeOutput < Struct.new(
1681
+ :attribute_name,
1682
+ :attribute_type,
1683
+ :attribute_value,
1684
+ :description,
1685
+ :category,
1686
+ :media_content_type,
1687
+ :media_size_bytes,
1688
+ :created_at,
1689
+ :updated_at)
1690
+ SENSITIVE = [:attribute_name, :attribute_value, :description]
1691
+ include Aws::Structure
1692
+ end
1693
+
1694
+ # @!attribute [rw] brand_profile_id
1695
+ # The unique identifier of the brand profile. You can specify either
1696
+ # the bare ID or the full Amazon Resource Name (ARN).
1697
+ # @return [String]
1698
+ #
1699
+ # @!attribute [rw] registration_id
1700
+ # The identifier or Amazon Resource Name (ARN) of the registration to
1701
+ # import attributes from.
1702
+ # @return [String]
1703
+ #
1704
+ # @!attribute [rw] smart_match
1705
+ # Specifies whether to use semantic field mapping between brand
1706
+ # profile attributes and registration fields. The default is true.
1707
+ # When false, the service maps fields using a fixed set of standard
1708
+ # field types.
1709
+ # @return [Boolean]
1710
+ #
1711
+ # @!attribute [rw] on_attribute_conflict
1712
+ # Specifies how the service resolves an attribute that already exists.
1713
+ # REPLACE overwrites the existing value with the incoming value.
1714
+ # PRESERVE keeps the existing value.
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] client_token
1718
+ # A unique, case-sensitive identifier that you provide to ensure the
1719
+ # idempotency of the request. If you do not specify a client token,
1720
+ # the AWS SDK automatically generates one.
1721
+ #
1722
+ # **A suitable default value is auto-generated.** You should normally
1723
+ # not need to pass this option.
1724
+ # @return [String]
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileFromRegistrationInput AWS API Documentation
1727
+ #
1728
+ class UpdateBrandProfileFromRegistrationInput < Struct.new(
1729
+ :brand_profile_id,
1730
+ :registration_id,
1731
+ :smart_match,
1732
+ :on_attribute_conflict,
1733
+ :client_token)
1734
+ SENSITIVE = [:client_token]
1735
+ include Aws::Structure
1736
+ end
1737
+
1738
+ # @!attribute [rw] results
1739
+ # The results of the operation. Each result pairs a requested item
1740
+ # with the asynchronous job that processes it.
1741
+ # @return [Array<Types::JobResult>]
1742
+ #
1743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileFromRegistrationOutput AWS API Documentation
1744
+ #
1745
+ class UpdateBrandProfileFromRegistrationOutput < Struct.new(
1746
+ :results)
1747
+ SENSITIVE = []
1748
+ include Aws::Structure
1749
+ end
1750
+
1751
+ # @!attribute [rw] brand_profile_id
1752
+ # The unique identifier of the brand profile. You can specify either
1753
+ # the bare ID or the full Amazon Resource Name (ARN).
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] brand_profile_name
1757
+ # The name of the brand profile. The name can contain alphanumeric
1758
+ # characters, underscores, hyphens, and spaces.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] deletion_protection_enabled
1762
+ # Specifies whether deletion protection is enabled. When enabled, the
1763
+ # resource cannot be deleted until deletion protection is turned off.
1764
+ # @return [Boolean]
1765
+ #
1766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileInput AWS API Documentation
1767
+ #
1768
+ class UpdateBrandProfileInput < Struct.new(
1769
+ :brand_profile_id,
1770
+ :brand_profile_name,
1771
+ :deletion_protection_enabled)
1772
+ SENSITIVE = []
1773
+ include Aws::Structure
1774
+ end
1775
+
1776
+ # @!attribute [rw] brand_profile_id
1777
+ # The unique identifier of the brand profile.
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] brand_profile_arn
1781
+ # The Amazon Resource Name (ARN) of the brand profile.
1782
+ # @return [String]
1783
+ #
1784
+ # @!attribute [rw] brand_profile_name
1785
+ # The name of the brand profile. The name can contain alphanumeric
1786
+ # characters, underscores, hyphens, and spaces.
1787
+ # @return [String]
1788
+ #
1789
+ # @!attribute [rw] status
1790
+ # The current lifecycle status of the brand profile.
1791
+ # @return [String]
1792
+ #
1793
+ # @!attribute [rw] deletion_protection_enabled
1794
+ # Specifies whether deletion protection is enabled. When enabled, the
1795
+ # resource cannot be deleted until deletion protection is turned off.
1796
+ # @return [Boolean]
1797
+ #
1798
+ # @!attribute [rw] created_at
1799
+ # The time when the resource was created, in Unix epoch time.
1800
+ # @return [Time]
1801
+ #
1802
+ # @!attribute [rw] updated_at
1803
+ # The time when the resource was last updated, in Unix epoch time.
1804
+ # @return [Time]
1805
+ #
1806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateBrandProfileOutput AWS API Documentation
1807
+ #
1808
+ class UpdateBrandProfileOutput < Struct.new(
1809
+ :brand_profile_id,
1810
+ :brand_profile_arn,
1811
+ :brand_profile_name,
1812
+ :status,
1813
+ :deletion_protection_enabled,
1814
+ :created_at,
1815
+ :updated_at)
1816
+ SENSITIVE = []
1817
+ include Aws::Structure
1818
+ end
1819
+
1820
+ # The updated channel-specific parameters used only when you update a
1821
+ # notify code configuration. When you omit a channel, that channel's
1822
+ # parameters remain unchanged. When you supply a channel, you can clear
1823
+ # individual fields by using the empty-string or empty-map sentinel on a
1824
+ # member, or drop the whole channel's parameters by clearing every
1825
+ # member. These sentinels apply only when you update a configuration; a
1826
+ # create request rejects empty values with a validation error.
1827
+ #
1828
+ # @!attribute [rw] text
1829
+ # The text-channel parameters to update. Omit this member to leave the
1830
+ # text-channel parameters unchanged.
1831
+ # @return [Types::UpdateTextParameters]
1832
+ #
1833
+ # @!attribute [rw] voice
1834
+ # The voice-channel parameters to update. Omit this member to leave
1835
+ # the voice-channel parameters unchanged.
1836
+ # @return [Types::UpdateVoiceParameters]
1837
+ #
1838
+ # @!attribute [rw] notify
1839
+ # The notify-template-route parameters to update. Omit this member to
1840
+ # leave them unchanged.
1841
+ # @return [Types::UpdateNotifyParameters]
1842
+ #
1843
+ # @!attribute [rw] whats_app
1844
+ # The WhatsApp-channel parameters to update. Omit this member to leave
1845
+ # the WhatsApp-channel parameters unchanged.
1846
+ # @return [Types::UpdateWhatsAppParameters]
1847
+ #
1848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateChannelParameters AWS API Documentation
1849
+ #
1850
+ class UpdateChannelParameters < Struct.new(
1851
+ :text,
1852
+ :voice,
1853
+ :notify,
1854
+ :whats_app)
1855
+ SENSITIVE = []
1856
+ include Aws::Structure
1857
+ end
1858
+
1859
+ # The loose variant of the passcode policy parameters that is used only
1860
+ # when you update a notify code configuration. When you omit a member,
1861
+ # its current value is preserved.
1862
+ #
1863
+ # @!attribute [rw] code_type
1864
+ # The updated character set used to generate the one-time passcode.
1865
+ # Omit this member to preserve the current value.
1866
+ # @return [String]
1867
+ #
1868
+ # @!attribute [rw] code_length
1869
+ # The updated number of characters in the one-time passcode. Valid
1870
+ # values range from 4 through 8. Omit this member to preserve the
1871
+ # current value.
1872
+ # @return [Integer]
1873
+ #
1874
+ # @!attribute [rw] validity_period_minutes
1875
+ # The updated length of time, in minutes, that the one-time passcode
1876
+ # remains valid. Valid values range from 1 through 60. Omit this
1877
+ # member to preserve the current value.
1878
+ # @return [Integer]
1879
+ #
1880
+ # @!attribute [rw] max_attempts
1881
+ # The updated maximum number of validation attempts that are allowed
1882
+ # before the verification is locked. Valid values range from 1 through
1883
+ # 5. Omit this member to preserve the current value.
1884
+ # @return [Integer]
1885
+ #
1886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateCodeConfigurationParameters AWS API Documentation
1887
+ #
1888
+ class UpdateCodeConfigurationParameters < Struct.new(
1889
+ :code_type,
1890
+ :code_length,
1891
+ :validity_period_minutes,
1892
+ :max_attempts)
1893
+ SENSITIVE = []
1894
+ include Aws::Structure
1895
+ end
1896
+
1897
+ # @!attribute [rw] notify_code_configuration_id
1898
+ # The unique identifier of the notify code configuration. You can
1899
+ # specify either the bare ID or the full Amazon Resource Name (ARN).
1900
+ # @return [String]
1901
+ #
1902
+ # @!attribute [rw] notify_code_configuration_name
1903
+ # The name of the notify code configuration.
1904
+ # @return [String]
1905
+ #
1906
+ # @!attribute [rw] code_configuration_parameters
1907
+ # The updated passcode policy parameters, including the code type,
1908
+ # length, validity period, and maximum number of attempts. When you
1909
+ # omit a member, its current value is preserved.
1910
+ # @return [Types::UpdateCodeConfigurationParameters]
1911
+ #
1912
+ # @!attribute [rw] channel_parameters
1913
+ # The updated channel-specific parameters used to render and deliver
1914
+ # the one-time passcode. This is a loose, nested update: when you omit
1915
+ # a channel, that channel's parameters remain unchanged. Within a
1916
+ # supplied channel, an empty string on a string member, or an empty
1917
+ # map on the destination-country parameters, clears the currently
1918
+ # stored value, and absent members preserve the current value.
1919
+ # @return [Types::UpdateChannelParameters]
1920
+ #
1921
+ # @!attribute [rw] deletion_protection_enabled
1922
+ # Specifies whether deletion protection is enabled. When enabled, the
1923
+ # resource cannot be deleted until deletion protection is turned off.
1924
+ # @return [Boolean]
1925
+ #
1926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateNotifyCodeConfigurationInput AWS API Documentation
1927
+ #
1928
+ class UpdateNotifyCodeConfigurationInput < Struct.new(
1929
+ :notify_code_configuration_id,
1930
+ :notify_code_configuration_name,
1931
+ :code_configuration_parameters,
1932
+ :channel_parameters,
1933
+ :deletion_protection_enabled)
1934
+ SENSITIVE = []
1935
+ include Aws::Structure
1936
+ end
1937
+
1938
+ # @!attribute [rw] notify_code_configuration
1939
+ # The notify code configuration resource.
1940
+ # @return [Types::NotifyCodeConfiguration]
1941
+ #
1942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateNotifyCodeConfigurationOutput AWS API Documentation
1943
+ #
1944
+ class UpdateNotifyCodeConfigurationOutput < Struct.new(
1945
+ :notify_code_configuration)
1946
+ SENSITIVE = []
1947
+ include Aws::Structure
1948
+ end
1949
+
1950
+ # The updated delivery parameters for the preapproved notify-template
1951
+ # route. Absent members preserve the current value, and the empty
1952
+ # sentinel on a member clears it.
1953
+ #
1954
+ # @!attribute [rw] notify_template_id
1955
+ # The updated identifier of a preapproved notify template for the SMS
1956
+ # or voice channels. An empty string clears the previously stored
1957
+ # value.
1958
+ # @return [String]
1959
+ #
1960
+ # @!attribute [rw] voice_id
1961
+ # The updated Amazon Polly voice ID. An empty string clears the
1962
+ # previously stored value.
1963
+ # @return [String]
1964
+ #
1965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateNotifyParameters AWS API Documentation
1966
+ #
1967
+ class UpdateNotifyParameters < Struct.new(
1968
+ :notify_template_id,
1969
+ :voice_id)
1970
+ SENSITIVE = []
1971
+ include Aws::Structure
1972
+ end
1973
+
1974
+ # @!attribute [rw] brand_profile_id
1975
+ # The unique identifier of the brand profile. You can specify either
1976
+ # the bare ID or the full Amazon Resource Name (ARN).
1977
+ # @return [String]
1978
+ #
1979
+ # @!attribute [rw] registration_ids
1980
+ # The identifiers of the registrations.
1981
+ # @return [Array<String>]
1982
+ #
1983
+ # @!attribute [rw] smart_match
1984
+ # Specifies whether to use semantic field mapping between brand
1985
+ # profile attributes and registration fields. The default is true.
1986
+ # When false, the service maps fields using a fixed set of standard
1987
+ # field types.
1988
+ # @return [Boolean]
1989
+ #
1990
+ # @!attribute [rw] on_attribute_conflict
1991
+ # Specifies how the service resolves an attribute that already exists.
1992
+ # REPLACE overwrites the existing value with the incoming value.
1993
+ # PRESERVE keeps the existing value.
1994
+ # @return [String]
1995
+ #
1996
+ # @!attribute [rw] client_token
1997
+ # A unique, case-sensitive identifier that you provide to ensure the
1998
+ # idempotency of the request. If you do not specify a client token,
1999
+ # the AWS SDK automatically generates one.
2000
+ #
2001
+ # **A suitable default value is auto-generated.** You should normally
2002
+ # not need to pass this option.
2003
+ # @return [String]
2004
+ #
2005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateRegistrationsFromBrandProfileInput AWS API Documentation
2006
+ #
2007
+ class UpdateRegistrationsFromBrandProfileInput < Struct.new(
2008
+ :brand_profile_id,
2009
+ :registration_ids,
2010
+ :smart_match,
2011
+ :on_attribute_conflict,
2012
+ :client_token)
2013
+ SENSITIVE = [:client_token]
2014
+ include Aws::Structure
2015
+ end
2016
+
2017
+ # @!attribute [rw] results
2018
+ # The results of the operation. Each result pairs a requested item
2019
+ # with the asynchronous job that processes it.
2020
+ # @return [Array<Types::JobResult>]
2021
+ #
2022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateRegistrationsFromBrandProfileOutput AWS API Documentation
2023
+ #
2024
+ class UpdateRegistrationsFromBrandProfileOutput < Struct.new(
2025
+ :results)
2026
+ SENSITIVE = []
2027
+ include Aws::Structure
2028
+ end
2029
+
2030
+ # The updated delivery parameters for the text channel. Absent members
2031
+ # preserve the current value, and the empty sentinel on a member clears
2032
+ # it.
2033
+ #
2034
+ # @!attribute [rw] inline_template_body
2035
+ # The updated freeform SMS or RCS template body. An empty string
2036
+ # clears the previously stored value.
2037
+ # @return [String]
2038
+ #
2039
+ # @!attribute [rw] destination_country_parameters
2040
+ # The updated map of country-specific parameters that control one-time
2041
+ # passcode delivery. An empty map clears the previously stored value.
2042
+ # @return [Hash<String,String>]
2043
+ #
2044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateTextParameters AWS API Documentation
2045
+ #
2046
+ class UpdateTextParameters < Struct.new(
2047
+ :inline_template_body,
2048
+ :destination_country_parameters)
2049
+ SENSITIVE = [:inline_template_body, :destination_country_parameters]
2050
+ include Aws::Structure
2051
+ end
2052
+
2053
+ # The updated delivery parameters for the voice channel. Absent members
2054
+ # preserve the current value, and the empty sentinel on a member clears
2055
+ # it.
2056
+ #
2057
+ # @!attribute [rw] inline_template_body
2058
+ # The updated freeform voice template body. An empty string clears the
2059
+ # previously stored value.
2060
+ # @return [String]
2061
+ #
2062
+ # @!attribute [rw] language_code
2063
+ # The updated BCP 47 language code. An empty string clears the
2064
+ # previously stored value.
2065
+ # @return [String]
2066
+ #
2067
+ # @!attribute [rw] voice_id
2068
+ # The updated Amazon Polly voice ID. An empty string clears the
2069
+ # previously stored value.
2070
+ # @return [String]
2071
+ #
2072
+ # @!attribute [rw] voice_message_body_text_type
2073
+ # The updated format of the voice message body. Valid values are TEXT
2074
+ # and SSML. Omit this member to preserve the current value.
2075
+ # @return [String]
2076
+ #
2077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateVoiceParameters AWS API Documentation
2078
+ #
2079
+ class UpdateVoiceParameters < Struct.new(
2080
+ :inline_template_body,
2081
+ :language_code,
2082
+ :voice_id,
2083
+ :voice_message_body_text_type)
2084
+ SENSITIVE = [:inline_template_body]
2085
+ include Aws::Structure
2086
+ end
2087
+
2088
+ # The updated delivery parameters for the WhatsApp channel. Absent
2089
+ # members preserve the current value, and the empty sentinel on a member
2090
+ # clears it.
2091
+ #
2092
+ # @!attribute [rw] whats_app_template_name
2093
+ # The updated name of the Meta-approved WhatsApp authentication
2094
+ # template. An empty string clears the previously stored value.
2095
+ # @return [String]
2096
+ #
2097
+ # @!attribute [rw] language_code
2098
+ # The updated BCP 47 language code. An empty string clears the
2099
+ # previously stored value.
2100
+ # @return [String]
2101
+ #
2102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/UpdateWhatsAppParameters AWS API Documentation
2103
+ #
2104
+ class UpdateWhatsAppParameters < Struct.new(
2105
+ :whats_app_template_name,
2106
+ :language_code)
2107
+ SENSITIVE = []
2108
+ include Aws::Structure
2109
+ end
2110
+
2111
+ # @!attribute [rw] destination_identity
2112
+ # The recipient identifier. For the TEXT and VOICE channels, specify
2113
+ # an E.164 phone number. For the WhatsApp channel, specify a WhatsApp
2114
+ # address.
2115
+ # @return [String]
2116
+ #
2117
+ # @!attribute [rw] reference_id
2118
+ # The caller-supplied reference identifier used to locate the
2119
+ # verification. This value must match the value that you supplied to
2120
+ # the SendNotifyCodeVerification operation.
2121
+ # @return [String]
2122
+ #
2123
+ # @!attribute [rw] code
2124
+ # The one-time passcode that the recipient submitted for validation.
2125
+ # @return [String]
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ValidateNotifyCodeVerificationInput AWS API Documentation
2128
+ #
2129
+ class ValidateNotifyCodeVerificationInput < Struct.new(
2130
+ :destination_identity,
2131
+ :reference_id,
2132
+ :code)
2133
+ SENSITIVE = [:destination_identity, :code]
2134
+ include Aws::Structure
2135
+ end
2136
+
2137
+ # @!attribute [rw] status
2138
+ # The outcome of the validation attempt. VALID indicates that the
2139
+ # submitted passcode matched an active verification. INVALID indicates
2140
+ # that the passcode did not match, expired, or exceeded its attempt
2141
+ # limit.
2142
+ # @return [String]
2143
+ #
2144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ValidateNotifyCodeVerificationOutput AWS API Documentation
2145
+ #
2146
+ class ValidateNotifyCodeVerificationOutput < Struct.new(
2147
+ :status)
2148
+ SENSITIVE = []
2149
+ include Aws::Structure
2150
+ end
2151
+
2152
+ # A standard error for input validation failures. This should be thrown
2153
+ # by services when a member of the input structure falls outside of the
2154
+ # modeled or documented constraints.
2155
+ #
2156
+ # @!attribute [rw] message
2157
+ # A summary of the validation failure.
2158
+ # @return [String]
2159
+ #
2160
+ # @!attribute [rw] field_list
2161
+ # A list of specific failures encountered while validating the input.
2162
+ # A member can appear in this list more than once if it failed to
2163
+ # satisfy multiple constraints.
2164
+ # @return [Array<Types::ValidationExceptionField>]
2165
+ #
2166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ValidationException AWS API Documentation
2167
+ #
2168
+ class ValidationException < Struct.new(
2169
+ :message,
2170
+ :field_list)
2171
+ SENSITIVE = []
2172
+ include Aws::Structure
2173
+ end
2174
+
2175
+ # Describes one specific validation failure for an input member.
2176
+ #
2177
+ # @!attribute [rw] path
2178
+ # A JSONPointer expression to the structure member whose value failed
2179
+ # to satisfy the modeled constraints.
2180
+ # @return [String]
2181
+ #
2182
+ # @!attribute [rw] message
2183
+ # A detailed description of the validation failure.
2184
+ # @return [String]
2185
+ #
2186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/ValidationExceptionField AWS API Documentation
2187
+ #
2188
+ class ValidationExceptionField < Struct.new(
2189
+ :path,
2190
+ :message)
2191
+ SENSITIVE = []
2192
+ include Aws::Structure
2193
+ end
2194
+
2195
+ # The delivery parameters for the voice channel.
2196
+ #
2197
+ # @!attribute [rw] inline_template_body
2198
+ # The freeform message template used to render the one-time passcode
2199
+ # for the voice channel. The template must contain the code
2200
+ # placeholder.
2201
+ # @return [String]
2202
+ #
2203
+ # @!attribute [rw] language_code
2204
+ # The BCP 47 language code used to render the voice message.
2205
+ # @return [String]
2206
+ #
2207
+ # @!attribute [rw] voice_id
2208
+ # The Amazon Polly voice ID used for the voice channel.
2209
+ # @return [String]
2210
+ #
2211
+ # @!attribute [rw] voice_message_body_text_type
2212
+ # The format of the voice message body. Valid values are TEXT and
2213
+ # SSML.
2214
+ # @return [String]
2215
+ #
2216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/VoiceParameters AWS API Documentation
2217
+ #
2218
+ class VoiceParameters < Struct.new(
2219
+ :inline_template_body,
2220
+ :language_code,
2221
+ :voice_id,
2222
+ :voice_message_body_text_type)
2223
+ SENSITIVE = [:inline_template_body]
2224
+ include Aws::Structure
2225
+ end
2226
+
2227
+ # The delivery parameters for the WhatsApp channel.
2228
+ #
2229
+ # @!attribute [rw] whats_app_template_name
2230
+ # The name of the Meta-approved WhatsApp authentication template.
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] language_code
2234
+ # The BCP 47 language code used to render the template. This value is
2235
+ # required for the WhatsApp channel.
2236
+ # @return [String]
2237
+ #
2238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/endusermessaging-2026-09-21/WhatsAppParameters AWS API Documentation
2239
+ #
2240
+ class WhatsAppParameters < Struct.new(
2241
+ :whats_app_template_name,
2242
+ :language_code)
2243
+ SENSITIVE = []
2244
+ include Aws::Structure
2245
+ end
2246
+
2247
+ end
2248
+ end
2249
+