aws-sdk-pinpointsmsvoicev2 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,4130 @@
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::PinpointSMSVoiceV2
11
+ module Types
12
+
13
+ # The request was denied because you don't have sufficient permissions
14
+ # to access the resource.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] reason
20
+ # The reason for the exception.
21
+ # @return [String]
22
+ #
23
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AccessDeniedException AWS API Documentation
24
+ #
25
+ class AccessDeniedException < Struct.new(
26
+ :message,
27
+ :reason)
28
+ SENSITIVE = []
29
+ include Aws::Structure
30
+ end
31
+
32
+ # Displays the attributes associated with a single Amazon Web Services
33
+ # account.
34
+ #
35
+ # @!attribute [rw] name
36
+ # The name of the account attribute.
37
+ # @return [String]
38
+ #
39
+ # @!attribute [rw] value
40
+ # The value associated with the account attribute name.
41
+ # @return [String]
42
+ #
43
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AccountAttribute AWS API Documentation
44
+ #
45
+ class AccountAttribute < Struct.new(
46
+ :name,
47
+ :value)
48
+ SENSITIVE = []
49
+ include Aws::Structure
50
+ end
51
+
52
+ # The current resource quotas associated with an Amazon Web Services
53
+ # account.
54
+ #
55
+ # @!attribute [rw] name
56
+ # The name of the attribute to apply the account limit to.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] used
60
+ # The current amount that has been spent, in US dollars.
61
+ # @return [Integer]
62
+ #
63
+ # @!attribute [rw] max
64
+ # The Amazon Web Services set limit for that resource type, in US
65
+ # dollars.
66
+ # @return [Integer]
67
+ #
68
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AccountLimit AWS API Documentation
69
+ #
70
+ class AccountLimit < Struct.new(
71
+ :name,
72
+ :used,
73
+ :max)
74
+ SENSITIVE = []
75
+ include Aws::Structure
76
+ end
77
+
78
+ # @note When making an API call, you may pass AssociateOriginationIdentityRequest
79
+ # data as a hash:
80
+ #
81
+ # {
82
+ # pool_id: "PoolIdOrArn", # required
83
+ # origination_identity: "PhoneOrSenderIdOrArn", # required
84
+ # iso_country_code: "IsoCountryCode", # required
85
+ # client_token: "ClientToken",
86
+ # }
87
+ #
88
+ # @!attribute [rw] pool_id
89
+ # The pool to update with the new Identity. This value can be either
90
+ # the PoolId or PoolArn, and you can find these values using
91
+ # DescribePools.
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] origination_identity
95
+ # The origination identity to use, such as PhoneNumberId,
96
+ # PhoneNumberArn, SenderId, or SenderIdArn. You can use
97
+ # DescribePhoneNumbers to find the values for PhoneNumberId and
98
+ # PhoneNumberArn, while DescribeSenderIds can be used to get the
99
+ # values for SenderId and SenderIdArn.
100
+ # @return [String]
101
+ #
102
+ # @!attribute [rw] iso_country_code
103
+ # The new two-character code, in ISO 3166-1 alpha-2 format, for the
104
+ # country or region of the origination identity.
105
+ # @return [String]
106
+ #
107
+ # @!attribute [rw] client_token
108
+ # Unique, case-sensitive identifier that you provide to ensure the
109
+ # idempotency of the request. If you don't specify a client token, a
110
+ # randomly generated token is used for the request to ensure
111
+ # idempotency.
112
+ #
113
+ # **A suitable default value is auto-generated.** You should normally
114
+ # not need to pass this option.
115
+ # @return [String]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateOriginationIdentityRequest AWS API Documentation
118
+ #
119
+ class AssociateOriginationIdentityRequest < Struct.new(
120
+ :pool_id,
121
+ :origination_identity,
122
+ :iso_country_code,
123
+ :client_token)
124
+ SENSITIVE = []
125
+ include Aws::Structure
126
+ end
127
+
128
+ # @!attribute [rw] pool_arn
129
+ # The Amazon Resource Name (ARN) of the pool that is now associated
130
+ # with the origination identity.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] pool_id
134
+ # The PoolId of the pool that is now associated with the origination
135
+ # identity.
136
+ # @return [String]
137
+ #
138
+ # @!attribute [rw] origination_identity_arn
139
+ # The PhoneNumberArn or SenderIdArn of the origination identity.
140
+ # @return [String]
141
+ #
142
+ # @!attribute [rw] origination_identity
143
+ # The PhoneNumberId or SenderId of the origination identity.
144
+ # @return [String]
145
+ #
146
+ # @!attribute [rw] iso_country_code
147
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
148
+ # country or region.
149
+ # @return [String]
150
+ #
151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/AssociateOriginationIdentityResult AWS API Documentation
152
+ #
153
+ class AssociateOriginationIdentityResult < Struct.new(
154
+ :pool_arn,
155
+ :pool_id,
156
+ :origination_identity_arn,
157
+ :origination_identity,
158
+ :iso_country_code)
159
+ SENSITIVE = []
160
+ include Aws::Structure
161
+ end
162
+
163
+ # Contains the destination configuration to use when publishing message
164
+ # sending events.
165
+ #
166
+ # @note When making an API call, you may pass CloudWatchLogsDestination
167
+ # data as a hash:
168
+ #
169
+ # {
170
+ # iam_role_arn: "IamRoleArn", # required
171
+ # log_group_arn: "LogGroupArn", # required
172
+ # }
173
+ #
174
+ # @!attribute [rw] iam_role_arn
175
+ # The Amazon Resource Name (ARN) of an Amazon Identity and Access
176
+ # Management (IAM) role that is able to write event data to an Amazon
177
+ # CloudWatch destination.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] log_group_arn
181
+ # The name of the Amazon CloudWatch log group that you want to record
182
+ # events in.
183
+ # @return [String]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CloudWatchLogsDestination AWS API Documentation
186
+ #
187
+ class CloudWatchLogsDestination < Struct.new(
188
+ :iam_role_arn,
189
+ :log_group_arn)
190
+ SENSITIVE = []
191
+ include Aws::Structure
192
+ end
193
+
194
+ # The information for configuration sets that meet a specified criteria.
195
+ #
196
+ # @note When making an API call, you may pass ConfigurationSetFilter
197
+ # data as a hash:
198
+ #
199
+ # {
200
+ # name: "event-destination-name", # required, accepts event-destination-name, matching-event-types, default-message-type, default-sender-id
201
+ # values: ["FilterValue"], # required
202
+ # }
203
+ #
204
+ # @!attribute [rw] name
205
+ # The name of the attribute to filter on.
206
+ # @return [String]
207
+ #
208
+ # @!attribute [rw] values
209
+ # An array values to filter for.
210
+ # @return [Array<String>]
211
+ #
212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ConfigurationSetFilter AWS API Documentation
213
+ #
214
+ class ConfigurationSetFilter < Struct.new(
215
+ :name,
216
+ :values)
217
+ SENSITIVE = []
218
+ include Aws::Structure
219
+ end
220
+
221
+ # Information related to a given configuration set in your Amazon Web
222
+ # Services account.
223
+ #
224
+ # @!attribute [rw] configuration_set_arn
225
+ # The Resource Name (ARN) of the ConfigurationSet.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] configuration_set_name
229
+ # The name of the ConfigurationSet.
230
+ # @return [String]
231
+ #
232
+ # @!attribute [rw] event_destinations
233
+ # An array of EventDestination objects that describe any events to log
234
+ # and where to log them.
235
+ # @return [Array<Types::EventDestination>]
236
+ #
237
+ # @!attribute [rw] default_message_type
238
+ # The type of message. Valid values are TRANSACTIONAL for messages
239
+ # that are critical or time-sensitive and PROMOTIONAL for messages
240
+ # that aren't critical or time-sensitive.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] default_sender_id
244
+ # The default sender ID used by the ConfigurationSet.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] created_timestamp
248
+ # The time when the ConfigurationSet was created, in [UNIX epoch
249
+ # time][1] format.
250
+ #
251
+ #
252
+ #
253
+ # [1]: https://www.epochconverter.com/
254
+ # @return [Time]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ConfigurationSetInformation AWS API Documentation
257
+ #
258
+ class ConfigurationSetInformation < Struct.new(
259
+ :configuration_set_arn,
260
+ :configuration_set_name,
261
+ :event_destinations,
262
+ :default_message_type,
263
+ :default_sender_id,
264
+ :created_timestamp)
265
+ SENSITIVE = []
266
+ include Aws::Structure
267
+ end
268
+
269
+ # Your request has conflicting operations. This can occur if you're
270
+ # trying to perform more than one operation on the same resource at the
271
+ # same time or it could be that the requested action isn't valid for
272
+ # the current state or configuration of the resource.
273
+ #
274
+ # @!attribute [rw] message
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] reason
278
+ # The reason for the exception.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] resource_type
282
+ # The type of resource that caused the exception.
283
+ # @return [String]
284
+ #
285
+ # @!attribute [rw] resource_id
286
+ # The unique identifier of the request.
287
+ # @return [String]
288
+ #
289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ConflictException AWS API Documentation
290
+ #
291
+ class ConflictException < Struct.new(
292
+ :message,
293
+ :reason,
294
+ :resource_type,
295
+ :resource_id)
296
+ SENSITIVE = []
297
+ include Aws::Structure
298
+ end
299
+
300
+ # @note When making an API call, you may pass CreateConfigurationSetRequest
301
+ # data as a hash:
302
+ #
303
+ # {
304
+ # configuration_set_name: "ConfigurationSetName", # required
305
+ # tags: [
306
+ # {
307
+ # key: "TagKey", # required
308
+ # value: "TagValue", # required
309
+ # },
310
+ # ],
311
+ # client_token: "ClientToken",
312
+ # }
313
+ #
314
+ # @!attribute [rw] configuration_set_name
315
+ # The name to use for the new configuration set.
316
+ # @return [String]
317
+ #
318
+ # @!attribute [rw] tags
319
+ # An array of key and value pair tags that's associated with the new
320
+ # configuration set.
321
+ # @return [Array<Types::Tag>]
322
+ #
323
+ # @!attribute [rw] client_token
324
+ # Unique, case-sensitive identifier that you provide to ensure the
325
+ # idempotency of the request. If you don't specify a client token, a
326
+ # randomly generated token is used for the request to ensure
327
+ # idempotency.
328
+ #
329
+ # **A suitable default value is auto-generated.** You should normally
330
+ # not need to pass this option.
331
+ # @return [String]
332
+ #
333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateConfigurationSetRequest AWS API Documentation
334
+ #
335
+ class CreateConfigurationSetRequest < Struct.new(
336
+ :configuration_set_name,
337
+ :tags,
338
+ :client_token)
339
+ SENSITIVE = []
340
+ include Aws::Structure
341
+ end
342
+
343
+ # @!attribute [rw] configuration_set_arn
344
+ # The Amazon Resource Name (ARN) of the newly created configuration
345
+ # set.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] configuration_set_name
349
+ # The name of the new configuration set.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] tags
353
+ # An array of key and value pair tags that's associated with the
354
+ # configuration set.
355
+ # @return [Array<Types::Tag>]
356
+ #
357
+ # @!attribute [rw] created_timestamp
358
+ # The time when the configuration set was created, in [UNIX epoch
359
+ # time][1] format.
360
+ #
361
+ #
362
+ #
363
+ # [1]: https://www.epochconverter.com/
364
+ # @return [Time]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateConfigurationSetResult AWS API Documentation
367
+ #
368
+ class CreateConfigurationSetResult < Struct.new(
369
+ :configuration_set_arn,
370
+ :configuration_set_name,
371
+ :tags,
372
+ :created_timestamp)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
377
+ # @note When making an API call, you may pass CreateEventDestinationRequest
378
+ # data as a hash:
379
+ #
380
+ # {
381
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
382
+ # event_destination_name: "EventDestinationName", # required
383
+ # matching_event_types: ["ALL"], # required, accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED
384
+ # cloud_watch_logs_destination: {
385
+ # iam_role_arn: "IamRoleArn", # required
386
+ # log_group_arn: "LogGroupArn", # required
387
+ # },
388
+ # kinesis_firehose_destination: {
389
+ # iam_role_arn: "IamRoleArn", # required
390
+ # delivery_stream_arn: "DeliveryStreamArn", # required
391
+ # },
392
+ # sns_destination: {
393
+ # topic_arn: "SnsTopicArn", # required
394
+ # },
395
+ # client_token: "ClientToken",
396
+ # }
397
+ #
398
+ # @!attribute [rw] configuration_set_name
399
+ # Either the name of the configuration set or the configuration set
400
+ # ARN to apply event logging to. The ConfigurateSetName and
401
+ # ConfigurationSetArn can be found using the DescribeConfigurationSets
402
+ # action.
403
+ # @return [String]
404
+ #
405
+ # @!attribute [rw] event_destination_name
406
+ # The name that identifies the event destination.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] matching_event_types
410
+ # An array of event types that determine which events to log. If
411
+ # "ALL" is used, then Amazon Pinpoint logs every event type.
412
+ # @return [Array<String>]
413
+ #
414
+ # @!attribute [rw] cloud_watch_logs_destination
415
+ # An object that contains information about an event destination for
416
+ # logging to Amazon CloudWatch logs.
417
+ # @return [Types::CloudWatchLogsDestination]
418
+ #
419
+ # @!attribute [rw] kinesis_firehose_destination
420
+ # An object that contains information about an event destination for
421
+ # logging to Amazon Kinesis Data Firehose.
422
+ # @return [Types::KinesisFirehoseDestination]
423
+ #
424
+ # @!attribute [rw] sns_destination
425
+ # An object that contains information about an event destination for
426
+ # logging to Amazon SNS.
427
+ # @return [Types::SnsDestination]
428
+ #
429
+ # @!attribute [rw] client_token
430
+ # Unique, case-sensitive identifier that you provide to ensure the
431
+ # idempotency of the request. If you don't specify a client token, a
432
+ # randomly generated token is used for the request to ensure
433
+ # idempotency.
434
+ #
435
+ # **A suitable default value is auto-generated.** You should normally
436
+ # not need to pass this option.
437
+ # @return [String]
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateEventDestinationRequest AWS API Documentation
440
+ #
441
+ class CreateEventDestinationRequest < Struct.new(
442
+ :configuration_set_name,
443
+ :event_destination_name,
444
+ :matching_event_types,
445
+ :cloud_watch_logs_destination,
446
+ :kinesis_firehose_destination,
447
+ :sns_destination,
448
+ :client_token)
449
+ SENSITIVE = []
450
+ include Aws::Structure
451
+ end
452
+
453
+ # @!attribute [rw] configuration_set_arn
454
+ # The ARN of the configuration set.
455
+ # @return [String]
456
+ #
457
+ # @!attribute [rw] configuration_set_name
458
+ # The name of the configuration set.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] event_destination
462
+ # The details of the destination where events are logged.
463
+ # @return [Types::EventDestination]
464
+ #
465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateEventDestinationResult AWS API Documentation
466
+ #
467
+ class CreateEventDestinationResult < Struct.new(
468
+ :configuration_set_arn,
469
+ :configuration_set_name,
470
+ :event_destination)
471
+ SENSITIVE = []
472
+ include Aws::Structure
473
+ end
474
+
475
+ # @note When making an API call, you may pass CreateOptOutListRequest
476
+ # data as a hash:
477
+ #
478
+ # {
479
+ # opt_out_list_name: "OptOutListName", # required
480
+ # tags: [
481
+ # {
482
+ # key: "TagKey", # required
483
+ # value: "TagValue", # required
484
+ # },
485
+ # ],
486
+ # client_token: "ClientToken",
487
+ # }
488
+ #
489
+ # @!attribute [rw] opt_out_list_name
490
+ # The name of the new OptOutList.
491
+ # @return [String]
492
+ #
493
+ # @!attribute [rw] tags
494
+ # An array of tags (key and value pairs) to associate with the new
495
+ # OptOutList.
496
+ # @return [Array<Types::Tag>]
497
+ #
498
+ # @!attribute [rw] client_token
499
+ # Unique, case-sensitive identifier that you provide to ensure the
500
+ # idempotency of the request. If you don't specify a client token, a
501
+ # randomly generated token is used for the request to ensure
502
+ # idempotency.
503
+ #
504
+ # **A suitable default value is auto-generated.** You should normally
505
+ # not need to pass this option.
506
+ # @return [String]
507
+ #
508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutListRequest AWS API Documentation
509
+ #
510
+ class CreateOptOutListRequest < Struct.new(
511
+ :opt_out_list_name,
512
+ :tags,
513
+ :client_token)
514
+ SENSITIVE = []
515
+ include Aws::Structure
516
+ end
517
+
518
+ # @!attribute [rw] opt_out_list_arn
519
+ # The Amazon Resource Name (ARN) for the OptOutList.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] opt_out_list_name
523
+ # The name of the new OptOutList.
524
+ # @return [String]
525
+ #
526
+ # @!attribute [rw] tags
527
+ # An array of tags (key and value pairs) associated with the new
528
+ # OptOutList.
529
+ # @return [Array<Types::Tag>]
530
+ #
531
+ # @!attribute [rw] created_timestamp
532
+ # The time when the pool was created, in [UNIX epoch time][1] format.
533
+ #
534
+ #
535
+ #
536
+ # [1]: https://www.epochconverter.com/
537
+ # @return [Time]
538
+ #
539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateOptOutListResult AWS API Documentation
540
+ #
541
+ class CreateOptOutListResult < Struct.new(
542
+ :opt_out_list_arn,
543
+ :opt_out_list_name,
544
+ :tags,
545
+ :created_timestamp)
546
+ SENSITIVE = []
547
+ include Aws::Structure
548
+ end
549
+
550
+ # @note When making an API call, you may pass CreatePoolRequest
551
+ # data as a hash:
552
+ #
553
+ # {
554
+ # origination_identity: "PhoneOrSenderIdOrArn", # required
555
+ # iso_country_code: "IsoCountryCode", # required
556
+ # message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
557
+ # deletion_protection_enabled: false,
558
+ # tags: [
559
+ # {
560
+ # key: "TagKey", # required
561
+ # value: "TagValue", # required
562
+ # },
563
+ # ],
564
+ # client_token: "ClientToken",
565
+ # }
566
+ #
567
+ # @!attribute [rw] origination_identity
568
+ # The origination identity to use such as a PhoneNumberId,
569
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
570
+ # DescribePhoneNumbers to find the values for PhoneNumberId and
571
+ # PhoneNumberArn while DescribeSenderIds can be used to get the values
572
+ # for SenderId and SenderIdArn.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] iso_country_code
576
+ # The new two-character code, in ISO 3166-1 alpha-2 format, for the
577
+ # country or region of the new pool.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] message_type
581
+ # The type of message. Valid values are TRANSACTIONAL for messages
582
+ # that are critical or time-sensitive and PROMOTIONAL for messages
583
+ # that aren't critical or time-sensitive.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] deletion_protection_enabled
587
+ # By default this is set to false. When set to true the pool can't be
588
+ # deleted. You can change this value using the UpdatePool action.
589
+ # @return [Boolean]
590
+ #
591
+ # @!attribute [rw] tags
592
+ # An array of tags (key and value pairs) associated with the pool.
593
+ # @return [Array<Types::Tag>]
594
+ #
595
+ # @!attribute [rw] client_token
596
+ # Unique, case-sensitive identifier that you provide to ensure the
597
+ # idempotency of the request. If you don't specify a client token, a
598
+ # randomly generated token is used for the request to ensure
599
+ # idempotency.
600
+ #
601
+ # **A suitable default value is auto-generated.** You should normally
602
+ # not need to pass this option.
603
+ # @return [String]
604
+ #
605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreatePoolRequest AWS API Documentation
606
+ #
607
+ class CreatePoolRequest < Struct.new(
608
+ :origination_identity,
609
+ :iso_country_code,
610
+ :message_type,
611
+ :deletion_protection_enabled,
612
+ :tags,
613
+ :client_token)
614
+ SENSITIVE = []
615
+ include Aws::Structure
616
+ end
617
+
618
+ # @!attribute [rw] pool_arn
619
+ # The Amazon Resource Name (ARN) for the pool.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] pool_id
623
+ # The unique identifier for the pool.
624
+ # @return [String]
625
+ #
626
+ # @!attribute [rw] status
627
+ # The current status of the pool.
628
+ #
629
+ # * CREATING: The pool is currently being created and isn't yet
630
+ # available for use.
631
+ #
632
+ # * ACTIVE: The pool is active and available for use.
633
+ #
634
+ # * DELETING: The pool is being deleted.
635
+ # @return [String]
636
+ #
637
+ # @!attribute [rw] message_type
638
+ # The type of message for the pool to use.
639
+ # @return [String]
640
+ #
641
+ # @!attribute [rw] two_way_enabled
642
+ # By default this is set to false. When set to true you can receive
643
+ # incoming text messages from your end recipients.
644
+ # @return [Boolean]
645
+ #
646
+ # @!attribute [rw] two_way_channel_arn
647
+ # The Amazon Resource Name (ARN) of the two way channel.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] self_managed_opt_outs_enabled
651
+ # By default this is set to false. When an end recipient sends a
652
+ # message that begins with HELP or STOP to one of your dedicated
653
+ # numbers, Amazon Pinpoint automatically replies with a customizable
654
+ # message and adds the end recipient to the OptOutList. When set to
655
+ # true you're responsible for responding to HELP and STOP requests.
656
+ # You're also responsible for tracking and honoring opt-out requests.
657
+ # @return [Boolean]
658
+ #
659
+ # @!attribute [rw] opt_out_list_name
660
+ # The name of the OptOutList associated with the pool.
661
+ # @return [String]
662
+ #
663
+ # @!attribute [rw] shared_routes_enabled
664
+ # Indicates whether shared routes are enabled for the pool.
665
+ # @return [Boolean]
666
+ #
667
+ # @!attribute [rw] deletion_protection_enabled
668
+ # When set to true deletion protection is enabled. By default this is
669
+ # set to false.
670
+ # @return [Boolean]
671
+ #
672
+ # @!attribute [rw] tags
673
+ # An array of tags (key and value pairs) associated with the pool.
674
+ # @return [Array<Types::Tag>]
675
+ #
676
+ # @!attribute [rw] created_timestamp
677
+ # The time when the pool was created, in [UNIX epoch time][1] format.
678
+ #
679
+ #
680
+ #
681
+ # [1]: https://www.epochconverter.com/
682
+ # @return [Time]
683
+ #
684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreatePoolResult AWS API Documentation
685
+ #
686
+ class CreatePoolResult < Struct.new(
687
+ :pool_arn,
688
+ :pool_id,
689
+ :status,
690
+ :message_type,
691
+ :two_way_enabled,
692
+ :two_way_channel_arn,
693
+ :self_managed_opt_outs_enabled,
694
+ :opt_out_list_name,
695
+ :shared_routes_enabled,
696
+ :deletion_protection_enabled,
697
+ :tags,
698
+ :created_timestamp)
699
+ SENSITIVE = []
700
+ include Aws::Structure
701
+ end
702
+
703
+ # @note When making an API call, you may pass DeleteConfigurationSetRequest
704
+ # data as a hash:
705
+ #
706
+ # {
707
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
708
+ # }
709
+ #
710
+ # @!attribute [rw] configuration_set_name
711
+ # The name of the configuration set or the configuration set ARN that
712
+ # you want to delete. The ConfigurationSetName and ConfigurationSetArn
713
+ # can be found using the DescribeConfigurationSets action.
714
+ # @return [String]
715
+ #
716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteConfigurationSetRequest AWS API Documentation
717
+ #
718
+ class DeleteConfigurationSetRequest < Struct.new(
719
+ :configuration_set_name)
720
+ SENSITIVE = []
721
+ include Aws::Structure
722
+ end
723
+
724
+ # @!attribute [rw] configuration_set_arn
725
+ # The Amazon Resource Name (ARN) of the deleted configuration set.
726
+ # @return [String]
727
+ #
728
+ # @!attribute [rw] configuration_set_name
729
+ # The name of the deleted configuration set.
730
+ # @return [String]
731
+ #
732
+ # @!attribute [rw] event_destinations
733
+ # An array of any EventDestination objects that were associated with
734
+ # the deleted configuration set.
735
+ # @return [Array<Types::EventDestination>]
736
+ #
737
+ # @!attribute [rw] default_message_type
738
+ # The default message type of the configuration set that was deleted.
739
+ # @return [String]
740
+ #
741
+ # @!attribute [rw] default_sender_id
742
+ # The default Sender ID of the configuration set that was deleted.
743
+ # @return [String]
744
+ #
745
+ # @!attribute [rw] created_timestamp
746
+ # The time that the deleted configuration set was created in [UNIX
747
+ # epoch time][1] format.
748
+ #
749
+ #
750
+ #
751
+ # [1]: https://www.epochconverter.com/
752
+ # @return [Time]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteConfigurationSetResult AWS API Documentation
755
+ #
756
+ class DeleteConfigurationSetResult < Struct.new(
757
+ :configuration_set_arn,
758
+ :configuration_set_name,
759
+ :event_destinations,
760
+ :default_message_type,
761
+ :default_sender_id,
762
+ :created_timestamp)
763
+ SENSITIVE = []
764
+ include Aws::Structure
765
+ end
766
+
767
+ # @note When making an API call, you may pass DeleteDefaultMessageTypeRequest
768
+ # data as a hash:
769
+ #
770
+ # {
771
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
772
+ # }
773
+ #
774
+ # @!attribute [rw] configuration_set_name
775
+ # The name of the configuration set or the configuration set Amazon
776
+ # Resource Name (ARN) to delete the default message type from. The
777
+ # ConfigurationSetName and ConfigurationSetArn can be found using the
778
+ # DescribeConfigurationSets action.
779
+ # @return [String]
780
+ #
781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultMessageTypeRequest AWS API Documentation
782
+ #
783
+ class DeleteDefaultMessageTypeRequest < Struct.new(
784
+ :configuration_set_name)
785
+ SENSITIVE = []
786
+ include Aws::Structure
787
+ end
788
+
789
+ # @!attribute [rw] configuration_set_arn
790
+ # The Amazon Resource Name (ARN) of the configuration set.
791
+ # @return [String]
792
+ #
793
+ # @!attribute [rw] configuration_set_name
794
+ # The name of the configuration set.
795
+ # @return [String]
796
+ #
797
+ # @!attribute [rw] message_type
798
+ # The current message type for the configuration set.
799
+ # @return [String]
800
+ #
801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultMessageTypeResult AWS API Documentation
802
+ #
803
+ class DeleteDefaultMessageTypeResult < Struct.new(
804
+ :configuration_set_arn,
805
+ :configuration_set_name,
806
+ :message_type)
807
+ SENSITIVE = []
808
+ include Aws::Structure
809
+ end
810
+
811
+ # @note When making an API call, you may pass DeleteDefaultSenderIdRequest
812
+ # data as a hash:
813
+ #
814
+ # {
815
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
816
+ # }
817
+ #
818
+ # @!attribute [rw] configuration_set_name
819
+ # The name of the configuration set or the configuration set Amazon
820
+ # Resource Name (ARN) to delete the default sender ID from. The
821
+ # ConfigurationSetName and ConfigurationSetArn can be found using the
822
+ # DescribeConfigurationSets action.
823
+ # @return [String]
824
+ #
825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultSenderIdRequest AWS API Documentation
826
+ #
827
+ class DeleteDefaultSenderIdRequest < Struct.new(
828
+ :configuration_set_name)
829
+ SENSITIVE = []
830
+ include Aws::Structure
831
+ end
832
+
833
+ # @!attribute [rw] configuration_set_arn
834
+ # The Amazon Resource Name (ARN) of the configuration set.
835
+ # @return [String]
836
+ #
837
+ # @!attribute [rw] configuration_set_name
838
+ # The name of the configuration set.
839
+ # @return [String]
840
+ #
841
+ # @!attribute [rw] sender_id
842
+ # The current sender ID for the configuration set.
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteDefaultSenderIdResult AWS API Documentation
846
+ #
847
+ class DeleteDefaultSenderIdResult < Struct.new(
848
+ :configuration_set_arn,
849
+ :configuration_set_name,
850
+ :sender_id)
851
+ SENSITIVE = []
852
+ include Aws::Structure
853
+ end
854
+
855
+ # @note When making an API call, you may pass DeleteEventDestinationRequest
856
+ # data as a hash:
857
+ #
858
+ # {
859
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
860
+ # event_destination_name: "EventDestinationName", # required
861
+ # }
862
+ #
863
+ # @!attribute [rw] configuration_set_name
864
+ # The name of the configuration set or the configuration set's Amazon
865
+ # Resource Name (ARN) to remove the event destination from. The
866
+ # ConfigurateSetName and ConfigurationSetArn can be found using the
867
+ # DescribeConfigurationSets action.
868
+ # @return [String]
869
+ #
870
+ # @!attribute [rw] event_destination_name
871
+ # The name of the event destination to delete.
872
+ # @return [String]
873
+ #
874
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteEventDestinationRequest AWS API Documentation
875
+ #
876
+ class DeleteEventDestinationRequest < Struct.new(
877
+ :configuration_set_name,
878
+ :event_destination_name)
879
+ SENSITIVE = []
880
+ include Aws::Structure
881
+ end
882
+
883
+ # @!attribute [rw] configuration_set_arn
884
+ # The Amazon Resource Name (ARN) of the configuration set.
885
+ # @return [String]
886
+ #
887
+ # @!attribute [rw] configuration_set_name
888
+ # The name of the configuration set the event destination was deleted
889
+ # from.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] event_destination
893
+ # The event destination object that was deleted.
894
+ # @return [Types::EventDestination]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteEventDestinationResult AWS API Documentation
897
+ #
898
+ class DeleteEventDestinationResult < Struct.new(
899
+ :configuration_set_arn,
900
+ :configuration_set_name,
901
+ :event_destination)
902
+ SENSITIVE = []
903
+ include Aws::Structure
904
+ end
905
+
906
+ # @note When making an API call, you may pass DeleteKeywordRequest
907
+ # data as a hash:
908
+ #
909
+ # {
910
+ # origination_identity: "PhoneOrPoolIdOrArn", # required
911
+ # keyword: "Keyword", # required
912
+ # }
913
+ #
914
+ # @!attribute [rw] origination_identity
915
+ # The origination identity to use such as a PhoneNumberId,
916
+ # PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers
917
+ # to find the values for PhoneNumberId and PhoneNumberArn and
918
+ # DescribePools to find the values of PoolId and PoolArn.
919
+ # @return [String]
920
+ #
921
+ # @!attribute [rw] keyword
922
+ # The keyword to delete.
923
+ # @return [String]
924
+ #
925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteKeywordRequest AWS API Documentation
926
+ #
927
+ class DeleteKeywordRequest < Struct.new(
928
+ :origination_identity,
929
+ :keyword)
930
+ SENSITIVE = []
931
+ include Aws::Structure
932
+ end
933
+
934
+ # @!attribute [rw] origination_identity_arn
935
+ # The PhoneNumberArn or PoolArn that the keyword was associated with.
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] origination_identity
939
+ # The PhoneNumberId or PoolId that the keyword was associated with.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] keyword
943
+ # The keyword that was deleted.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] keyword_message
947
+ # The message that was associated with the deleted keyword.
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] keyword_action
951
+ # The action that was associated with the deleted keyword.
952
+ # @return [String]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteKeywordResult AWS API Documentation
955
+ #
956
+ class DeleteKeywordResult < Struct.new(
957
+ :origination_identity_arn,
958
+ :origination_identity,
959
+ :keyword,
960
+ :keyword_message,
961
+ :keyword_action)
962
+ SENSITIVE = []
963
+ include Aws::Structure
964
+ end
965
+
966
+ # @note When making an API call, you may pass DeleteOptOutListRequest
967
+ # data as a hash:
968
+ #
969
+ # {
970
+ # opt_out_list_name: "OptOutListNameOrArn", # required
971
+ # }
972
+ #
973
+ # @!attribute [rw] opt_out_list_name
974
+ # The OptOutListName or OptOutListArn of the OptOutList to delete. You
975
+ # can use DescribeOptOutLists to find the values for OptOutListName
976
+ # and OptOutListArn.
977
+ # @return [String]
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutListRequest AWS API Documentation
980
+ #
981
+ class DeleteOptOutListRequest < Struct.new(
982
+ :opt_out_list_name)
983
+ SENSITIVE = []
984
+ include Aws::Structure
985
+ end
986
+
987
+ # @!attribute [rw] opt_out_list_arn
988
+ # The Amazon Resource Name (ARN) of the OptOutList that was removed.
989
+ # @return [String]
990
+ #
991
+ # @!attribute [rw] opt_out_list_name
992
+ # The name of the OptOutList that was removed.
993
+ # @return [String]
994
+ #
995
+ # @!attribute [rw] created_timestamp
996
+ # The time when the OptOutList was created, in [UNIX epoch time][1]
997
+ # format.
998
+ #
999
+ #
1000
+ #
1001
+ # [1]: https://www.epochconverter.com/
1002
+ # @return [Time]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutListResult AWS API Documentation
1005
+ #
1006
+ class DeleteOptOutListResult < Struct.new(
1007
+ :opt_out_list_arn,
1008
+ :opt_out_list_name,
1009
+ :created_timestamp)
1010
+ SENSITIVE = []
1011
+ include Aws::Structure
1012
+ end
1013
+
1014
+ # @note When making an API call, you may pass DeleteOptedOutNumberRequest
1015
+ # data as a hash:
1016
+ #
1017
+ # {
1018
+ # opt_out_list_name: "OptOutListNameOrArn", # required
1019
+ # opted_out_number: "PhoneNumber", # required
1020
+ # }
1021
+ #
1022
+ # @!attribute [rw] opt_out_list_name
1023
+ # The OptOutListName or OptOutListArn to remove the phone number from.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] opted_out_number
1027
+ # The phone number, in E.164 format, to remove from the OptOutList.
1028
+ # @return [String]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptedOutNumberRequest AWS API Documentation
1031
+ #
1032
+ class DeleteOptedOutNumberRequest < Struct.new(
1033
+ :opt_out_list_name,
1034
+ :opted_out_number)
1035
+ SENSITIVE = []
1036
+ include Aws::Structure
1037
+ end
1038
+
1039
+ # @!attribute [rw] opt_out_list_arn
1040
+ # The OptOutListArn that the phone number was removed from.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] opt_out_list_name
1044
+ # The OptOutListName that the phone number was removed from.
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] opted_out_number
1048
+ # The phone number that was removed from the OptOutList.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] opted_out_timestamp
1052
+ # The time that the number was removed at, in [UNIX epoch time][1]
1053
+ # format.
1054
+ #
1055
+ #
1056
+ #
1057
+ # [1]: https://www.epochconverter.com/
1058
+ # @return [Time]
1059
+ #
1060
+ # @!attribute [rw] end_user_opted_out
1061
+ # This is true if it was the end user who requested their phone number
1062
+ # be removed.
1063
+ # @return [Boolean]
1064
+ #
1065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptedOutNumberResult AWS API Documentation
1066
+ #
1067
+ class DeleteOptedOutNumberResult < Struct.new(
1068
+ :opt_out_list_arn,
1069
+ :opt_out_list_name,
1070
+ :opted_out_number,
1071
+ :opted_out_timestamp,
1072
+ :end_user_opted_out)
1073
+ SENSITIVE = []
1074
+ include Aws::Structure
1075
+ end
1076
+
1077
+ # @note When making an API call, you may pass DeletePoolRequest
1078
+ # data as a hash:
1079
+ #
1080
+ # {
1081
+ # pool_id: "PoolIdOrArn", # required
1082
+ # }
1083
+ #
1084
+ # @!attribute [rw] pool_id
1085
+ # The PoolId or PoolArn of the pool to delete. You can use
1086
+ # DescribePools to find the values for PoolId and PoolArn .
1087
+ # @return [String]
1088
+ #
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeletePoolRequest AWS API Documentation
1090
+ #
1091
+ class DeletePoolRequest < Struct.new(
1092
+ :pool_id)
1093
+ SENSITIVE = []
1094
+ include Aws::Structure
1095
+ end
1096
+
1097
+ # @!attribute [rw] pool_arn
1098
+ # The Amazon Resource Name (ARN) of the pool that was deleted.
1099
+ # @return [String]
1100
+ #
1101
+ # @!attribute [rw] pool_id
1102
+ # The PoolId of the pool that was deleted.
1103
+ # @return [String]
1104
+ #
1105
+ # @!attribute [rw] status
1106
+ # The current status of the pool.
1107
+ #
1108
+ # * CREATING: The pool is currently being created and isn't yet
1109
+ # available for use.
1110
+ #
1111
+ # * ACTIVE: The pool is active and available for use.
1112
+ #
1113
+ # * DELETING: The pool is being deleted.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] message_type
1117
+ # The message type that was associated with the deleted pool.
1118
+ # @return [String]
1119
+ #
1120
+ # @!attribute [rw] two_way_enabled
1121
+ # By default this is set to false. When set to true you can receive
1122
+ # incoming text messages from your end recipients.
1123
+ # @return [Boolean]
1124
+ #
1125
+ # @!attribute [rw] two_way_channel_arn
1126
+ # The Amazon Resource Name (ARN) of the TwoWayChannel.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] self_managed_opt_outs_enabled
1130
+ # By default this is set to false. When an end recipient sends a
1131
+ # message that begins with HELP or STOP to one of your dedicated
1132
+ # numbers, Amazon Pinpoint automatically replies with a customizable
1133
+ # message and adds the end recipient to the OptOutList. When set to
1134
+ # true you're responsible for responding to HELP and STOP requests.
1135
+ # You're also responsible for tracking and honoring opt-out requests.
1136
+ # @return [Boolean]
1137
+ #
1138
+ # @!attribute [rw] opt_out_list_name
1139
+ # The name of the OptOutList that was associated with the deleted
1140
+ # pool.
1141
+ # @return [String]
1142
+ #
1143
+ # @!attribute [rw] shared_routes_enabled
1144
+ # Indicates whether shared routes are enabled for the pool.
1145
+ # @return [Boolean]
1146
+ #
1147
+ # @!attribute [rw] created_timestamp
1148
+ # The time when the pool was created, in [UNIX epoch time][1] format.
1149
+ #
1150
+ #
1151
+ #
1152
+ # [1]: https://www.epochconverter.com/
1153
+ # @return [Time]
1154
+ #
1155
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeletePoolResult AWS API Documentation
1156
+ #
1157
+ class DeletePoolResult < Struct.new(
1158
+ :pool_arn,
1159
+ :pool_id,
1160
+ :status,
1161
+ :message_type,
1162
+ :two_way_enabled,
1163
+ :two_way_channel_arn,
1164
+ :self_managed_opt_outs_enabled,
1165
+ :opt_out_list_name,
1166
+ :shared_routes_enabled,
1167
+ :created_timestamp)
1168
+ SENSITIVE = []
1169
+ include Aws::Structure
1170
+ end
1171
+
1172
+ # @api private
1173
+ #
1174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteTextMessageSpendLimitOverrideRequest AWS API Documentation
1175
+ #
1176
+ class DeleteTextMessageSpendLimitOverrideRequest < Aws::EmptyStructure; end
1177
+
1178
+ # @!attribute [rw] monthly_limit
1179
+ # The current monthly limit, in US dollars.
1180
+ # @return [Integer]
1181
+ #
1182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteTextMessageSpendLimitOverrideResult AWS API Documentation
1183
+ #
1184
+ class DeleteTextMessageSpendLimitOverrideResult < Struct.new(
1185
+ :monthly_limit)
1186
+ SENSITIVE = []
1187
+ include Aws::Structure
1188
+ end
1189
+
1190
+ # @api private
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVoiceMessageSpendLimitOverrideRequest AWS API Documentation
1193
+ #
1194
+ class DeleteVoiceMessageSpendLimitOverrideRequest < Aws::EmptyStructure; end
1195
+
1196
+ # @!attribute [rw] monthly_limit
1197
+ # The current monthly limit, in US dollars.
1198
+ # @return [Integer]
1199
+ #
1200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteVoiceMessageSpendLimitOverrideResult AWS API Documentation
1201
+ #
1202
+ class DeleteVoiceMessageSpendLimitOverrideResult < Struct.new(
1203
+ :monthly_limit)
1204
+ SENSITIVE = []
1205
+ include Aws::Structure
1206
+ end
1207
+
1208
+ # @note When making an API call, you may pass DescribeAccountAttributesRequest
1209
+ # data as a hash:
1210
+ #
1211
+ # {
1212
+ # next_token: "NextToken",
1213
+ # max_results: 1,
1214
+ # }
1215
+ #
1216
+ # @!attribute [rw] next_token
1217
+ # The token to be used for the next set of paginated results. You
1218
+ # don't need to supply a value for this field in the initial request.
1219
+ # @return [String]
1220
+ #
1221
+ # @!attribute [rw] max_results
1222
+ # The maximum number of results to return per each request.
1223
+ # @return [Integer]
1224
+ #
1225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountAttributesRequest AWS API Documentation
1226
+ #
1227
+ class DescribeAccountAttributesRequest < Struct.new(
1228
+ :next_token,
1229
+ :max_results)
1230
+ SENSITIVE = []
1231
+ include Aws::Structure
1232
+ end
1233
+
1234
+ # @!attribute [rw] account_attributes
1235
+ # An array of AccountAttributes objects.
1236
+ # @return [Array<Types::AccountAttribute>]
1237
+ #
1238
+ # @!attribute [rw] next_token
1239
+ # The token to be used for the next set of paginated results. If this
1240
+ # field is empty then there are no more results.
1241
+ # @return [String]
1242
+ #
1243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountAttributesResult AWS API Documentation
1244
+ #
1245
+ class DescribeAccountAttributesResult < Struct.new(
1246
+ :account_attributes,
1247
+ :next_token)
1248
+ SENSITIVE = []
1249
+ include Aws::Structure
1250
+ end
1251
+
1252
+ # @note When making an API call, you may pass DescribeAccountLimitsRequest
1253
+ # data as a hash:
1254
+ #
1255
+ # {
1256
+ # next_token: "NextToken",
1257
+ # max_results: 1,
1258
+ # }
1259
+ #
1260
+ # @!attribute [rw] next_token
1261
+ # The token to be used for the next set of paginated results. You
1262
+ # don't need to supply a value for this field in the initial request.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] max_results
1266
+ # The maximum number of results to return per each request.
1267
+ # @return [Integer]
1268
+ #
1269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountLimitsRequest AWS API Documentation
1270
+ #
1271
+ class DescribeAccountLimitsRequest < Struct.new(
1272
+ :next_token,
1273
+ :max_results)
1274
+ SENSITIVE = []
1275
+ include Aws::Structure
1276
+ end
1277
+
1278
+ # @!attribute [rw] account_limits
1279
+ # An array of AccountLimit objects that show the current spend limits.
1280
+ # @return [Array<Types::AccountLimit>]
1281
+ #
1282
+ # @!attribute [rw] next_token
1283
+ # The token to be used for the next set of paginated results. If this
1284
+ # field is empty then there are no more results.
1285
+ # @return [String]
1286
+ #
1287
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeAccountLimitsResult AWS API Documentation
1288
+ #
1289
+ class DescribeAccountLimitsResult < Struct.new(
1290
+ :account_limits,
1291
+ :next_token)
1292
+ SENSITIVE = []
1293
+ include Aws::Structure
1294
+ end
1295
+
1296
+ # @note When making an API call, you may pass DescribeConfigurationSetsRequest
1297
+ # data as a hash:
1298
+ #
1299
+ # {
1300
+ # configuration_set_names: ["ConfigurationSetNameOrArn"],
1301
+ # filters: [
1302
+ # {
1303
+ # name: "event-destination-name", # required, accepts event-destination-name, matching-event-types, default-message-type, default-sender-id
1304
+ # values: ["FilterValue"], # required
1305
+ # },
1306
+ # ],
1307
+ # next_token: "NextToken",
1308
+ # max_results: 1,
1309
+ # }
1310
+ #
1311
+ # @!attribute [rw] configuration_set_names
1312
+ # An array of strings. Each element can be either a
1313
+ # ConfigurationSetName or ConfigurationSetArn.
1314
+ # @return [Array<String>]
1315
+ #
1316
+ # @!attribute [rw] filters
1317
+ # An array of filters to apply to the results that are returned.
1318
+ # @return [Array<Types::ConfigurationSetFilter>]
1319
+ #
1320
+ # @!attribute [rw] next_token
1321
+ # The token to be used for the next set of paginated results. You
1322
+ # don't need to supply a value for this field in the initial request.
1323
+ # @return [String]
1324
+ #
1325
+ # @!attribute [rw] max_results
1326
+ # The maximum number of results to return per each request.
1327
+ # @return [Integer]
1328
+ #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeConfigurationSetsRequest AWS API Documentation
1330
+ #
1331
+ class DescribeConfigurationSetsRequest < Struct.new(
1332
+ :configuration_set_names,
1333
+ :filters,
1334
+ :next_token,
1335
+ :max_results)
1336
+ SENSITIVE = []
1337
+ include Aws::Structure
1338
+ end
1339
+
1340
+ # @!attribute [rw] configuration_sets
1341
+ # An array of ConfigurationSets objects.
1342
+ # @return [Array<Types::ConfigurationSetInformation>]
1343
+ #
1344
+ # @!attribute [rw] next_token
1345
+ # The token to be used for the next set of paginated results. If this
1346
+ # field is empty then there are no more results.
1347
+ # @return [String]
1348
+ #
1349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeConfigurationSetsResult AWS API Documentation
1350
+ #
1351
+ class DescribeConfigurationSetsResult < Struct.new(
1352
+ :configuration_sets,
1353
+ :next_token)
1354
+ SENSITIVE = []
1355
+ include Aws::Structure
1356
+ end
1357
+
1358
+ # @note When making an API call, you may pass DescribeKeywordsRequest
1359
+ # data as a hash:
1360
+ #
1361
+ # {
1362
+ # origination_identity: "PhoneOrPoolIdOrArn", # required
1363
+ # keywords: ["Keyword"],
1364
+ # filters: [
1365
+ # {
1366
+ # name: "keyword-action", # required, accepts keyword-action
1367
+ # values: ["FilterValue"], # required
1368
+ # },
1369
+ # ],
1370
+ # next_token: "NextToken",
1371
+ # max_results: 1,
1372
+ # }
1373
+ #
1374
+ # @!attribute [rw] origination_identity
1375
+ # The origination identity to use such as a PhoneNumberId,
1376
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
1377
+ # DescribePhoneNumbers to find the values for PhoneNumberId and
1378
+ # PhoneNumberArn while DescribeSenderIds can be used to get the values
1379
+ # for SenderId and SenderIdArn.
1380
+ # @return [String]
1381
+ #
1382
+ # @!attribute [rw] keywords
1383
+ # An array of keywords to search for.
1384
+ # @return [Array<String>]
1385
+ #
1386
+ # @!attribute [rw] filters
1387
+ # An array of keyword filters to filter the results.
1388
+ # @return [Array<Types::KeywordFilter>]
1389
+ #
1390
+ # @!attribute [rw] next_token
1391
+ # The token to be used for the next set of paginated results. You
1392
+ # don't need to supply a value for this field in the initial request.
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] max_results
1396
+ # The maximum number of results to return per each request.
1397
+ # @return [Integer]
1398
+ #
1399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeKeywordsRequest AWS API Documentation
1400
+ #
1401
+ class DescribeKeywordsRequest < Struct.new(
1402
+ :origination_identity,
1403
+ :keywords,
1404
+ :filters,
1405
+ :next_token,
1406
+ :max_results)
1407
+ SENSITIVE = []
1408
+ include Aws::Structure
1409
+ end
1410
+
1411
+ # @!attribute [rw] origination_identity_arn
1412
+ # The PhoneNumberArn or PoolArn that is associated with the
1413
+ # OriginationIdentity.
1414
+ # @return [String]
1415
+ #
1416
+ # @!attribute [rw] origination_identity
1417
+ # The PhoneNumberId or PoolId that is associated with the
1418
+ # OriginationIdentity.
1419
+ # @return [String]
1420
+ #
1421
+ # @!attribute [rw] keywords
1422
+ # An array of KeywordInformation objects that contain the results.
1423
+ # @return [Array<Types::KeywordInformation>]
1424
+ #
1425
+ # @!attribute [rw] next_token
1426
+ # The token to be used for the next set of paginated results. If this
1427
+ # field is empty then there are no more results.
1428
+ # @return [String]
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeKeywordsResult AWS API Documentation
1431
+ #
1432
+ class DescribeKeywordsResult < Struct.new(
1433
+ :origination_identity_arn,
1434
+ :origination_identity,
1435
+ :keywords,
1436
+ :next_token)
1437
+ SENSITIVE = []
1438
+ include Aws::Structure
1439
+ end
1440
+
1441
+ # @note When making an API call, you may pass DescribeOptOutListsRequest
1442
+ # data as a hash:
1443
+ #
1444
+ # {
1445
+ # opt_out_list_names: ["OptOutListNameOrArn"],
1446
+ # next_token: "NextToken",
1447
+ # max_results: 1,
1448
+ # }
1449
+ #
1450
+ # @!attribute [rw] opt_out_list_names
1451
+ # The OptOutLists to show the details of. This is an array of strings
1452
+ # that can be either the OptOutListName or OptOutListArn.
1453
+ # @return [Array<String>]
1454
+ #
1455
+ # @!attribute [rw] next_token
1456
+ # The token to be used for the next set of paginated results. You
1457
+ # don't need to supply a value for this field in the initial request.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] max_results
1461
+ # The maximum number of results to return per each request.
1462
+ # @return [Integer]
1463
+ #
1464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutListsRequest AWS API Documentation
1465
+ #
1466
+ class DescribeOptOutListsRequest < Struct.new(
1467
+ :opt_out_list_names,
1468
+ :next_token,
1469
+ :max_results)
1470
+ SENSITIVE = []
1471
+ include Aws::Structure
1472
+ end
1473
+
1474
+ # @!attribute [rw] opt_out_lists
1475
+ # An array of OptOutListInformation objects that contain the details
1476
+ # for the requested OptOutLists.
1477
+ # @return [Array<Types::OptOutListInformation>]
1478
+ #
1479
+ # @!attribute [rw] next_token
1480
+ # The token to be used for the next set of paginated results. If this
1481
+ # field is empty then there are no more results.
1482
+ # @return [String]
1483
+ #
1484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptOutListsResult AWS API Documentation
1485
+ #
1486
+ class DescribeOptOutListsResult < Struct.new(
1487
+ :opt_out_lists,
1488
+ :next_token)
1489
+ SENSITIVE = []
1490
+ include Aws::Structure
1491
+ end
1492
+
1493
+ # @note When making an API call, you may pass DescribeOptedOutNumbersRequest
1494
+ # data as a hash:
1495
+ #
1496
+ # {
1497
+ # opt_out_list_name: "OptOutListNameOrArn", # required
1498
+ # opted_out_numbers: ["PhoneNumber"],
1499
+ # filters: [
1500
+ # {
1501
+ # name: "end-user-opted-out", # required, accepts end-user-opted-out
1502
+ # values: ["FilterValue"], # required
1503
+ # },
1504
+ # ],
1505
+ # next_token: "NextToken",
1506
+ # max_results: 1,
1507
+ # }
1508
+ #
1509
+ # @!attribute [rw] opt_out_list_name
1510
+ # The OptOutListName or OptOutListArn of the OptOutList. You can use
1511
+ # DescribeOptOutLists to find the values for OptOutListName and
1512
+ # OptOutListArn.
1513
+ # @return [String]
1514
+ #
1515
+ # @!attribute [rw] opted_out_numbers
1516
+ # An array of phone numbers to search for in the OptOutList.
1517
+ # @return [Array<String>]
1518
+ #
1519
+ # @!attribute [rw] filters
1520
+ # An array of OptedOutFilter objects to filter the results on.
1521
+ # @return [Array<Types::OptedOutFilter>]
1522
+ #
1523
+ # @!attribute [rw] next_token
1524
+ # The token to be used for the next set of paginated results. You
1525
+ # don't need to supply a value for this field in the initial request.
1526
+ # @return [String]
1527
+ #
1528
+ # @!attribute [rw] max_results
1529
+ # The maximum number of results to return per each request.
1530
+ # @return [Integer]
1531
+ #
1532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptedOutNumbersRequest AWS API Documentation
1533
+ #
1534
+ class DescribeOptedOutNumbersRequest < Struct.new(
1535
+ :opt_out_list_name,
1536
+ :opted_out_numbers,
1537
+ :filters,
1538
+ :next_token,
1539
+ :max_results)
1540
+ SENSITIVE = []
1541
+ include Aws::Structure
1542
+ end
1543
+
1544
+ # @!attribute [rw] opt_out_list_arn
1545
+ # The Amazon Resource Name (ARN) of the OptOutList.
1546
+ # @return [String]
1547
+ #
1548
+ # @!attribute [rw] opt_out_list_name
1549
+ # The name of the OptOutList.
1550
+ # @return [String]
1551
+ #
1552
+ # @!attribute [rw] opted_out_numbers
1553
+ # An array of OptedOutNumbersInformation objects that provide
1554
+ # information about the requested OptedOutNumbers.
1555
+ # @return [Array<Types::OptedOutNumberInformation>]
1556
+ #
1557
+ # @!attribute [rw] next_token
1558
+ # The token to be used for the next set of paginated results. If this
1559
+ # field is empty then there are no more results.
1560
+ # @return [String]
1561
+ #
1562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeOptedOutNumbersResult AWS API Documentation
1563
+ #
1564
+ class DescribeOptedOutNumbersResult < Struct.new(
1565
+ :opt_out_list_arn,
1566
+ :opt_out_list_name,
1567
+ :opted_out_numbers,
1568
+ :next_token)
1569
+ SENSITIVE = []
1570
+ include Aws::Structure
1571
+ end
1572
+
1573
+ # @note When making an API call, you may pass DescribePhoneNumbersRequest
1574
+ # data as a hash:
1575
+ #
1576
+ # {
1577
+ # phone_number_ids: ["PhoneNumberIdOrArn"],
1578
+ # filters: [
1579
+ # {
1580
+ # name: "status", # required, accepts status, iso-country-code, message-type, number-capability, number-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, deletion-protection-enabled
1581
+ # values: ["FilterValue"], # required
1582
+ # },
1583
+ # ],
1584
+ # next_token: "NextToken",
1585
+ # max_results: 1,
1586
+ # }
1587
+ #
1588
+ # @!attribute [rw] phone_number_ids
1589
+ # The unique identifier of phone numbers to find information about.
1590
+ # This is an array of strings that can be either the PhoneNumberId or
1591
+ # PhoneNumberArn.
1592
+ # @return [Array<String>]
1593
+ #
1594
+ # @!attribute [rw] filters
1595
+ # An array of PhoneNumberFilter objects to filter the results.
1596
+ # @return [Array<Types::PhoneNumberFilter>]
1597
+ #
1598
+ # @!attribute [rw] next_token
1599
+ # The token to be used for the next set of paginated results. You
1600
+ # don't need to supply a value for this field in the initial request.
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] max_results
1604
+ # The maximum number of results to return per each request.
1605
+ # @return [Integer]
1606
+ #
1607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePhoneNumbersRequest AWS API Documentation
1608
+ #
1609
+ class DescribePhoneNumbersRequest < Struct.new(
1610
+ :phone_number_ids,
1611
+ :filters,
1612
+ :next_token,
1613
+ :max_results)
1614
+ SENSITIVE = []
1615
+ include Aws::Structure
1616
+ end
1617
+
1618
+ # @!attribute [rw] phone_numbers
1619
+ # An array of PhoneNumberInformation objects that contain the details
1620
+ # for the requested phone numbers.
1621
+ # @return [Array<Types::PhoneNumberInformation>]
1622
+ #
1623
+ # @!attribute [rw] next_token
1624
+ # The token to be used for the next set of paginated results. If this
1625
+ # field is empty then there are no more results.
1626
+ # @return [String]
1627
+ #
1628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePhoneNumbersResult AWS API Documentation
1629
+ #
1630
+ class DescribePhoneNumbersResult < Struct.new(
1631
+ :phone_numbers,
1632
+ :next_token)
1633
+ SENSITIVE = []
1634
+ include Aws::Structure
1635
+ end
1636
+
1637
+ # @note When making an API call, you may pass DescribePoolsRequest
1638
+ # data as a hash:
1639
+ #
1640
+ # {
1641
+ # pool_ids: ["PoolIdOrArn"],
1642
+ # filters: [
1643
+ # {
1644
+ # name: "status", # required, accepts status, message-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, shared-routes-enabled, deletion-protection-enabled
1645
+ # values: ["FilterValue"], # required
1646
+ # },
1647
+ # ],
1648
+ # next_token: "NextToken",
1649
+ # max_results: 1,
1650
+ # }
1651
+ #
1652
+ # @!attribute [rw] pool_ids
1653
+ # The unique identifier of pools to find. This is an array of strings
1654
+ # that can be either the PoolId or PoolArn.
1655
+ # @return [Array<String>]
1656
+ #
1657
+ # @!attribute [rw] filters
1658
+ # An array of PoolFilter objects to filter the results.
1659
+ # @return [Array<Types::PoolFilter>]
1660
+ #
1661
+ # @!attribute [rw] next_token
1662
+ # The token to be used for the next set of paginated results. You
1663
+ # don't need to supply a value for this field in the initial request.
1664
+ # @return [String]
1665
+ #
1666
+ # @!attribute [rw] max_results
1667
+ # The maximum number of results to return per each request.
1668
+ # @return [Integer]
1669
+ #
1670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePoolsRequest AWS API Documentation
1671
+ #
1672
+ class DescribePoolsRequest < Struct.new(
1673
+ :pool_ids,
1674
+ :filters,
1675
+ :next_token,
1676
+ :max_results)
1677
+ SENSITIVE = []
1678
+ include Aws::Structure
1679
+ end
1680
+
1681
+ # @!attribute [rw] pools
1682
+ # An array of PoolInformation objects that contain the details for the
1683
+ # requested pools.
1684
+ # @return [Array<Types::PoolInformation>]
1685
+ #
1686
+ # @!attribute [rw] next_token
1687
+ # The token to be used for the next set of paginated results. If this
1688
+ # field is empty then there are no more results.
1689
+ # @return [String]
1690
+ #
1691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribePoolsResult AWS API Documentation
1692
+ #
1693
+ class DescribePoolsResult < Struct.new(
1694
+ :pools,
1695
+ :next_token)
1696
+ SENSITIVE = []
1697
+ include Aws::Structure
1698
+ end
1699
+
1700
+ # @note When making an API call, you may pass DescribeSenderIdsRequest
1701
+ # data as a hash:
1702
+ #
1703
+ # {
1704
+ # sender_ids: [
1705
+ # {
1706
+ # sender_id: "SenderIdOrArn", # required
1707
+ # iso_country_code: "IsoCountryCode", # required
1708
+ # },
1709
+ # ],
1710
+ # filters: [
1711
+ # {
1712
+ # name: "sender-id", # required, accepts sender-id, iso-country-code, message-type
1713
+ # values: ["FilterValue"], # required
1714
+ # },
1715
+ # ],
1716
+ # next_token: "NextToken",
1717
+ # max_results: 1,
1718
+ # }
1719
+ #
1720
+ # @!attribute [rw] sender_ids
1721
+ # An array of SenderIdAndCountry objects to search for.
1722
+ # @return [Array<Types::SenderIdAndCountry>]
1723
+ #
1724
+ # @!attribute [rw] filters
1725
+ # An array of SenderIdFilter objects to filter the results.
1726
+ # @return [Array<Types::SenderIdFilter>]
1727
+ #
1728
+ # @!attribute [rw] next_token
1729
+ # The token to be used for the next set of paginated results. You
1730
+ # don't need to supply a value for this field in the initial request.
1731
+ # @return [String]
1732
+ #
1733
+ # @!attribute [rw] max_results
1734
+ # The maximum number of results to return per each request.
1735
+ # @return [Integer]
1736
+ #
1737
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsRequest AWS API Documentation
1738
+ #
1739
+ class DescribeSenderIdsRequest < Struct.new(
1740
+ :sender_ids,
1741
+ :filters,
1742
+ :next_token,
1743
+ :max_results)
1744
+ SENSITIVE = []
1745
+ include Aws::Structure
1746
+ end
1747
+
1748
+ # @!attribute [rw] sender_ids
1749
+ # An array of SernderIdInformation objects that contain the details
1750
+ # for the requested SenderIds.
1751
+ # @return [Array<Types::SenderIdInformation>]
1752
+ #
1753
+ # @!attribute [rw] next_token
1754
+ # The token to be used for the next set of paginated results. If this
1755
+ # field is empty then there are no more results.
1756
+ # @return [String]
1757
+ #
1758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIdsResult AWS API Documentation
1759
+ #
1760
+ class DescribeSenderIdsResult < Struct.new(
1761
+ :sender_ids,
1762
+ :next_token)
1763
+ SENSITIVE = []
1764
+ include Aws::Structure
1765
+ end
1766
+
1767
+ # @note When making an API call, you may pass DescribeSpendLimitsRequest
1768
+ # data as a hash:
1769
+ #
1770
+ # {
1771
+ # next_token: "NextToken",
1772
+ # max_results: 1,
1773
+ # }
1774
+ #
1775
+ # @!attribute [rw] next_token
1776
+ # The token to be used for the next set of paginated results. You
1777
+ # don't need to supply a value for this field in the initial request.
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] max_results
1781
+ # The maximum number of results to return per each request.
1782
+ # @return [Integer]
1783
+ #
1784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsRequest AWS API Documentation
1785
+ #
1786
+ class DescribeSpendLimitsRequest < Struct.new(
1787
+ :next_token,
1788
+ :max_results)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ end
1792
+
1793
+ # @!attribute [rw] spend_limits
1794
+ # An array of SpendLimit objects that contain the details for the
1795
+ # requested spend limits.
1796
+ # @return [Array<Types::SpendLimit>]
1797
+ #
1798
+ # @!attribute [rw] next_token
1799
+ # The token to be used for the next set of paginated results. If this
1800
+ # field is empty then there are no more results.
1801
+ # @return [String]
1802
+ #
1803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSpendLimitsResult AWS API Documentation
1804
+ #
1805
+ class DescribeSpendLimitsResult < Struct.new(
1806
+ :spend_limits,
1807
+ :next_token)
1808
+ SENSITIVE = []
1809
+ include Aws::Structure
1810
+ end
1811
+
1812
+ # @note When making an API call, you may pass DisassociateOriginationIdentityRequest
1813
+ # data as a hash:
1814
+ #
1815
+ # {
1816
+ # pool_id: "PoolIdOrArn", # required
1817
+ # origination_identity: "PhoneOrSenderIdOrArn", # required
1818
+ # iso_country_code: "IsoCountryCode", # required
1819
+ # client_token: "ClientToken",
1820
+ # }
1821
+ #
1822
+ # @!attribute [rw] pool_id
1823
+ # The unique identifier for the pool to disassociate with the
1824
+ # origination identity. This value can be either the PoolId or
1825
+ # PoolArn.
1826
+ # @return [String]
1827
+ #
1828
+ # @!attribute [rw] origination_identity
1829
+ # The origination identity to use such as a PhoneNumberId,
1830
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
1831
+ # DescribePhoneNumbers find the values for PhoneNumberId and
1832
+ # PhoneNumberArn, or use DescribeSenderIds to get the values for
1833
+ # SenderId and SenderIdArn.
1834
+ # @return [String]
1835
+ #
1836
+ # @!attribute [rw] iso_country_code
1837
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
1838
+ # country or region.
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] client_token
1842
+ # Unique, case-sensitive identifier you provide to ensure the
1843
+ # idempotency of the request. If you don't specify a client token, a
1844
+ # randomly generated token is used for the request to ensure
1845
+ # idempotency.
1846
+ #
1847
+ # **A suitable default value is auto-generated.** You should normally
1848
+ # not need to pass this option.
1849
+ # @return [String]
1850
+ #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityRequest AWS API Documentation
1852
+ #
1853
+ class DisassociateOriginationIdentityRequest < Struct.new(
1854
+ :pool_id,
1855
+ :origination_identity,
1856
+ :iso_country_code,
1857
+ :client_token)
1858
+ SENSITIVE = []
1859
+ include Aws::Structure
1860
+ end
1861
+
1862
+ # @!attribute [rw] pool_arn
1863
+ # The Amazon Resource Name (ARN) of the pool.
1864
+ # @return [String]
1865
+ #
1866
+ # @!attribute [rw] pool_id
1867
+ # The PoolId of the pool no longer associated with the origination
1868
+ # identity.
1869
+ # @return [String]
1870
+ #
1871
+ # @!attribute [rw] origination_identity_arn
1872
+ # The PhoneNumberArn or SenderIdArn of the origination identity.
1873
+ # @return [String]
1874
+ #
1875
+ # @!attribute [rw] origination_identity
1876
+ # The PhoneNumberId or SenderId of the origination identity.
1877
+ # @return [String]
1878
+ #
1879
+ # @!attribute [rw] iso_country_code
1880
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
1881
+ # country or region.
1882
+ # @return [String]
1883
+ #
1884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DisassociateOriginationIdentityResult AWS API Documentation
1885
+ #
1886
+ class DisassociateOriginationIdentityResult < Struct.new(
1887
+ :pool_arn,
1888
+ :pool_id,
1889
+ :origination_identity_arn,
1890
+ :origination_identity,
1891
+ :iso_country_code)
1892
+ SENSITIVE = []
1893
+ include Aws::Structure
1894
+ end
1895
+
1896
+ # Contains information about an event destination.
1897
+ #
1898
+ # Event destinations are associated with configuration sets, which
1899
+ # enable you to publish message sending events to Amazon CloudWatch,
1900
+ # Amazon Kinesis Data Firehose, or Amazon SNS.
1901
+ #
1902
+ # @!attribute [rw] event_destination_name
1903
+ # The name of the EventDestination.
1904
+ # @return [String]
1905
+ #
1906
+ # @!attribute [rw] enabled
1907
+ # When set to true events will be logged.
1908
+ # @return [Boolean]
1909
+ #
1910
+ # @!attribute [rw] matching_event_types
1911
+ # An array of event types that determine which events to log.
1912
+ # @return [Array<String>]
1913
+ #
1914
+ # @!attribute [rw] cloud_watch_logs_destination
1915
+ # An object that contains information about an event destination that
1916
+ # sends logging events to Amazon CloudWatch logs.
1917
+ # @return [Types::CloudWatchLogsDestination]
1918
+ #
1919
+ # @!attribute [rw] kinesis_firehose_destination
1920
+ # An object that contains information about an event destination for
1921
+ # logging to Amazon Kinesis Data Firehose.
1922
+ # @return [Types::KinesisFirehoseDestination]
1923
+ #
1924
+ # @!attribute [rw] sns_destination
1925
+ # An object that contains information about an event destination that
1926
+ # sends logging events to Amazon SNS.
1927
+ # @return [Types::SnsDestination]
1928
+ #
1929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/EventDestination AWS API Documentation
1930
+ #
1931
+ class EventDestination < Struct.new(
1932
+ :event_destination_name,
1933
+ :enabled,
1934
+ :matching_event_types,
1935
+ :cloud_watch_logs_destination,
1936
+ :kinesis_firehose_destination,
1937
+ :sns_destination)
1938
+ SENSITIVE = []
1939
+ include Aws::Structure
1940
+ end
1941
+
1942
+ # The API encountered an unexpected error and couldn't complete the
1943
+ # request. You might be able to successfully issue the request again in
1944
+ # the future.
1945
+ #
1946
+ # @!attribute [rw] message
1947
+ # @return [String]
1948
+ #
1949
+ # @!attribute [rw] request_id
1950
+ # The unique identifier of the request.
1951
+ # @return [String]
1952
+ #
1953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/InternalServerException AWS API Documentation
1954
+ #
1955
+ class InternalServerException < Struct.new(
1956
+ :message,
1957
+ :request_id)
1958
+ SENSITIVE = []
1959
+ include Aws::Structure
1960
+ end
1961
+
1962
+ # The information for keywords that meet a specified criteria.
1963
+ #
1964
+ # @note When making an API call, you may pass KeywordFilter
1965
+ # data as a hash:
1966
+ #
1967
+ # {
1968
+ # name: "keyword-action", # required, accepts keyword-action
1969
+ # values: ["FilterValue"], # required
1970
+ # }
1971
+ #
1972
+ # @!attribute [rw] name
1973
+ # The name of the attribute to filter on.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] values
1977
+ # An array values to filter for.
1978
+ # @return [Array<String>]
1979
+ #
1980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordFilter AWS API Documentation
1981
+ #
1982
+ class KeywordFilter < Struct.new(
1983
+ :name,
1984
+ :values)
1985
+ SENSITIVE = []
1986
+ include Aws::Structure
1987
+ end
1988
+
1989
+ # The information for all keywords in a pool.
1990
+ #
1991
+ # @!attribute [rw] keyword
1992
+ # The keyword as a string.
1993
+ # @return [String]
1994
+ #
1995
+ # @!attribute [rw] keyword_message
1996
+ # A custom message that can be used with the keyword.
1997
+ # @return [String]
1998
+ #
1999
+ # @!attribute [rw] keyword_action
2000
+ # The action to perform for the keyword.
2001
+ # @return [String]
2002
+ #
2003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KeywordInformation AWS API Documentation
2004
+ #
2005
+ class KeywordInformation < Struct.new(
2006
+ :keyword,
2007
+ :keyword_message,
2008
+ :keyword_action)
2009
+ SENSITIVE = []
2010
+ include Aws::Structure
2011
+ end
2012
+
2013
+ # Contains the delivery stream Amazon Resource Name (ARN), and the ARN
2014
+ # of the Identity and Access Management (IAM) role associated with an
2015
+ # Kinesis Data Firehose event destination.
2016
+ #
2017
+ # Event destinations, such as Kinesis Data Firehose, are associated with
2018
+ # configuration sets, which enable you to publish message sending
2019
+ # events.
2020
+ #
2021
+ # @note When making an API call, you may pass KinesisFirehoseDestination
2022
+ # data as a hash:
2023
+ #
2024
+ # {
2025
+ # iam_role_arn: "IamRoleArn", # required
2026
+ # delivery_stream_arn: "DeliveryStreamArn", # required
2027
+ # }
2028
+ #
2029
+ # @!attribute [rw] iam_role_arn
2030
+ # The ARN of an Amazon Identity and Access Management (IAM) role that
2031
+ # is able to write event data to an Amazon Firehose destination.
2032
+ # @return [String]
2033
+ #
2034
+ # @!attribute [rw] delivery_stream_arn
2035
+ # The Amazon Resource Name (ARN) of the delivery stream.
2036
+ # @return [String]
2037
+ #
2038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/KinesisFirehoseDestination AWS API Documentation
2039
+ #
2040
+ class KinesisFirehoseDestination < Struct.new(
2041
+ :iam_role_arn,
2042
+ :delivery_stream_arn)
2043
+ SENSITIVE = []
2044
+ include Aws::Structure
2045
+ end
2046
+
2047
+ # @note When making an API call, you may pass ListPoolOriginationIdentitiesRequest
2048
+ # data as a hash:
2049
+ #
2050
+ # {
2051
+ # pool_id: "PoolIdOrArn", # required
2052
+ # filters: [
2053
+ # {
2054
+ # name: "iso-country-code", # required, accepts iso-country-code, number-capability
2055
+ # values: ["FilterValue"], # required
2056
+ # },
2057
+ # ],
2058
+ # next_token: "NextToken",
2059
+ # max_results: 1,
2060
+ # }
2061
+ #
2062
+ # @!attribute [rw] pool_id
2063
+ # The unique identifier for the pool. This value can be either the
2064
+ # PoolId or PoolArn.
2065
+ # @return [String]
2066
+ #
2067
+ # @!attribute [rw] filters
2068
+ # An array of PoolOriginationIdentitiesFilter objects to filter the
2069
+ # results..
2070
+ # @return [Array<Types::PoolOriginationIdentitiesFilter>]
2071
+ #
2072
+ # @!attribute [rw] next_token
2073
+ # The token to be used for the next set of paginated results. You
2074
+ # don't need to supply a value for this field in the initial request.
2075
+ # @return [String]
2076
+ #
2077
+ # @!attribute [rw] max_results
2078
+ # The maximum number of results to return per each request.
2079
+ # @return [Integer]
2080
+ #
2081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesRequest AWS API Documentation
2082
+ #
2083
+ class ListPoolOriginationIdentitiesRequest < Struct.new(
2084
+ :pool_id,
2085
+ :filters,
2086
+ :next_token,
2087
+ :max_results)
2088
+ SENSITIVE = []
2089
+ include Aws::Structure
2090
+ end
2091
+
2092
+ # @!attribute [rw] pool_arn
2093
+ # The Amazon Resource Name (ARN) for the pool.
2094
+ # @return [String]
2095
+ #
2096
+ # @!attribute [rw] pool_id
2097
+ # The unique PoolId of the pool.
2098
+ # @return [String]
2099
+ #
2100
+ # @!attribute [rw] origination_identities
2101
+ # An array of any OriginationIdentityMetadata objects.
2102
+ # @return [Array<Types::OriginationIdentityMetadata>]
2103
+ #
2104
+ # @!attribute [rw] next_token
2105
+ # The token to be used for the next set of paginated results. If this
2106
+ # field is empty then there are no more results.
2107
+ # @return [String]
2108
+ #
2109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListPoolOriginationIdentitiesResult AWS API Documentation
2110
+ #
2111
+ class ListPoolOriginationIdentitiesResult < Struct.new(
2112
+ :pool_arn,
2113
+ :pool_id,
2114
+ :origination_identities,
2115
+ :next_token)
2116
+ SENSITIVE = []
2117
+ include Aws::Structure
2118
+ end
2119
+
2120
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2121
+ # data as a hash:
2122
+ #
2123
+ # {
2124
+ # resource_arn: "AmazonResourceName", # required
2125
+ # }
2126
+ #
2127
+ # @!attribute [rw] resource_arn
2128
+ # The Amazon Resource Name (ARN) of the resource to query for.
2129
+ # @return [String]
2130
+ #
2131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceRequest AWS API Documentation
2132
+ #
2133
+ class ListTagsForResourceRequest < Struct.new(
2134
+ :resource_arn)
2135
+ SENSITIVE = []
2136
+ include Aws::Structure
2137
+ end
2138
+
2139
+ # @!attribute [rw] resource_arn
2140
+ # The ARN of the resource.
2141
+ # @return [String]
2142
+ #
2143
+ # @!attribute [rw] tags
2144
+ # An array of key and value pair tags that are associated with the
2145
+ # resource.
2146
+ # @return [Array<Types::Tag>]
2147
+ #
2148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListTagsForResourceResult AWS API Documentation
2149
+ #
2150
+ class ListTagsForResourceResult < Struct.new(
2151
+ :resource_arn,
2152
+ :tags)
2153
+ SENSITIVE = []
2154
+ include Aws::Structure
2155
+ end
2156
+
2157
+ # The information for all OptOutList in an Amazon Web Services account.
2158
+ #
2159
+ # @!attribute [rw] opt_out_list_arn
2160
+ # The Amazon Resource Name (ARN) of the OptOutList.
2161
+ # @return [String]
2162
+ #
2163
+ # @!attribute [rw] opt_out_list_name
2164
+ # The name of the OptOutList.
2165
+ # @return [String]
2166
+ #
2167
+ # @!attribute [rw] created_timestamp
2168
+ # The time when the OutOutList was created, in [UNIX epoch time][1]
2169
+ # format.
2170
+ #
2171
+ #
2172
+ #
2173
+ # [1]: https://www.epochconverter.com/
2174
+ # @return [Time]
2175
+ #
2176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptOutListInformation AWS API Documentation
2177
+ #
2178
+ class OptOutListInformation < Struct.new(
2179
+ :opt_out_list_arn,
2180
+ :opt_out_list_name,
2181
+ :created_timestamp)
2182
+ SENSITIVE = []
2183
+ include Aws::Structure
2184
+ end
2185
+
2186
+ # The information for opted out numbers that meet a specified criteria.
2187
+ #
2188
+ # @note When making an API call, you may pass OptedOutFilter
2189
+ # data as a hash:
2190
+ #
2191
+ # {
2192
+ # name: "end-user-opted-out", # required, accepts end-user-opted-out
2193
+ # values: ["FilterValue"], # required
2194
+ # }
2195
+ #
2196
+ # @!attribute [rw] name
2197
+ # The name of the attribute to filter on.
2198
+ # @return [String]
2199
+ #
2200
+ # @!attribute [rw] values
2201
+ # An array of values to filter for.
2202
+ # @return [Array<String>]
2203
+ #
2204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutFilter AWS API Documentation
2205
+ #
2206
+ class OptedOutFilter < Struct.new(
2207
+ :name,
2208
+ :values)
2209
+ SENSITIVE = []
2210
+ include Aws::Structure
2211
+ end
2212
+
2213
+ # The information for an opted out number in an Amazon Web Services
2214
+ # account.
2215
+ #
2216
+ # @!attribute [rw] opted_out_number
2217
+ # The phone number that is opted out.
2218
+ # @return [String]
2219
+ #
2220
+ # @!attribute [rw] opted_out_timestamp
2221
+ # The time that the op tout occurred, in [UNIX epoch time][1] format.
2222
+ #
2223
+ #
2224
+ #
2225
+ # [1]: https://www.epochconverter.com/
2226
+ # @return [Time]
2227
+ #
2228
+ # @!attribute [rw] end_user_opted_out
2229
+ # This is set to true if it was the end recipient that opted out.
2230
+ # @return [Boolean]
2231
+ #
2232
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OptedOutNumberInformation AWS API Documentation
2233
+ #
2234
+ class OptedOutNumberInformation < Struct.new(
2235
+ :opted_out_number,
2236
+ :opted_out_timestamp,
2237
+ :end_user_opted_out)
2238
+ SENSITIVE = []
2239
+ include Aws::Structure
2240
+ end
2241
+
2242
+ # The metadata for an origination identity associated with a pool.
2243
+ #
2244
+ # @!attribute [rw] origination_identity_arn
2245
+ # The Amazon Resource Name (ARN) associated with the origination
2246
+ # identity.
2247
+ # @return [String]
2248
+ #
2249
+ # @!attribute [rw] origination_identity
2250
+ # The unique identifier of the origination identity.
2251
+ # @return [String]
2252
+ #
2253
+ # @!attribute [rw] iso_country_code
2254
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2255
+ # country or region.
2256
+ # @return [String]
2257
+ #
2258
+ # @!attribute [rw] number_capabilities
2259
+ # Describes if the origination identity can be used for text messages,
2260
+ # voice calls or both.
2261
+ # @return [Array<String>]
2262
+ #
2263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/OriginationIdentityMetadata AWS API Documentation
2264
+ #
2265
+ class OriginationIdentityMetadata < Struct.new(
2266
+ :origination_identity_arn,
2267
+ :origination_identity,
2268
+ :iso_country_code,
2269
+ :number_capabilities)
2270
+ SENSITIVE = []
2271
+ include Aws::Structure
2272
+ end
2273
+
2274
+ # The information for a phone number that meets a specified criteria.
2275
+ #
2276
+ # @note When making an API call, you may pass PhoneNumberFilter
2277
+ # data as a hash:
2278
+ #
2279
+ # {
2280
+ # name: "status", # required, accepts status, iso-country-code, message-type, number-capability, number-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, deletion-protection-enabled
2281
+ # values: ["FilterValue"], # required
2282
+ # }
2283
+ #
2284
+ # @!attribute [rw] name
2285
+ # The name of the attribute to filter on.
2286
+ # @return [String]
2287
+ #
2288
+ # @!attribute [rw] values
2289
+ # An array values to filter for.
2290
+ # @return [Array<String>]
2291
+ #
2292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberFilter AWS API Documentation
2293
+ #
2294
+ class PhoneNumberFilter < Struct.new(
2295
+ :name,
2296
+ :values)
2297
+ SENSITIVE = []
2298
+ include Aws::Structure
2299
+ end
2300
+
2301
+ # The information for a phone number in an Amazon Web Services account.
2302
+ #
2303
+ # @!attribute [rw] phone_number_arn
2304
+ # The Amazon Resource Name (ARN) associated with the phone number.
2305
+ # @return [String]
2306
+ #
2307
+ # @!attribute [rw] phone_number_id
2308
+ # The unique identifier for the phone number.
2309
+ # @return [String]
2310
+ #
2311
+ # @!attribute [rw] phone_number
2312
+ # The phone number in E.164 format.
2313
+ # @return [String]
2314
+ #
2315
+ # @!attribute [rw] status
2316
+ # The current status of the phone number.
2317
+ # @return [String]
2318
+ #
2319
+ # @!attribute [rw] iso_country_code
2320
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2321
+ # country or region.
2322
+ # @return [String]
2323
+ #
2324
+ # @!attribute [rw] message_type
2325
+ # The type of message. Valid values are TRANSACTIONAL for messages
2326
+ # that are critical or time-sensitive and PROMOTIONAL for messages
2327
+ # that aren't critical or time-sensitive.
2328
+ # @return [String]
2329
+ #
2330
+ # @!attribute [rw] number_capabilities
2331
+ # Describes if the origination identity can be used for text messages,
2332
+ # voice calls or both.
2333
+ # @return [Array<String>]
2334
+ #
2335
+ # @!attribute [rw] number_type
2336
+ # The type of phone number.
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] monthly_leasing_price
2340
+ # The price, in US dollars, to lease the phone number.
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] two_way_enabled
2344
+ # By default this is set to false. When set to true you can receive
2345
+ # incoming text messages from your end recipients using the
2346
+ # TwoWayChannelArn.
2347
+ # @return [Boolean]
2348
+ #
2349
+ # @!attribute [rw] two_way_channel_arn
2350
+ # The Amazon Resource Name (ARN) of the two way channel.
2351
+ # @return [String]
2352
+ #
2353
+ # @!attribute [rw] self_managed_opt_outs_enabled
2354
+ # When set to false an end recipient sends a message that begins with
2355
+ # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
2356
+ # automatically replies with a customizable message and adds the end
2357
+ # recipient to the OptOutList. When set to true you're responsible
2358
+ # for responding to HELP and STOP requests. You're also responsible
2359
+ # for tracking and honoring opt-out request. For more information see
2360
+ # [Self-managed opt-outs][1]
2361
+ #
2362
+ #
2363
+ #
2364
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
2365
+ # @return [Boolean]
2366
+ #
2367
+ # @!attribute [rw] opt_out_list_name
2368
+ # The name of the OptOutList associated with the phone number.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] deletion_protection_enabled
2372
+ # When set to true the phone number can't be deleted.
2373
+ # @return [Boolean]
2374
+ #
2375
+ # @!attribute [rw] pool_id
2376
+ # The unique identifier of the pool associated with the phone number.
2377
+ # @return [String]
2378
+ #
2379
+ # @!attribute [rw] created_timestamp
2380
+ # The time when the phone number was created, in [UNIX epoch time][1]
2381
+ # format.
2382
+ #
2383
+ #
2384
+ #
2385
+ # [1]: https://www.epochconverter.com/
2386
+ # @return [Time]
2387
+ #
2388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PhoneNumberInformation AWS API Documentation
2389
+ #
2390
+ class PhoneNumberInformation < Struct.new(
2391
+ :phone_number_arn,
2392
+ :phone_number_id,
2393
+ :phone_number,
2394
+ :status,
2395
+ :iso_country_code,
2396
+ :message_type,
2397
+ :number_capabilities,
2398
+ :number_type,
2399
+ :monthly_leasing_price,
2400
+ :two_way_enabled,
2401
+ :two_way_channel_arn,
2402
+ :self_managed_opt_outs_enabled,
2403
+ :opt_out_list_name,
2404
+ :deletion_protection_enabled,
2405
+ :pool_id,
2406
+ :created_timestamp)
2407
+ SENSITIVE = []
2408
+ include Aws::Structure
2409
+ end
2410
+
2411
+ # The information for a pool that meets a specified criteria.
2412
+ #
2413
+ # @note When making an API call, you may pass PoolFilter
2414
+ # data as a hash:
2415
+ #
2416
+ # {
2417
+ # name: "status", # required, accepts status, message-type, two-way-enabled, self-managed-opt-outs-enabled, opt-out-list-name, shared-routes-enabled, deletion-protection-enabled
2418
+ # values: ["FilterValue"], # required
2419
+ # }
2420
+ #
2421
+ # @!attribute [rw] name
2422
+ # The name of the attribute to filter on.
2423
+ # @return [String]
2424
+ #
2425
+ # @!attribute [rw] values
2426
+ # An array values to filter for.
2427
+ # @return [Array<String>]
2428
+ #
2429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolFilter AWS API Documentation
2430
+ #
2431
+ class PoolFilter < Struct.new(
2432
+ :name,
2433
+ :values)
2434
+ SENSITIVE = []
2435
+ include Aws::Structure
2436
+ end
2437
+
2438
+ # The information for a pool in an Amazon Web Services account.
2439
+ #
2440
+ # @!attribute [rw] pool_arn
2441
+ # The Amazon Resource Name (ARN) for the pool.
2442
+ # @return [String]
2443
+ #
2444
+ # @!attribute [rw] pool_id
2445
+ # The unique identifier for the pool.
2446
+ # @return [String]
2447
+ #
2448
+ # @!attribute [rw] status
2449
+ # The current status of the pool.
2450
+ # @return [String]
2451
+ #
2452
+ # @!attribute [rw] message_type
2453
+ # The type of message. Valid values are TRANSACTIONAL for messages
2454
+ # that are critical or time-sensitive and PROMOTIONAL for messages
2455
+ # that aren't critical or time-sensitive.
2456
+ # @return [String]
2457
+ #
2458
+ # @!attribute [rw] two_way_enabled
2459
+ # When set to true you can receive incoming text messages from your
2460
+ # end recipients using the TwoWayChannelArn.
2461
+ # @return [Boolean]
2462
+ #
2463
+ # @!attribute [rw] two_way_channel_arn
2464
+ # The Amazon Resource Name (ARN) of the two way channel.
2465
+ # @return [String]
2466
+ #
2467
+ # @!attribute [rw] self_managed_opt_outs_enabled
2468
+ # When set to false, an end recipient sends a message that begins with
2469
+ # HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
2470
+ # automatically replies with a customizable message and adds the end
2471
+ # recipient to the OptOutList. When set to true you're responsible
2472
+ # for responding to HELP and STOP requests. You're also responsible
2473
+ # for tracking and honoring opt-out requests. For more information see
2474
+ # [Self-managed opt-outs][1]
2475
+ #
2476
+ #
2477
+ #
2478
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/settings-sms-managing.html#settings-account-sms-self-managed-opt-out
2479
+ # @return [Boolean]
2480
+ #
2481
+ # @!attribute [rw] opt_out_list_name
2482
+ # The name of the OptOutList associated with the pool.
2483
+ # @return [String]
2484
+ #
2485
+ # @!attribute [rw] shared_routes_enabled
2486
+ # Allows you to enable shared routes on your pool.
2487
+ #
2488
+ # By default, this is set to `False`. If you set this value to `True`,
2489
+ # your messages are sent using phone numbers or sender IDs (depending
2490
+ # on the country) that are shared with other Amazon Pinpoint users. In
2491
+ # some countries, such as the United States, senders aren't allowed
2492
+ # to use shared routes and must use a dedicated phone number or short
2493
+ # code.
2494
+ # @return [Boolean]
2495
+ #
2496
+ # @!attribute [rw] deletion_protection_enabled
2497
+ # When set to true the pool can't be deleted.
2498
+ # @return [Boolean]
2499
+ #
2500
+ # @!attribute [rw] created_timestamp
2501
+ # The time when the pool was created, in [UNIX epoch time][1] format.
2502
+ #
2503
+ #
2504
+ #
2505
+ # [1]: https://www.epochconverter.com/
2506
+ # @return [Time]
2507
+ #
2508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolInformation AWS API Documentation
2509
+ #
2510
+ class PoolInformation < Struct.new(
2511
+ :pool_arn,
2512
+ :pool_id,
2513
+ :status,
2514
+ :message_type,
2515
+ :two_way_enabled,
2516
+ :two_way_channel_arn,
2517
+ :self_managed_opt_outs_enabled,
2518
+ :opt_out_list_name,
2519
+ :shared_routes_enabled,
2520
+ :deletion_protection_enabled,
2521
+ :created_timestamp)
2522
+ SENSITIVE = []
2523
+ include Aws::Structure
2524
+ end
2525
+
2526
+ # Information about origination identities associated with a pool that
2527
+ # meets a specified criteria.
2528
+ #
2529
+ # @note When making an API call, you may pass PoolOriginationIdentitiesFilter
2530
+ # data as a hash:
2531
+ #
2532
+ # {
2533
+ # name: "iso-country-code", # required, accepts iso-country-code, number-capability
2534
+ # values: ["FilterValue"], # required
2535
+ # }
2536
+ #
2537
+ # @!attribute [rw] name
2538
+ # The name of the attribute to filter on.
2539
+ # @return [String]
2540
+ #
2541
+ # @!attribute [rw] values
2542
+ # An array values to filter for.
2543
+ # @return [Array<String>]
2544
+ #
2545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PoolOriginationIdentitiesFilter AWS API Documentation
2546
+ #
2547
+ class PoolOriginationIdentitiesFilter < Struct.new(
2548
+ :name,
2549
+ :values)
2550
+ SENSITIVE = []
2551
+ include Aws::Structure
2552
+ end
2553
+
2554
+ # @note When making an API call, you may pass PutKeywordRequest
2555
+ # data as a hash:
2556
+ #
2557
+ # {
2558
+ # origination_identity: "PhoneOrPoolIdOrArn", # required
2559
+ # keyword: "Keyword", # required
2560
+ # keyword_message: "KeywordMessage", # required
2561
+ # keyword_action: "AUTOMATIC_RESPONSE", # accepts AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN
2562
+ # }
2563
+ #
2564
+ # @!attribute [rw] origination_identity
2565
+ # The origination identity to use such as a PhoneNumberId,
2566
+ # PhoneNumberArn, SenderId or SenderIdArn. You can use
2567
+ # DescribePhoneNumbers get the values for PhoneNumberId and
2568
+ # PhoneNumberArn while DescribeSenderIds can be used to get the values
2569
+ # for SenderId and SenderIdArn.
2570
+ # @return [String]
2571
+ #
2572
+ # @!attribute [rw] keyword
2573
+ # The new keyword to add.
2574
+ # @return [String]
2575
+ #
2576
+ # @!attribute [rw] keyword_message
2577
+ # The message associated with the keyword.
2578
+ #
2579
+ # * AUTOMATIC\_RESPONSE: A message is sent to the recipient.
2580
+ #
2581
+ # * OPT\_OUT: Keeps the recipient from receiving future messages.
2582
+ #
2583
+ # * OPT\_IN: The recipient wants to receive future messages.
2584
+ # @return [String]
2585
+ #
2586
+ # @!attribute [rw] keyword_action
2587
+ # The action to perform for the new keyword when it is received.
2588
+ # @return [String]
2589
+ #
2590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordRequest AWS API Documentation
2591
+ #
2592
+ class PutKeywordRequest < Struct.new(
2593
+ :origination_identity,
2594
+ :keyword,
2595
+ :keyword_message,
2596
+ :keyword_action)
2597
+ SENSITIVE = []
2598
+ include Aws::Structure
2599
+ end
2600
+
2601
+ # @!attribute [rw] origination_identity_arn
2602
+ # The PhoneNumberArn or PoolArn that the keyword was associated with.
2603
+ # @return [String]
2604
+ #
2605
+ # @!attribute [rw] origination_identity
2606
+ # The PhoneNumberId or PoolId that the keyword was associated with.
2607
+ # @return [String]
2608
+ #
2609
+ # @!attribute [rw] keyword
2610
+ # The keyword that was added.
2611
+ # @return [String]
2612
+ #
2613
+ # @!attribute [rw] keyword_message
2614
+ # The message associated with the keyword.
2615
+ # @return [String]
2616
+ #
2617
+ # @!attribute [rw] keyword_action
2618
+ # The action to perform when the keyword is used.
2619
+ # @return [String]
2620
+ #
2621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutKeywordResult AWS API Documentation
2622
+ #
2623
+ class PutKeywordResult < Struct.new(
2624
+ :origination_identity_arn,
2625
+ :origination_identity,
2626
+ :keyword,
2627
+ :keyword_message,
2628
+ :keyword_action)
2629
+ SENSITIVE = []
2630
+ include Aws::Structure
2631
+ end
2632
+
2633
+ # @note When making an API call, you may pass PutOptedOutNumberRequest
2634
+ # data as a hash:
2635
+ #
2636
+ # {
2637
+ # opt_out_list_name: "OptOutListNameOrArn", # required
2638
+ # opted_out_number: "PhoneNumber", # required
2639
+ # }
2640
+ #
2641
+ # @!attribute [rw] opt_out_list_name
2642
+ # The OptOutListName or OptOutListArn to add the phone number to.
2643
+ # @return [String]
2644
+ #
2645
+ # @!attribute [rw] opted_out_number
2646
+ # The phone number to add to the OptOutList in E.164 format.
2647
+ # @return [String]
2648
+ #
2649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberRequest AWS API Documentation
2650
+ #
2651
+ class PutOptedOutNumberRequest < Struct.new(
2652
+ :opt_out_list_name,
2653
+ :opted_out_number)
2654
+ SENSITIVE = []
2655
+ include Aws::Structure
2656
+ end
2657
+
2658
+ # @!attribute [rw] opt_out_list_arn
2659
+ # The OptOutListArn that the phone number was removed from.
2660
+ # @return [String]
2661
+ #
2662
+ # @!attribute [rw] opt_out_list_name
2663
+ # The OptOutListName that the phone number was removed from.
2664
+ # @return [String]
2665
+ #
2666
+ # @!attribute [rw] opted_out_number
2667
+ # The phone number that was added to the OptOutList.
2668
+ # @return [String]
2669
+ #
2670
+ # @!attribute [rw] opted_out_timestamp
2671
+ # The time that the phone number was added to the OptOutList, in [UNIX
2672
+ # epoch time][1] format.
2673
+ #
2674
+ #
2675
+ #
2676
+ # [1]: https://www.epochconverter.com/
2677
+ # @return [Time]
2678
+ #
2679
+ # @!attribute [rw] end_user_opted_out
2680
+ # This is true if it was the end user who requested their phone number
2681
+ # be removed.
2682
+ # @return [Boolean]
2683
+ #
2684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutOptedOutNumberResult AWS API Documentation
2685
+ #
2686
+ class PutOptedOutNumberResult < Struct.new(
2687
+ :opt_out_list_arn,
2688
+ :opt_out_list_name,
2689
+ :opted_out_number,
2690
+ :opted_out_timestamp,
2691
+ :end_user_opted_out)
2692
+ SENSITIVE = []
2693
+ include Aws::Structure
2694
+ end
2695
+
2696
+ # @note When making an API call, you may pass ReleasePhoneNumberRequest
2697
+ # data as a hash:
2698
+ #
2699
+ # {
2700
+ # phone_number_id: "PhoneNumberIdOrArn", # required
2701
+ # }
2702
+ #
2703
+ # @!attribute [rw] phone_number_id
2704
+ # The PhoneNumberId or PhoneNumberArn of the phone number to release.
2705
+ # You can use DescribePhoneNumbers to get the values for PhoneNumberId
2706
+ # and PhoneNumberArn.
2707
+ # @return [String]
2708
+ #
2709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumberRequest AWS API Documentation
2710
+ #
2711
+ class ReleasePhoneNumberRequest < Struct.new(
2712
+ :phone_number_id)
2713
+ SENSITIVE = []
2714
+ include Aws::Structure
2715
+ end
2716
+
2717
+ # @!attribute [rw] phone_number_arn
2718
+ # The PhoneNumberArn of the phone number that was released.
2719
+ # @return [String]
2720
+ #
2721
+ # @!attribute [rw] phone_number_id
2722
+ # The PhoneNumberId of the phone number that was released.
2723
+ # @return [String]
2724
+ #
2725
+ # @!attribute [rw] phone_number
2726
+ # The phone number that was released.
2727
+ # @return [String]
2728
+ #
2729
+ # @!attribute [rw] status
2730
+ # The current status of the request.
2731
+ # @return [String]
2732
+ #
2733
+ # @!attribute [rw] iso_country_code
2734
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2735
+ # country or region.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] message_type
2739
+ # The message type that was associated with the phone number.
2740
+ # @return [String]
2741
+ #
2742
+ # @!attribute [rw] number_capabilities
2743
+ # Specifies if the number could be used for text messages, voice, or
2744
+ # both.
2745
+ # @return [Array<String>]
2746
+ #
2747
+ # @!attribute [rw] number_type
2748
+ # The type of number that was released.
2749
+ # @return [String]
2750
+ #
2751
+ # @!attribute [rw] monthly_leasing_price
2752
+ # The monthly price of the phone number, in US dollars.
2753
+ # @return [String]
2754
+ #
2755
+ # @!attribute [rw] two_way_enabled
2756
+ # By default this is set to false. When set to true you can receive
2757
+ # incoming text messages from your end recipients.
2758
+ # @return [Boolean]
2759
+ #
2760
+ # @!attribute [rw] two_way_channel_arn
2761
+ # The Amazon Resource Name (ARN) of the TwoWayChannel.
2762
+ # @return [String]
2763
+ #
2764
+ # @!attribute [rw] self_managed_opt_outs_enabled
2765
+ # By default this is set to false. When an end recipient sends a
2766
+ # message that begins with HELP or STOP to one of your dedicated
2767
+ # numbers, Amazon Pinpoint automatically replies with a customizable
2768
+ # message and adds the end recipient to the OptOutList. When set to
2769
+ # true you're responsible for responding to HELP and STOP requests.
2770
+ # You're also responsible for tracking and honoring opt-out requests.
2771
+ # @return [Boolean]
2772
+ #
2773
+ # @!attribute [rw] opt_out_list_name
2774
+ # The name of the OptOutList that was associated with the phone
2775
+ # number.
2776
+ # @return [String]
2777
+ #
2778
+ # @!attribute [rw] created_timestamp
2779
+ # The time when the phone number was created, in [UNIX epoch time][1]
2780
+ # format.
2781
+ #
2782
+ #
2783
+ #
2784
+ # [1]: https://www.epochconverter.com/
2785
+ # @return [Time]
2786
+ #
2787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumberResult AWS API Documentation
2788
+ #
2789
+ class ReleasePhoneNumberResult < Struct.new(
2790
+ :phone_number_arn,
2791
+ :phone_number_id,
2792
+ :phone_number,
2793
+ :status,
2794
+ :iso_country_code,
2795
+ :message_type,
2796
+ :number_capabilities,
2797
+ :number_type,
2798
+ :monthly_leasing_price,
2799
+ :two_way_enabled,
2800
+ :two_way_channel_arn,
2801
+ :self_managed_opt_outs_enabled,
2802
+ :opt_out_list_name,
2803
+ :created_timestamp)
2804
+ SENSITIVE = []
2805
+ include Aws::Structure
2806
+ end
2807
+
2808
+ # @note When making an API call, you may pass RequestPhoneNumberRequest
2809
+ # data as a hash:
2810
+ #
2811
+ # {
2812
+ # iso_country_code: "IsoCountryCode", # required
2813
+ # message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
2814
+ # number_capabilities: ["SMS"], # required, accepts SMS, VOICE
2815
+ # number_type: "LONG_CODE", # required, accepts LONG_CODE, TOLL_FREE, TEN_DLC
2816
+ # opt_out_list_name: "OptOutListNameOrArn",
2817
+ # pool_id: "PoolIdOrArn",
2818
+ # registration_id: "RegistrationId",
2819
+ # deletion_protection_enabled: false,
2820
+ # tags: [
2821
+ # {
2822
+ # key: "TagKey", # required
2823
+ # value: "TagValue", # required
2824
+ # },
2825
+ # ],
2826
+ # client_token: "ClientToken",
2827
+ # }
2828
+ #
2829
+ # @!attribute [rw] iso_country_code
2830
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2831
+ # country or region.
2832
+ # @return [String]
2833
+ #
2834
+ # @!attribute [rw] message_type
2835
+ # The type of message. Valid values are TRANSACTIONAL for messages
2836
+ # that are critical or time-sensitive and PROMOTIONAL for messages
2837
+ # that aren't critical or time-sensitive.
2838
+ # @return [String]
2839
+ #
2840
+ # @!attribute [rw] number_capabilities
2841
+ # Indicates if the phone number will be used for text messages, voice
2842
+ # messages, or both.
2843
+ # @return [Array<String>]
2844
+ #
2845
+ # @!attribute [rw] number_type
2846
+ # The type of phone number to request.
2847
+ # @return [String]
2848
+ #
2849
+ # @!attribute [rw] opt_out_list_name
2850
+ # The name of the OptOutList to associate with the phone number. You
2851
+ # can use the OutOutListName or OptPutListArn.
2852
+ # @return [String]
2853
+ #
2854
+ # @!attribute [rw] pool_id
2855
+ # The pool to associated with the phone number. You can use the PoolId
2856
+ # or PoolArn.
2857
+ # @return [String]
2858
+ #
2859
+ # @!attribute [rw] registration_id
2860
+ # Use this field to attach your phone number for an external
2861
+ # registration process.
2862
+ # @return [String]
2863
+ #
2864
+ # @!attribute [rw] deletion_protection_enabled
2865
+ # By default this is set to false. When set to true the phone number
2866
+ # can't be deleted.
2867
+ # @return [Boolean]
2868
+ #
2869
+ # @!attribute [rw] tags
2870
+ # An array of tags (key and value pairs) associate with the requested
2871
+ # phone number.
2872
+ # @return [Array<Types::Tag>]
2873
+ #
2874
+ # @!attribute [rw] client_token
2875
+ # Unique, case-sensitive identifier that you provide to ensure the
2876
+ # idempotency of the request. If you don't specify a client token, a
2877
+ # randomly generated token is used for the request to ensure
2878
+ # idempotency.
2879
+ #
2880
+ # **A suitable default value is auto-generated.** You should normally
2881
+ # not need to pass this option.
2882
+ # @return [String]
2883
+ #
2884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestPhoneNumberRequest AWS API Documentation
2885
+ #
2886
+ class RequestPhoneNumberRequest < Struct.new(
2887
+ :iso_country_code,
2888
+ :message_type,
2889
+ :number_capabilities,
2890
+ :number_type,
2891
+ :opt_out_list_name,
2892
+ :pool_id,
2893
+ :registration_id,
2894
+ :deletion_protection_enabled,
2895
+ :tags,
2896
+ :client_token)
2897
+ SENSITIVE = []
2898
+ include Aws::Structure
2899
+ end
2900
+
2901
+ # @!attribute [rw] phone_number_arn
2902
+ # The Amazon Resource Name (ARN) of the requested phone number.
2903
+ # @return [String]
2904
+ #
2905
+ # @!attribute [rw] phone_number_id
2906
+ # The unique identifier of the new phone number.
2907
+ # @return [String]
2908
+ #
2909
+ # @!attribute [rw] phone_number
2910
+ # The new phone number that was requested.
2911
+ # @return [String]
2912
+ #
2913
+ # @!attribute [rw] status
2914
+ # The current status of the request.
2915
+ # @return [String]
2916
+ #
2917
+ # @!attribute [rw] iso_country_code
2918
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
2919
+ # country or region.
2920
+ # @return [String]
2921
+ #
2922
+ # @!attribute [rw] message_type
2923
+ # The type of message. Valid values are TRANSACTIONAL for messages
2924
+ # that are critical or time-sensitive and PROMOTIONAL for messages
2925
+ # that aren't critical or time-sensitive.
2926
+ # @return [String]
2927
+ #
2928
+ # @!attribute [rw] number_capabilities
2929
+ # Indicates if the phone number will be used for text messages, voice
2930
+ # messages or both.
2931
+ # @return [Array<String>]
2932
+ #
2933
+ # @!attribute [rw] number_type
2934
+ # The type of number that was released.
2935
+ # @return [String]
2936
+ #
2937
+ # @!attribute [rw] monthly_leasing_price
2938
+ # The monthly price, in US dollars, to lease the phone number.
2939
+ # @return [String]
2940
+ #
2941
+ # @!attribute [rw] two_way_enabled
2942
+ # By default this is set to false. When set to true you can receive
2943
+ # incoming text messages from your end recipients.
2944
+ # @return [Boolean]
2945
+ #
2946
+ # @!attribute [rw] two_way_channel_arn
2947
+ # The ARN used to identify the two way channel.
2948
+ # @return [String]
2949
+ #
2950
+ # @!attribute [rw] self_managed_opt_outs_enabled
2951
+ # By default this is set to false. When an end recipient sends a
2952
+ # message that begins with HELP or STOP to one of your dedicated
2953
+ # numbers, Amazon Pinpoint automatically replies with a customizable
2954
+ # message and adds the end recipient to the OptOutList. When set to
2955
+ # true you're responsible for responding to HELP and STOP requests.
2956
+ # You're also responsible for tracking and honoring opt-out requests.
2957
+ # @return [Boolean]
2958
+ #
2959
+ # @!attribute [rw] opt_out_list_name
2960
+ # The name of the OptOutList that is associated with the requested
2961
+ # phone number.
2962
+ # @return [String]
2963
+ #
2964
+ # @!attribute [rw] deletion_protection_enabled
2965
+ # By default this is set to false. When set to true the phone number
2966
+ # can't be deleted.
2967
+ # @return [Boolean]
2968
+ #
2969
+ # @!attribute [rw] pool_id
2970
+ # The unique identifier of the pool associated with the phone number
2971
+ # @return [String]
2972
+ #
2973
+ # @!attribute [rw] tags
2974
+ # An array of key and value pair tags that are associated with the
2975
+ # phone number.
2976
+ # @return [Array<Types::Tag>]
2977
+ #
2978
+ # @!attribute [rw] created_timestamp
2979
+ # The time when the phone number was created, in [UNIX epoch time][1]
2980
+ # format.
2981
+ #
2982
+ #
2983
+ #
2984
+ # [1]: https://www.epochconverter.com/
2985
+ # @return [Time]
2986
+ #
2987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RequestPhoneNumberResult AWS API Documentation
2988
+ #
2989
+ class RequestPhoneNumberResult < Struct.new(
2990
+ :phone_number_arn,
2991
+ :phone_number_id,
2992
+ :phone_number,
2993
+ :status,
2994
+ :iso_country_code,
2995
+ :message_type,
2996
+ :number_capabilities,
2997
+ :number_type,
2998
+ :monthly_leasing_price,
2999
+ :two_way_enabled,
3000
+ :two_way_channel_arn,
3001
+ :self_managed_opt_outs_enabled,
3002
+ :opt_out_list_name,
3003
+ :deletion_protection_enabled,
3004
+ :pool_id,
3005
+ :tags,
3006
+ :created_timestamp)
3007
+ SENSITIVE = []
3008
+ include Aws::Structure
3009
+ end
3010
+
3011
+ # A requested resource couldn't be found.
3012
+ #
3013
+ # @!attribute [rw] message
3014
+ # @return [String]
3015
+ #
3016
+ # @!attribute [rw] resource_type
3017
+ # The type of resource that caused the exception.
3018
+ # @return [String]
3019
+ #
3020
+ # @!attribute [rw] resource_id
3021
+ # The unique identifier of the resource.
3022
+ # @return [String]
3023
+ #
3024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ResourceNotFoundException AWS API Documentation
3025
+ #
3026
+ class ResourceNotFoundException < Struct.new(
3027
+ :message,
3028
+ :resource_type,
3029
+ :resource_id)
3030
+ SENSITIVE = []
3031
+ include Aws::Structure
3032
+ end
3033
+
3034
+ # @note When making an API call, you may pass SendTextMessageRequest
3035
+ # data as a hash:
3036
+ #
3037
+ # {
3038
+ # destination_phone_number: "PhoneNumber", # required
3039
+ # origination_identity: "TextMessageOriginationIdentity",
3040
+ # message_body: "TextMessageBody",
3041
+ # message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
3042
+ # keyword: "Keyword",
3043
+ # configuration_set_name: "ConfigurationSetNameOrArn",
3044
+ # max_price: "MaxPrice",
3045
+ # time_to_live: 1,
3046
+ # context: {
3047
+ # "ContextKey" => "ContextValue",
3048
+ # },
3049
+ # destination_country_parameters: {
3050
+ # "IN_TEMPLATE_ID" => "DestinationCountryParameterValue",
3051
+ # },
3052
+ # dry_run: false,
3053
+ # }
3054
+ #
3055
+ # @!attribute [rw] destination_phone_number
3056
+ # The destination phone number in E.164 format.
3057
+ # @return [String]
3058
+ #
3059
+ # @!attribute [rw] origination_identity
3060
+ # The origination identity of the message. This can be either the
3061
+ # PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
3062
+ # PoolId, or PoolArn.
3063
+ # @return [String]
3064
+ #
3065
+ # @!attribute [rw] message_body
3066
+ # The body of the text message.
3067
+ # @return [String]
3068
+ #
3069
+ # @!attribute [rw] message_type
3070
+ # The type of message. Valid values are TRANSACTIONAL for messages
3071
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3072
+ # that aren't critical or time-sensitive.
3073
+ # @return [String]
3074
+ #
3075
+ # @!attribute [rw] keyword
3076
+ # When you register a short code in the US, you must specify a program
3077
+ # name. If you don’t have a US short code, omit this attribute.
3078
+ # @return [String]
3079
+ #
3080
+ # @!attribute [rw] configuration_set_name
3081
+ # The name of the configuration set to use. This can be either the
3082
+ # ConfigurationSetName or ConfigurationSetArn.
3083
+ # @return [String]
3084
+ #
3085
+ # @!attribute [rw] max_price
3086
+ # The maximum amount that you want to spend, in US dollars, per each
3087
+ # text message part. A text message can contain multiple parts.
3088
+ # @return [String]
3089
+ #
3090
+ # @!attribute [rw] time_to_live
3091
+ # How long the text message is valid for. By default this is 72 hours.
3092
+ # @return [Integer]
3093
+ #
3094
+ # @!attribute [rw] context
3095
+ # You can specify custom data in this field. If you do, that data is
3096
+ # logged to the event destination.
3097
+ # @return [Hash<String,String>]
3098
+ #
3099
+ # @!attribute [rw] destination_country_parameters
3100
+ # This field is used for any country-specific registration
3101
+ # requirements. Currently, this setting is only used when you send
3102
+ # messages to recipients in India using a sender ID. For more
3103
+ # information see [Special requirements for sending SMS messages to
3104
+ # recipients in India][1].
3105
+ #
3106
+ #
3107
+ #
3108
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-senderid-india.html
3109
+ # @return [Hash<String,String>]
3110
+ #
3111
+ # @!attribute [rw] dry_run
3112
+ # When set to true, the message is checked and validated, but isn't
3113
+ # sent to the end recipient.
3114
+ # @return [Boolean]
3115
+ #
3116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessageRequest AWS API Documentation
3117
+ #
3118
+ class SendTextMessageRequest < Struct.new(
3119
+ :destination_phone_number,
3120
+ :origination_identity,
3121
+ :message_body,
3122
+ :message_type,
3123
+ :keyword,
3124
+ :configuration_set_name,
3125
+ :max_price,
3126
+ :time_to_live,
3127
+ :context,
3128
+ :destination_country_parameters,
3129
+ :dry_run)
3130
+ SENSITIVE = []
3131
+ include Aws::Structure
3132
+ end
3133
+
3134
+ # @!attribute [rw] message_id
3135
+ # The unique identifier for the message.
3136
+ # @return [String]
3137
+ #
3138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessageResult AWS API Documentation
3139
+ #
3140
+ class SendTextMessageResult < Struct.new(
3141
+ :message_id)
3142
+ SENSITIVE = []
3143
+ include Aws::Structure
3144
+ end
3145
+
3146
+ # @note When making an API call, you may pass SendVoiceMessageRequest
3147
+ # data as a hash:
3148
+ #
3149
+ # {
3150
+ # destination_phone_number: "PhoneNumber", # required
3151
+ # origination_identity: "VoiceMessageOriginationIdentity", # required
3152
+ # message_body: "VoiceMessageBody",
3153
+ # message_body_text_type: "TEXT", # accepts TEXT, SSML
3154
+ # voice_id: "AMY", # accepts AMY, ASTRID, BIANCA, BRIAN, CAMILA, CARLA, CARMEN, CELINE, CHANTAL, CONCHITA, CRISTIANO, DORA, EMMA, ENRIQUE, EWA, FILIZ, GERAINT, GIORGIO, GWYNETH, HANS, INES, IVY, JACEK, JAN, JOANNA, JOEY, JUSTIN, KARL, KENDRA, KIMBERLY, LEA, LIV, LOTTE, LUCIA, LUPE, MADS, MAJA, MARLENE, MATHIEU, MATTHEW, MAXIM, MIA, MIGUEL, MIZUKI, NAJA, NICOLE, PENELOPE, RAVEENA, RICARDO, RUBEN, RUSSELL, SALLI, SEOYEON, TAKUMI, TATYANA, VICKI, VITORIA, ZEINA, ZHIYU
3155
+ # configuration_set_name: "ConfigurationSetNameOrArn",
3156
+ # max_price_per_minute: "MaxPrice",
3157
+ # time_to_live: 1,
3158
+ # context: {
3159
+ # "ContextKey" => "ContextValue",
3160
+ # },
3161
+ # dry_run: false,
3162
+ # }
3163
+ #
3164
+ # @!attribute [rw] destination_phone_number
3165
+ # The destination phone number in E.164 format.
3166
+ # @return [String]
3167
+ #
3168
+ # @!attribute [rw] origination_identity
3169
+ # The origination identity to use for the voice call. This can be the
3170
+ # PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
3171
+ # @return [String]
3172
+ #
3173
+ # @!attribute [rw] message_body
3174
+ # The text to convert to a voice message.
3175
+ # @return [String]
3176
+ #
3177
+ # @!attribute [rw] message_body_text_type
3178
+ # Specifies if the MessageBody field contains text or [speech
3179
+ # synthesis markup language (SSML)][1].
3180
+ #
3181
+ # * TEXT: This is the default value. When used the maximum character
3182
+ # limit is 3000.
3183
+ #
3184
+ # * SSML: When used the maximum character limit is 6000 including SSML
3185
+ # tagging.
3186
+ #
3187
+ #
3188
+ #
3189
+ # [1]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html
3190
+ # @return [String]
3191
+ #
3192
+ # @!attribute [rw] voice_id
3193
+ # The voice for the [Amazon Polly][1] service to use. By default this
3194
+ # is set to "MATTHEW".
3195
+ #
3196
+ #
3197
+ #
3198
+ # [1]: https://docs.aws.amazon.com/polly/latest/dg/what-is.html
3199
+ # @return [String]
3200
+ #
3201
+ # @!attribute [rw] configuration_set_name
3202
+ # The name of the configuration set to use. This can be either the
3203
+ # ConfigurationSetName or ConfigurationSetArn.
3204
+ # @return [String]
3205
+ #
3206
+ # @!attribute [rw] max_price_per_minute
3207
+ # The maximum amount to spend per voice message, in US dollars.
3208
+ # @return [String]
3209
+ #
3210
+ # @!attribute [rw] time_to_live
3211
+ # How long the voice message is valid for. By default this is 72
3212
+ # hours.
3213
+ # @return [Integer]
3214
+ #
3215
+ # @!attribute [rw] context
3216
+ # You can specify custom data in this field. If you do, that data is
3217
+ # logged to the event destination.
3218
+ # @return [Hash<String,String>]
3219
+ #
3220
+ # @!attribute [rw] dry_run
3221
+ # When set to true, the message is checked and validated, but isn't
3222
+ # sent to the end recipient.
3223
+ # @return [Boolean]
3224
+ #
3225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessageRequest AWS API Documentation
3226
+ #
3227
+ class SendVoiceMessageRequest < Struct.new(
3228
+ :destination_phone_number,
3229
+ :origination_identity,
3230
+ :message_body,
3231
+ :message_body_text_type,
3232
+ :voice_id,
3233
+ :configuration_set_name,
3234
+ :max_price_per_minute,
3235
+ :time_to_live,
3236
+ :context,
3237
+ :dry_run)
3238
+ SENSITIVE = []
3239
+ include Aws::Structure
3240
+ end
3241
+
3242
+ # @!attribute [rw] message_id
3243
+ # The unique identifier for the message.
3244
+ # @return [String]
3245
+ #
3246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessageResult AWS API Documentation
3247
+ #
3248
+ class SendVoiceMessageResult < Struct.new(
3249
+ :message_id)
3250
+ SENSITIVE = []
3251
+ include Aws::Structure
3252
+ end
3253
+
3254
+ # The alphanumeric sender ID in a specific country that you want to
3255
+ # describe. For more information on sender IDs see [Requesting sender
3256
+ # IDs for SMS messaging with Amazon Pinpoint ][1] in the *Amazon
3257
+ # Pinpoint User Guide*.
3258
+ #
3259
+ #
3260
+ #
3261
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-sender-id.html
3262
+ #
3263
+ # @note When making an API call, you may pass SenderIdAndCountry
3264
+ # data as a hash:
3265
+ #
3266
+ # {
3267
+ # sender_id: "SenderIdOrArn", # required
3268
+ # iso_country_code: "IsoCountryCode", # required
3269
+ # }
3270
+ #
3271
+ # @!attribute [rw] sender_id
3272
+ # The unique identifier of the sender.
3273
+ # @return [String]
3274
+ #
3275
+ # @!attribute [rw] iso_country_code
3276
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
3277
+ # country or region.
3278
+ # @return [String]
3279
+ #
3280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SenderIdAndCountry AWS API Documentation
3281
+ #
3282
+ class SenderIdAndCountry < Struct.new(
3283
+ :sender_id,
3284
+ :iso_country_code)
3285
+ SENSITIVE = []
3286
+ include Aws::Structure
3287
+ end
3288
+
3289
+ # The information for a sender ID that meets a specified criteria.
3290
+ #
3291
+ # @note When making an API call, you may pass SenderIdFilter
3292
+ # data as a hash:
3293
+ #
3294
+ # {
3295
+ # name: "sender-id", # required, accepts sender-id, iso-country-code, message-type
3296
+ # values: ["FilterValue"], # required
3297
+ # }
3298
+ #
3299
+ # @!attribute [rw] name
3300
+ # The name of the attribute to filter on.
3301
+ # @return [String]
3302
+ #
3303
+ # @!attribute [rw] values
3304
+ # An array of values to filter for.
3305
+ # @return [Array<String>]
3306
+ #
3307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SenderIdFilter AWS API Documentation
3308
+ #
3309
+ class SenderIdFilter < Struct.new(
3310
+ :name,
3311
+ :values)
3312
+ SENSITIVE = []
3313
+ include Aws::Structure
3314
+ end
3315
+
3316
+ # The information for all SenderIds in an Amazon Web Services account.
3317
+ #
3318
+ # @!attribute [rw] sender_id_arn
3319
+ # The Amazon Resource Name (ARN) associated with the SenderId.
3320
+ # @return [String]
3321
+ #
3322
+ # @!attribute [rw] sender_id
3323
+ # The alphanumeric sender ID in a specific country that you'd like to
3324
+ # describe.
3325
+ # @return [String]
3326
+ #
3327
+ # @!attribute [rw] iso_country_code
3328
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
3329
+ # country or region.
3330
+ # @return [String]
3331
+ #
3332
+ # @!attribute [rw] message_types
3333
+ # The type of message. Valid values are TRANSACTIONAL for messages
3334
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3335
+ # that aren't critical or time-sensitive.
3336
+ # @return [Array<String>]
3337
+ #
3338
+ # @!attribute [rw] monthly_leasing_price
3339
+ # The monthly leasing price, in US dollars.
3340
+ # @return [String]
3341
+ #
3342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SenderIdInformation AWS API Documentation
3343
+ #
3344
+ class SenderIdInformation < Struct.new(
3345
+ :sender_id_arn,
3346
+ :sender_id,
3347
+ :iso_country_code,
3348
+ :message_types,
3349
+ :monthly_leasing_price)
3350
+ SENSITIVE = []
3351
+ include Aws::Structure
3352
+ end
3353
+
3354
+ # The request would cause a service quota to be exceeded.
3355
+ #
3356
+ # @!attribute [rw] message
3357
+ # @return [String]
3358
+ #
3359
+ # @!attribute [rw] reason
3360
+ # The reason for the exception.
3361
+ # @return [String]
3362
+ #
3363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ServiceQuotaExceededException AWS API Documentation
3364
+ #
3365
+ class ServiceQuotaExceededException < Struct.new(
3366
+ :message,
3367
+ :reason)
3368
+ SENSITIVE = []
3369
+ include Aws::Structure
3370
+ end
3371
+
3372
+ # @note When making an API call, you may pass SetDefaultMessageTypeRequest
3373
+ # data as a hash:
3374
+ #
3375
+ # {
3376
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
3377
+ # message_type: "TRANSACTIONAL", # required, accepts TRANSACTIONAL, PROMOTIONAL
3378
+ # }
3379
+ #
3380
+ # @!attribute [rw] configuration_set_name
3381
+ # The configuration set to update with a new default message type.
3382
+ # This field can be the ConsigurationSetName or ConfigurationSetArn.
3383
+ # @return [String]
3384
+ #
3385
+ # @!attribute [rw] message_type
3386
+ # The type of message. Valid values are TRANSACTIONAL for messages
3387
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3388
+ # that aren't critical or time-sensitive.
3389
+ # @return [String]
3390
+ #
3391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageTypeRequest AWS API Documentation
3392
+ #
3393
+ class SetDefaultMessageTypeRequest < Struct.new(
3394
+ :configuration_set_name,
3395
+ :message_type)
3396
+ SENSITIVE = []
3397
+ include Aws::Structure
3398
+ end
3399
+
3400
+ # @!attribute [rw] configuration_set_arn
3401
+ # The Amazon Resource Name (ARN) of the updated configuration set.
3402
+ # @return [String]
3403
+ #
3404
+ # @!attribute [rw] configuration_set_name
3405
+ # The name of the configuration set that was updated.
3406
+ # @return [String]
3407
+ #
3408
+ # @!attribute [rw] message_type
3409
+ # The new default message type of the configuration set.
3410
+ # @return [String]
3411
+ #
3412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageTypeResult AWS API Documentation
3413
+ #
3414
+ class SetDefaultMessageTypeResult < Struct.new(
3415
+ :configuration_set_arn,
3416
+ :configuration_set_name,
3417
+ :message_type)
3418
+ SENSITIVE = []
3419
+ include Aws::Structure
3420
+ end
3421
+
3422
+ # @note When making an API call, you may pass SetDefaultSenderIdRequest
3423
+ # data as a hash:
3424
+ #
3425
+ # {
3426
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
3427
+ # sender_id: "SenderId", # required
3428
+ # }
3429
+ #
3430
+ # @!attribute [rw] configuration_set_name
3431
+ # The configuration set to updated with a new default SenderId. This
3432
+ # field can be the ConsigurationSetName or ConfigurationSetArn.
3433
+ # @return [String]
3434
+ #
3435
+ # @!attribute [rw] sender_id
3436
+ # The current sender ID for the configuration set. When sending a text
3437
+ # message to a destination country which supports SenderIds, the
3438
+ # default sender ID on the configuration set specified on
3439
+ # SendTextMessage will be used if no dedicated origination phone
3440
+ # numbers or registered SenderIds are available in your account,
3441
+ # instead of a generic sender ID, such as 'NOTICE'.
3442
+ # @return [String]
3443
+ #
3444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultSenderIdRequest AWS API Documentation
3445
+ #
3446
+ class SetDefaultSenderIdRequest < Struct.new(
3447
+ :configuration_set_name,
3448
+ :sender_id)
3449
+ SENSITIVE = []
3450
+ include Aws::Structure
3451
+ end
3452
+
3453
+ # @!attribute [rw] configuration_set_arn
3454
+ # The Amazon Resource Name (ARN) of the updated configuration set.
3455
+ # @return [String]
3456
+ #
3457
+ # @!attribute [rw] configuration_set_name
3458
+ # The name of the configuration set that was updated.
3459
+ # @return [String]
3460
+ #
3461
+ # @!attribute [rw] sender_id
3462
+ # The default sender ID to set for the ConfigurationSet.
3463
+ # @return [String]
3464
+ #
3465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultSenderIdResult AWS API Documentation
3466
+ #
3467
+ class SetDefaultSenderIdResult < Struct.new(
3468
+ :configuration_set_arn,
3469
+ :configuration_set_name,
3470
+ :sender_id)
3471
+ SENSITIVE = []
3472
+ include Aws::Structure
3473
+ end
3474
+
3475
+ # @note When making an API call, you may pass SetTextMessageSpendLimitOverrideRequest
3476
+ # data as a hash:
3477
+ #
3478
+ # {
3479
+ # monthly_limit: 1, # required
3480
+ # }
3481
+ #
3482
+ # @!attribute [rw] monthly_limit
3483
+ # The new monthly limit to enforce on text messages.
3484
+ # @return [Integer]
3485
+ #
3486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetTextMessageSpendLimitOverrideRequest AWS API Documentation
3487
+ #
3488
+ class SetTextMessageSpendLimitOverrideRequest < Struct.new(
3489
+ :monthly_limit)
3490
+ SENSITIVE = []
3491
+ include Aws::Structure
3492
+ end
3493
+
3494
+ # @!attribute [rw] monthly_limit
3495
+ # The current monthly limit to enforce on sending text messages.
3496
+ # @return [Integer]
3497
+ #
3498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetTextMessageSpendLimitOverrideResult AWS API Documentation
3499
+ #
3500
+ class SetTextMessageSpendLimitOverrideResult < Struct.new(
3501
+ :monthly_limit)
3502
+ SENSITIVE = []
3503
+ include Aws::Structure
3504
+ end
3505
+
3506
+ # @note When making an API call, you may pass SetVoiceMessageSpendLimitOverrideRequest
3507
+ # data as a hash:
3508
+ #
3509
+ # {
3510
+ # monthly_limit: 1, # required
3511
+ # }
3512
+ #
3513
+ # @!attribute [rw] monthly_limit
3514
+ # The new monthly limit to enforce on voice messages.
3515
+ # @return [Integer]
3516
+ #
3517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetVoiceMessageSpendLimitOverrideRequest AWS API Documentation
3518
+ #
3519
+ class SetVoiceMessageSpendLimitOverrideRequest < Struct.new(
3520
+ :monthly_limit)
3521
+ SENSITIVE = []
3522
+ include Aws::Structure
3523
+ end
3524
+
3525
+ # @!attribute [rw] monthly_limit
3526
+ # The current monthly limit to enforce on sending voice messages.
3527
+ # @return [Integer]
3528
+ #
3529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetVoiceMessageSpendLimitOverrideResult AWS API Documentation
3530
+ #
3531
+ class SetVoiceMessageSpendLimitOverrideResult < Struct.new(
3532
+ :monthly_limit)
3533
+ SENSITIVE = []
3534
+ include Aws::Structure
3535
+ end
3536
+
3537
+ # An object that defines an Amazon SNS destination for events. You can
3538
+ # use Amazon SNS to send notification when certain events occur.
3539
+ #
3540
+ # @note When making an API call, you may pass SnsDestination
3541
+ # data as a hash:
3542
+ #
3543
+ # {
3544
+ # topic_arn: "SnsTopicArn", # required
3545
+ # }
3546
+ #
3547
+ # @!attribute [rw] topic_arn
3548
+ # The Amazon Resource Name (ARN) of the Amazon SNS topic that you want
3549
+ # to publish events to.
3550
+ # @return [String]
3551
+ #
3552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SnsDestination AWS API Documentation
3553
+ #
3554
+ class SnsDestination < Struct.new(
3555
+ :topic_arn)
3556
+ SENSITIVE = []
3557
+ include Aws::Structure
3558
+ end
3559
+
3560
+ # Describes the current Amazon Pinpoint monthly spend limits for sending
3561
+ # voice and text messages. For more information on increasing your
3562
+ # monthly spend limit, see [ Requesting increases to your monthly SMS
3563
+ # spending quota for Amazon Pinpoint ][1] in the *Amazon Pinpoint User
3564
+ # Guide*.
3565
+ #
3566
+ #
3567
+ #
3568
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-spend-threshold.html
3569
+ #
3570
+ # @!attribute [rw] name
3571
+ # The name for the SpendLimit.
3572
+ # @return [String]
3573
+ #
3574
+ # @!attribute [rw] enforced_limit
3575
+ # The maximum amount of money, in US dollars, that you want to be able
3576
+ # to spend sending messages each month. This value has to be less than
3577
+ # or equal to the amount in `MaxLimit`. To use this custom limit,
3578
+ # `Overridden` must be set to true.
3579
+ # @return [Integer]
3580
+ #
3581
+ # @!attribute [rw] max_limit
3582
+ # The maximum amount of money that you are able to spend to send
3583
+ # messages each month, in US dollars.
3584
+ # @return [Integer]
3585
+ #
3586
+ # @!attribute [rw] overridden
3587
+ # When set to `True`, the value that has been specified in the
3588
+ # `EnforcedLimit` is used to determine the maximum amount in US
3589
+ # dollars that can be spent to send messages each month, in US
3590
+ # dollars.
3591
+ # @return [Boolean]
3592
+ #
3593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SpendLimit AWS API Documentation
3594
+ #
3595
+ class SpendLimit < Struct.new(
3596
+ :name,
3597
+ :enforced_limit,
3598
+ :max_limit,
3599
+ :overridden)
3600
+ SENSITIVE = []
3601
+ include Aws::Structure
3602
+ end
3603
+
3604
+ # The list of tags to be added to the specified topic.
3605
+ #
3606
+ # @note When making an API call, you may pass Tag
3607
+ # data as a hash:
3608
+ #
3609
+ # {
3610
+ # key: "TagKey", # required
3611
+ # value: "TagValue", # required
3612
+ # }
3613
+ #
3614
+ # @!attribute [rw] key
3615
+ # The key identifier, or name, of the tag.
3616
+ # @return [String]
3617
+ #
3618
+ # @!attribute [rw] value
3619
+ # The string value associated with the key of the tag.
3620
+ # @return [String]
3621
+ #
3622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/Tag AWS API Documentation
3623
+ #
3624
+ class Tag < Struct.new(
3625
+ :key,
3626
+ :value)
3627
+ SENSITIVE = []
3628
+ include Aws::Structure
3629
+ end
3630
+
3631
+ # @note When making an API call, you may pass TagResourceRequest
3632
+ # data as a hash:
3633
+ #
3634
+ # {
3635
+ # resource_arn: "AmazonResourceName", # required
3636
+ # tags: [ # required
3637
+ # {
3638
+ # key: "TagKey", # required
3639
+ # value: "TagValue", # required
3640
+ # },
3641
+ # ],
3642
+ # }
3643
+ #
3644
+ # @!attribute [rw] resource_arn
3645
+ # The Amazon Resource Name (ARN) of the resource.
3646
+ # @return [String]
3647
+ #
3648
+ # @!attribute [rw] tags
3649
+ # An array of key and value pair tags that are associated with the
3650
+ # resource.
3651
+ # @return [Array<Types::Tag>]
3652
+ #
3653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/TagResourceRequest AWS API Documentation
3654
+ #
3655
+ class TagResourceRequest < Struct.new(
3656
+ :resource_arn,
3657
+ :tags)
3658
+ SENSITIVE = []
3659
+ include Aws::Structure
3660
+ end
3661
+
3662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/TagResourceResult AWS API Documentation
3663
+ #
3664
+ class TagResourceResult < Aws::EmptyStructure; end
3665
+
3666
+ # An error that occurred because too many requests were sent during a
3667
+ # certain amount of time.
3668
+ #
3669
+ # @!attribute [rw] message
3670
+ # @return [String]
3671
+ #
3672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ThrottlingException AWS API Documentation
3673
+ #
3674
+ class ThrottlingException < Struct.new(
3675
+ :message)
3676
+ SENSITIVE = []
3677
+ include Aws::Structure
3678
+ end
3679
+
3680
+ # @note When making an API call, you may pass UntagResourceRequest
3681
+ # data as a hash:
3682
+ #
3683
+ # {
3684
+ # resource_arn: "AmazonResourceName", # required
3685
+ # tag_keys: ["TagKey"], # required
3686
+ # }
3687
+ #
3688
+ # @!attribute [rw] resource_arn
3689
+ # The Amazon Resource Name (ARN) of the resource.
3690
+ # @return [String]
3691
+ #
3692
+ # @!attribute [rw] tag_keys
3693
+ # An array of tag key values to unassociate with the resource.
3694
+ # @return [Array<String>]
3695
+ #
3696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UntagResourceRequest AWS API Documentation
3697
+ #
3698
+ class UntagResourceRequest < Struct.new(
3699
+ :resource_arn,
3700
+ :tag_keys)
3701
+ SENSITIVE = []
3702
+ include Aws::Structure
3703
+ end
3704
+
3705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UntagResourceResult AWS API Documentation
3706
+ #
3707
+ class UntagResourceResult < Aws::EmptyStructure; end
3708
+
3709
+ # @note When making an API call, you may pass UpdateEventDestinationRequest
3710
+ # data as a hash:
3711
+ #
3712
+ # {
3713
+ # configuration_set_name: "ConfigurationSetNameOrArn", # required
3714
+ # event_destination_name: "EventDestinationName", # required
3715
+ # enabled: false,
3716
+ # matching_event_types: ["ALL"], # accepts ALL, TEXT_ALL, TEXT_SENT, TEXT_PENDING, TEXT_QUEUED, TEXT_SUCCESSFUL, TEXT_DELIVERED, TEXT_INVALID, TEXT_INVALID_MESSAGE, TEXT_UNREACHABLE, TEXT_CARRIER_UNREACHABLE, TEXT_BLOCKED, TEXT_CARRIER_BLOCKED, TEXT_SPAM, TEXT_UNKNOWN, TEXT_TTL_EXPIRED, VOICE_ALL, VOICE_INITIATED, VOICE_RINGING, VOICE_ANSWERED, VOICE_COMPLETED, VOICE_BUSY, VOICE_NO_ANSWER, VOICE_FAILED, VOICE_TTL_EXPIRED
3717
+ # cloud_watch_logs_destination: {
3718
+ # iam_role_arn: "IamRoleArn", # required
3719
+ # log_group_arn: "LogGroupArn", # required
3720
+ # },
3721
+ # kinesis_firehose_destination: {
3722
+ # iam_role_arn: "IamRoleArn", # required
3723
+ # delivery_stream_arn: "DeliveryStreamArn", # required
3724
+ # },
3725
+ # sns_destination: {
3726
+ # topic_arn: "SnsTopicArn", # required
3727
+ # },
3728
+ # }
3729
+ #
3730
+ # @!attribute [rw] configuration_set_name
3731
+ # The configuration set to update with the new event destination.
3732
+ # Valid values for this can be the ConfigurationSetName or
3733
+ # ConfigurationSetArn.
3734
+ # @return [String]
3735
+ #
3736
+ # @!attribute [rw] event_destination_name
3737
+ # The name to use for the event destination.
3738
+ # @return [String]
3739
+ #
3740
+ # @!attribute [rw] enabled
3741
+ # When set to true logging is enabled.
3742
+ # @return [Boolean]
3743
+ #
3744
+ # @!attribute [rw] matching_event_types
3745
+ # An array of event types that determine which events to log.
3746
+ # @return [Array<String>]
3747
+ #
3748
+ # @!attribute [rw] cloud_watch_logs_destination
3749
+ # An object that contains information about an event destination that
3750
+ # sends data to CloudWatch Logs.
3751
+ # @return [Types::CloudWatchLogsDestination]
3752
+ #
3753
+ # @!attribute [rw] kinesis_firehose_destination
3754
+ # An object that contains information about an event destination for
3755
+ # logging to Kinesis Data Firehose.
3756
+ # @return [Types::KinesisFirehoseDestination]
3757
+ #
3758
+ # @!attribute [rw] sns_destination
3759
+ # An object that contains information about an event destination that
3760
+ # sends data to Amazon SNS.
3761
+ # @return [Types::SnsDestination]
3762
+ #
3763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateEventDestinationRequest AWS API Documentation
3764
+ #
3765
+ class UpdateEventDestinationRequest < Struct.new(
3766
+ :configuration_set_name,
3767
+ :event_destination_name,
3768
+ :enabled,
3769
+ :matching_event_types,
3770
+ :cloud_watch_logs_destination,
3771
+ :kinesis_firehose_destination,
3772
+ :sns_destination)
3773
+ SENSITIVE = []
3774
+ include Aws::Structure
3775
+ end
3776
+
3777
+ # @!attribute [rw] configuration_set_arn
3778
+ # The Amazon Resource Name (ARN) for the ConfigurationSet that was
3779
+ # updated.
3780
+ # @return [String]
3781
+ #
3782
+ # @!attribute [rw] configuration_set_name
3783
+ # The name of the configuration set.
3784
+ # @return [String]
3785
+ #
3786
+ # @!attribute [rw] event_destination
3787
+ # An EventDestination object containing the details of where events
3788
+ # will be logged.
3789
+ # @return [Types::EventDestination]
3790
+ #
3791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdateEventDestinationResult AWS API Documentation
3792
+ #
3793
+ class UpdateEventDestinationResult < Struct.new(
3794
+ :configuration_set_arn,
3795
+ :configuration_set_name,
3796
+ :event_destination)
3797
+ SENSITIVE = []
3798
+ include Aws::Structure
3799
+ end
3800
+
3801
+ # @note When making an API call, you may pass UpdatePhoneNumberRequest
3802
+ # data as a hash:
3803
+ #
3804
+ # {
3805
+ # phone_number_id: "PhoneNumberIdOrArn", # required
3806
+ # two_way_enabled: false,
3807
+ # two_way_channel_arn: "TwoWayChannelArn",
3808
+ # self_managed_opt_outs_enabled: false,
3809
+ # opt_out_list_name: "OptOutListNameOrArn",
3810
+ # deletion_protection_enabled: false,
3811
+ # }
3812
+ #
3813
+ # @!attribute [rw] phone_number_id
3814
+ # The unique identifier of the phone number. Valid values for this
3815
+ # field can be either the PhoneNumberId or PhoneNumberArn.
3816
+ # @return [String]
3817
+ #
3818
+ # @!attribute [rw] two_way_enabled
3819
+ # By default this is set to false. When set to true you can receive
3820
+ # incoming text messages from your end recipients.
3821
+ # @return [Boolean]
3822
+ #
3823
+ # @!attribute [rw] two_way_channel_arn
3824
+ # The Amazon Resource Name (ARN) of the two way channel.
3825
+ # @return [String]
3826
+ #
3827
+ # @!attribute [rw] self_managed_opt_outs_enabled
3828
+ # By default this is set to false. When an end recipient sends a
3829
+ # message that begins with HELP or STOP to one of your dedicated
3830
+ # numbers, Amazon Pinpoint automatically replies with a customizable
3831
+ # message and adds the end recipient to the OptOutList. When set to
3832
+ # true you're responsible for responding to HELP and STOP requests.
3833
+ # You're also responsible for tracking and honoring opt-out requests.
3834
+ # @return [Boolean]
3835
+ #
3836
+ # @!attribute [rw] opt_out_list_name
3837
+ # The OptOutList to add the phone number to. Valid values for this
3838
+ # field can be either the OutOutListName or OutOutListArn.
3839
+ # @return [String]
3840
+ #
3841
+ # @!attribute [rw] deletion_protection_enabled
3842
+ # By default this is set to false. When set to true the phone number
3843
+ # can't be deleted.
3844
+ # @return [Boolean]
3845
+ #
3846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePhoneNumberRequest AWS API Documentation
3847
+ #
3848
+ class UpdatePhoneNumberRequest < Struct.new(
3849
+ :phone_number_id,
3850
+ :two_way_enabled,
3851
+ :two_way_channel_arn,
3852
+ :self_managed_opt_outs_enabled,
3853
+ :opt_out_list_name,
3854
+ :deletion_protection_enabled)
3855
+ SENSITIVE = []
3856
+ include Aws::Structure
3857
+ end
3858
+
3859
+ # @!attribute [rw] phone_number_arn
3860
+ # The Amazon Resource Name (ARN) of the updated phone number.
3861
+ # @return [String]
3862
+ #
3863
+ # @!attribute [rw] phone_number_id
3864
+ # The unique identifier of the phone number.
3865
+ # @return [String]
3866
+ #
3867
+ # @!attribute [rw] phone_number
3868
+ # The phone number that was updated.
3869
+ # @return [String]
3870
+ #
3871
+ # @!attribute [rw] status
3872
+ # The current status of the request.
3873
+ # @return [String]
3874
+ #
3875
+ # @!attribute [rw] iso_country_code
3876
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
3877
+ # country or region.
3878
+ # @return [String]
3879
+ #
3880
+ # @!attribute [rw] message_type
3881
+ # The type of message. Valid values are TRANSACTIONAL for messages
3882
+ # that are critical or time-sensitive and PROMOTIONAL for messages
3883
+ # that aren't critical or time-sensitive.
3884
+ # @return [String]
3885
+ #
3886
+ # @!attribute [rw] number_capabilities
3887
+ # Specifies if the number could be used for text messages, voice or
3888
+ # both.
3889
+ # @return [Array<String>]
3890
+ #
3891
+ # @!attribute [rw] number_type
3892
+ # The type of number that was requested.
3893
+ # @return [String]
3894
+ #
3895
+ # @!attribute [rw] monthly_leasing_price
3896
+ # The monthly leasing price of the phone number, in US dollars.
3897
+ # @return [String]
3898
+ #
3899
+ # @!attribute [rw] two_way_enabled
3900
+ # By default this is set to false. When set to true you can receive
3901
+ # incoming text messages from your end recipients.
3902
+ # @return [Boolean]
3903
+ #
3904
+ # @!attribute [rw] two_way_channel_arn
3905
+ # The Amazon Resource Name (ARN) of the two way channel.
3906
+ # @return [String]
3907
+ #
3908
+ # @!attribute [rw] self_managed_opt_outs_enabled
3909
+ # This is true if self managed opt-out are enabled.
3910
+ # @return [Boolean]
3911
+ #
3912
+ # @!attribute [rw] opt_out_list_name
3913
+ # The name of the OptOutList associated with the phone number.
3914
+ # @return [String]
3915
+ #
3916
+ # @!attribute [rw] deletion_protection_enabled
3917
+ # When set to true the phone number can't be deleted.
3918
+ # @return [Boolean]
3919
+ #
3920
+ # @!attribute [rw] created_timestamp
3921
+ # The time when the phone number was created, in [UNIX epoch time][1]
3922
+ # format.
3923
+ #
3924
+ #
3925
+ #
3926
+ # [1]: https://www.epochconverter.com/
3927
+ # @return [Time]
3928
+ #
3929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePhoneNumberResult AWS API Documentation
3930
+ #
3931
+ class UpdatePhoneNumberResult < Struct.new(
3932
+ :phone_number_arn,
3933
+ :phone_number_id,
3934
+ :phone_number,
3935
+ :status,
3936
+ :iso_country_code,
3937
+ :message_type,
3938
+ :number_capabilities,
3939
+ :number_type,
3940
+ :monthly_leasing_price,
3941
+ :two_way_enabled,
3942
+ :two_way_channel_arn,
3943
+ :self_managed_opt_outs_enabled,
3944
+ :opt_out_list_name,
3945
+ :deletion_protection_enabled,
3946
+ :created_timestamp)
3947
+ SENSITIVE = []
3948
+ include Aws::Structure
3949
+ end
3950
+
3951
+ # @note When making an API call, you may pass UpdatePoolRequest
3952
+ # data as a hash:
3953
+ #
3954
+ # {
3955
+ # pool_id: "PoolIdOrArn", # required
3956
+ # two_way_enabled: false,
3957
+ # two_way_channel_arn: "TwoWayChannelArn",
3958
+ # self_managed_opt_outs_enabled: false,
3959
+ # opt_out_list_name: "OptOutListNameOrArn",
3960
+ # shared_routes_enabled: false,
3961
+ # deletion_protection_enabled: false,
3962
+ # }
3963
+ #
3964
+ # @!attribute [rw] pool_id
3965
+ # The unique identifier of the pool to update. Valid values are either
3966
+ # the PoolId or PoolArn.
3967
+ # @return [String]
3968
+ #
3969
+ # @!attribute [rw] two_way_enabled
3970
+ # By default this is set to false. When set to true you can receive
3971
+ # incoming text messages from your end recipients.
3972
+ # @return [Boolean]
3973
+ #
3974
+ # @!attribute [rw] two_way_channel_arn
3975
+ # The Amazon Resource Name (ARN) of the two way channel.
3976
+ # @return [String]
3977
+ #
3978
+ # @!attribute [rw] self_managed_opt_outs_enabled
3979
+ # By default this is set to false. When an end recipient sends a
3980
+ # message that begins with HELP or STOP to one of your dedicated
3981
+ # numbers, Amazon Pinpoint automatically replies with a customizable
3982
+ # message and adds the end recipient to the OptOutList. When set to
3983
+ # true you're responsible for responding to HELP and STOP requests.
3984
+ # You're also responsible for tracking and honoring opt-out requests.
3985
+ # @return [Boolean]
3986
+ #
3987
+ # @!attribute [rw] opt_out_list_name
3988
+ # The OptOutList to associate with the pool. Valid values are either
3989
+ # OptOutListName or OptOutListArn.
3990
+ # @return [String]
3991
+ #
3992
+ # @!attribute [rw] shared_routes_enabled
3993
+ # Indicates whether shared routes are enabled for the pool.
3994
+ # @return [Boolean]
3995
+ #
3996
+ # @!attribute [rw] deletion_protection_enabled
3997
+ # When set to true the pool can't be deleted.
3998
+ # @return [Boolean]
3999
+ #
4000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePoolRequest AWS API Documentation
4001
+ #
4002
+ class UpdatePoolRequest < Struct.new(
4003
+ :pool_id,
4004
+ :two_way_enabled,
4005
+ :two_way_channel_arn,
4006
+ :self_managed_opt_outs_enabled,
4007
+ :opt_out_list_name,
4008
+ :shared_routes_enabled,
4009
+ :deletion_protection_enabled)
4010
+ SENSITIVE = []
4011
+ include Aws::Structure
4012
+ end
4013
+
4014
+ # @!attribute [rw] pool_arn
4015
+ # The ARN of the pool.
4016
+ # @return [String]
4017
+ #
4018
+ # @!attribute [rw] pool_id
4019
+ # The unique identifier of the pool.
4020
+ # @return [String]
4021
+ #
4022
+ # @!attribute [rw] status
4023
+ # The current status of the pool update request.
4024
+ # @return [String]
4025
+ #
4026
+ # @!attribute [rw] message_type
4027
+ # The type of message for the pool to use.
4028
+ # @return [String]
4029
+ #
4030
+ # @!attribute [rw] two_way_enabled
4031
+ # By default this is set to false. When set to true you can receive
4032
+ # incoming text messages from your end recipients.
4033
+ # @return [Boolean]
4034
+ #
4035
+ # @!attribute [rw] two_way_channel_arn
4036
+ # The Amazon Resource Name (ARN) of the two way channel.
4037
+ # @return [String]
4038
+ #
4039
+ # @!attribute [rw] self_managed_opt_outs_enabled
4040
+ # When an end recipient sends a message that begins with HELP or STOP
4041
+ # to one of your dedicated numbers, Amazon Pinpoint automatically
4042
+ # replies with a customizable message and adds the end recipient to
4043
+ # the OptOutList. When set to true you're responsible for responding
4044
+ # to HELP and STOP requests. You're also responsible for tracking and
4045
+ # honoring opt-out requests.
4046
+ # @return [Boolean]
4047
+ #
4048
+ # @!attribute [rw] opt_out_list_name
4049
+ # The name of the OptOutList associated with the pool.
4050
+ # @return [String]
4051
+ #
4052
+ # @!attribute [rw] shared_routes_enabled
4053
+ # Indicates whether shared routes are enabled for the pool.
4054
+ # @return [Boolean]
4055
+ #
4056
+ # @!attribute [rw] deletion_protection_enabled
4057
+ # When set to true the pool can't be deleted.
4058
+ # @return [Boolean]
4059
+ #
4060
+ # @!attribute [rw] created_timestamp
4061
+ # The time when the pool was created, in [UNIX epoch time][1] format.
4062
+ #
4063
+ #
4064
+ #
4065
+ # [1]: https://www.epochconverter.com/
4066
+ # @return [Time]
4067
+ #
4068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/UpdatePoolResult AWS API Documentation
4069
+ #
4070
+ class UpdatePoolResult < Struct.new(
4071
+ :pool_arn,
4072
+ :pool_id,
4073
+ :status,
4074
+ :message_type,
4075
+ :two_way_enabled,
4076
+ :two_way_channel_arn,
4077
+ :self_managed_opt_outs_enabled,
4078
+ :opt_out_list_name,
4079
+ :shared_routes_enabled,
4080
+ :deletion_protection_enabled,
4081
+ :created_timestamp)
4082
+ SENSITIVE = []
4083
+ include Aws::Structure
4084
+ end
4085
+
4086
+ # A validation exception for a field.
4087
+ #
4088
+ # @!attribute [rw] message
4089
+ # @return [String]
4090
+ #
4091
+ # @!attribute [rw] reason
4092
+ # The reason for the exception.
4093
+ # @return [String]
4094
+ #
4095
+ # @!attribute [rw] fields
4096
+ # The field that failed validation.
4097
+ # @return [Array<Types::ValidationExceptionField>]
4098
+ #
4099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ValidationException AWS API Documentation
4100
+ #
4101
+ class ValidationException < Struct.new(
4102
+ :message,
4103
+ :reason,
4104
+ :fields)
4105
+ SENSITIVE = []
4106
+ include Aws::Structure
4107
+ end
4108
+
4109
+ # The field associated with the validation exception.
4110
+ #
4111
+ # @!attribute [rw] name
4112
+ # The name of the field.
4113
+ # @return [String]
4114
+ #
4115
+ # @!attribute [rw] message
4116
+ # The message associated with the validation exception with
4117
+ # information to help determine its cause.
4118
+ # @return [String]
4119
+ #
4120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ValidationExceptionField AWS API Documentation
4121
+ #
4122
+ class ValidationExceptionField < Struct.new(
4123
+ :name,
4124
+ :message)
4125
+ SENSITIVE = []
4126
+ include Aws::Structure
4127
+ end
4128
+
4129
+ end
4130
+ end