aws-sdk-pinpointsmsvoicev2 1.30.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -268,6 +268,10 @@ module Aws::PinpointSMSVoiceV2
268
268
  # The default sender ID used by the ConfigurationSet.
269
269
  # @return [String]
270
270
  #
271
+ # @!attribute [rw] default_message_feedback_enabled
272
+ # True if message feedback is enabled.
273
+ # @return [Boolean]
274
+ #
271
275
  # @!attribute [rw] created_timestamp
272
276
  # The time when the ConfigurationSet was created, in [UNIX epoch
273
277
  # time][1] format.
@@ -289,6 +293,7 @@ module Aws::PinpointSMSVoiceV2
289
293
  :event_destinations,
290
294
  :default_message_type,
291
295
  :default_sender_id,
296
+ :default_message_feedback_enabled,
292
297
  :created_timestamp,
293
298
  :protect_configuration_id)
294
299
  SENSITIVE = []
@@ -1231,6 +1236,11 @@ module Aws::PinpointSMSVoiceV2
1231
1236
  # The default Sender ID of the configuration set that was deleted.
1232
1237
  # @return [String]
1233
1238
  #
1239
+ # @!attribute [rw] default_message_feedback_enabled
1240
+ # True if the configuration set has message feedback enabled. By
1241
+ # default this is set to false.
1242
+ # @return [Boolean]
1243
+ #
1234
1244
  # @!attribute [rw] created_timestamp
1235
1245
  # The time that the deleted configuration set was created in [UNIX
1236
1246
  # epoch time][1] format.
@@ -1248,6 +1258,7 @@ module Aws::PinpointSMSVoiceV2
1248
1258
  :event_destinations,
1249
1259
  :default_message_type,
1250
1260
  :default_sender_id,
1261
+ :default_message_feedback_enabled,
1251
1262
  :created_timestamp)
1252
1263
  SENSITIVE = []
1253
1264
  include Aws::Structure
@@ -1695,6 +1706,75 @@ module Aws::PinpointSMSVoiceV2
1695
1706
  include Aws::Structure
1696
1707
  end
1697
1708
 
1709
+ # @!attribute [rw] protect_configuration_id
1710
+ # The unique identifier for the protect configuration.
1711
+ # @return [String]
1712
+ #
1713
+ # @!attribute [rw] destination_phone_number
1714
+ # The destination phone number in E.164 format.
1715
+ # @return [String]
1716
+ #
1717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteProtectConfigurationRuleSetNumberOverrideRequest AWS API Documentation
1718
+ #
1719
+ class DeleteProtectConfigurationRuleSetNumberOverrideRequest < Struct.new(
1720
+ :protect_configuration_id,
1721
+ :destination_phone_number)
1722
+ SENSITIVE = []
1723
+ include Aws::Structure
1724
+ end
1725
+
1726
+ # @!attribute [rw] protect_configuration_arn
1727
+ # The Amazon Resource Name (ARN) of the protect configuration.
1728
+ # @return [String]
1729
+ #
1730
+ # @!attribute [rw] protect_configuration_id
1731
+ # The unique identifier for the protect configuration.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] destination_phone_number
1735
+ # The destination phone number in E.164 format.
1736
+ # @return [String]
1737
+ #
1738
+ # @!attribute [rw] created_timestamp
1739
+ # The time when the rule was created, in [UNIX epoch time][1] format.
1740
+ #
1741
+ #
1742
+ #
1743
+ # [1]: https://www.epochconverter.com/
1744
+ # @return [Time]
1745
+ #
1746
+ # @!attribute [rw] action
1747
+ # The action associated with the rule.
1748
+ # @return [String]
1749
+ #
1750
+ # @!attribute [rw] iso_country_code
1751
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
1752
+ # country or region.
1753
+ # @return [String]
1754
+ #
1755
+ # @!attribute [rw] expiration_timestamp
1756
+ # The time when the resource-based policy was created, in [UNIX epoch
1757
+ # time][1] format.
1758
+ #
1759
+ #
1760
+ #
1761
+ # [1]: https://www.epochconverter.com/
1762
+ # @return [Time]
1763
+ #
1764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteProtectConfigurationRuleSetNumberOverrideResult AWS API Documentation
1765
+ #
1766
+ class DeleteProtectConfigurationRuleSetNumberOverrideResult < Struct.new(
1767
+ :protect_configuration_arn,
1768
+ :protect_configuration_id,
1769
+ :destination_phone_number,
1770
+ :created_timestamp,
1771
+ :action,
1772
+ :iso_country_code,
1773
+ :expiration_timestamp)
1774
+ SENSITIVE = []
1775
+ include Aws::Structure
1776
+ end
1777
+
1698
1778
  # @!attribute [rw] registration_attachment_id
1699
1779
  # The unique identifier for the registration attachment.
1700
1780
  # @return [String]
@@ -2993,7 +3073,7 @@ module Aws::PinpointSMSVoiceV2
2993
3073
  end
2994
3074
 
2995
3075
  # @!attribute [rw] verified_destination_number_ids
2996
- # An array of VerifiedDestinationNumberid to retreive.
3076
+ # An array of VerifiedDestinationNumberid to retrieve.
2997
3077
  # @return [Array<String>]
2998
3078
  #
2999
3079
  # @!attribute [rw] destination_phone_numbers
@@ -3533,6 +3613,63 @@ module Aws::PinpointSMSVoiceV2
3533
3613
  include Aws::Structure
3534
3614
  end
3535
3615
 
3616
+ # @!attribute [rw] protect_configuration_id
3617
+ # The unique identifier for the protect configuration.
3618
+ # @return [String]
3619
+ #
3620
+ # @!attribute [rw] filters
3621
+ # An array of ProtectConfigurationRuleSetNumberOverrideFilterItem
3622
+ # objects to filter the results.
3623
+ # @return [Array<Types::ProtectConfigurationRuleSetNumberOverrideFilterItem>]
3624
+ #
3625
+ # @!attribute [rw] next_token
3626
+ # The token to be used for the next set of paginated results. You
3627
+ # don't need to supply a value for this field in the initial request.
3628
+ # @return [String]
3629
+ #
3630
+ # @!attribute [rw] max_results
3631
+ # The maximum number of results to return per each request.
3632
+ # @return [Integer]
3633
+ #
3634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListProtectConfigurationRuleSetNumberOverridesRequest AWS API Documentation
3635
+ #
3636
+ class ListProtectConfigurationRuleSetNumberOverridesRequest < Struct.new(
3637
+ :protect_configuration_id,
3638
+ :filters,
3639
+ :next_token,
3640
+ :max_results)
3641
+ SENSITIVE = []
3642
+ include Aws::Structure
3643
+ end
3644
+
3645
+ # @!attribute [rw] protect_configuration_arn
3646
+ # The Amazon Resource Name (ARN) of the protect configuration.
3647
+ # @return [String]
3648
+ #
3649
+ # @!attribute [rw] protect_configuration_id
3650
+ # The unique identifier for the protect configuration.
3651
+ # @return [String]
3652
+ #
3653
+ # @!attribute [rw] rule_set_number_overrides
3654
+ # An array of RuleSetNumberOverrides objects.
3655
+ # @return [Array<Types::ProtectConfigurationRuleSetNumberOverride>]
3656
+ #
3657
+ # @!attribute [rw] next_token
3658
+ # The token to be used for the next set of paginated results. You
3659
+ # don't need to supply a value for this field in the initial request.
3660
+ # @return [String]
3661
+ #
3662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ListProtectConfigurationRuleSetNumberOverridesResult AWS API Documentation
3663
+ #
3664
+ class ListProtectConfigurationRuleSetNumberOverridesResult < Struct.new(
3665
+ :protect_configuration_arn,
3666
+ :protect_configuration_id,
3667
+ :rule_set_number_overrides,
3668
+ :next_token)
3669
+ SENSITIVE = []
3670
+ include Aws::Structure
3671
+ end
3672
+
3536
3673
  # @!attribute [rw] registration_id
3537
3674
  # The unique identifier for the registration.
3538
3675
  # @return [String]
@@ -4089,6 +4226,67 @@ module Aws::PinpointSMSVoiceV2
4089
4226
  include Aws::Structure
4090
4227
  end
4091
4228
 
4229
+ # Provides details on a RuleSetNumberOverride.
4230
+ #
4231
+ # @!attribute [rw] destination_phone_number
4232
+ # The destination phone number in E.164 format.
4233
+ # @return [String]
4234
+ #
4235
+ # @!attribute [rw] created_timestamp
4236
+ # The time when the rule was created, in [UNIX epoch time][1] format.
4237
+ #
4238
+ #
4239
+ #
4240
+ # [1]: https://www.epochconverter.com/
4241
+ # @return [Time]
4242
+ #
4243
+ # @!attribute [rw] action
4244
+ # The action for the rule to perform of either blocking or allowing
4245
+ # messages to the destination phone number.
4246
+ # @return [String]
4247
+ #
4248
+ # @!attribute [rw] iso_country_code
4249
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4250
+ # country or region.
4251
+ # @return [String]
4252
+ #
4253
+ # @!attribute [rw] expiration_timestamp
4254
+ # The time the rule will expire at. If `ExpirationTimestamp` is not
4255
+ # set then the rule will not expire.
4256
+ # @return [Time]
4257
+ #
4258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ProtectConfigurationRuleSetNumberOverride AWS API Documentation
4259
+ #
4260
+ class ProtectConfigurationRuleSetNumberOverride < Struct.new(
4261
+ :destination_phone_number,
4262
+ :created_timestamp,
4263
+ :action,
4264
+ :iso_country_code,
4265
+ :expiration_timestamp)
4266
+ SENSITIVE = []
4267
+ include Aws::Structure
4268
+ end
4269
+
4270
+ # The information for a protect configuration rule set number override
4271
+ # that meets a specified criteria.
4272
+ #
4273
+ # @!attribute [rw] name
4274
+ # The name of the attribute to filter on.
4275
+ # @return [String]
4276
+ #
4277
+ # @!attribute [rw] values
4278
+ # An array values to filter for.
4279
+ # @return [Array<String>]
4280
+ #
4281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ProtectConfigurationRuleSetNumberOverrideFilterItem AWS API Documentation
4282
+ #
4283
+ class ProtectConfigurationRuleSetNumberOverrideFilterItem < Struct.new(
4284
+ :name,
4285
+ :values)
4286
+ SENSITIVE = []
4287
+ include Aws::Structure
4288
+ end
4289
+
4092
4290
  # @!attribute [rw] origination_identity
4093
4291
  # The origination identity to use such as a PhoneNumberId,
4094
4292
  # PhoneNumberArn, SenderId or SenderIdArn. You can use
@@ -4161,6 +4359,40 @@ module Aws::PinpointSMSVoiceV2
4161
4359
  include Aws::Structure
4162
4360
  end
4163
4361
 
4362
+ # @!attribute [rw] message_id
4363
+ # The unique identifier for the message.
4364
+ # @return [String]
4365
+ #
4366
+ # @!attribute [rw] message_feedback_status
4367
+ # Set the message feedback to be either `RECEIVED` or `FAILED`.
4368
+ # @return [String]
4369
+ #
4370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutMessageFeedbackRequest AWS API Documentation
4371
+ #
4372
+ class PutMessageFeedbackRequest < Struct.new(
4373
+ :message_id,
4374
+ :message_feedback_status)
4375
+ SENSITIVE = []
4376
+ include Aws::Structure
4377
+ end
4378
+
4379
+ # @!attribute [rw] message_id
4380
+ # The unique identifier for the message.
4381
+ # @return [String]
4382
+ #
4383
+ # @!attribute [rw] message_feedback_status
4384
+ # The current status of the message.
4385
+ # @return [String]
4386
+ #
4387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutMessageFeedbackResult AWS API Documentation
4388
+ #
4389
+ class PutMessageFeedbackResult < Struct.new(
4390
+ :message_id,
4391
+ :message_feedback_status)
4392
+ SENSITIVE = []
4393
+ include Aws::Structure
4394
+ end
4395
+
4164
4396
  # @!attribute [rw] opt_out_list_name
4165
4397
  # The OptOutListName or OptOutListArn to add the phone number to.
4166
4398
  #
@@ -4219,6 +4451,93 @@ module Aws::PinpointSMSVoiceV2
4219
4451
  include Aws::Structure
4220
4452
  end
4221
4453
 
4454
+ # @!attribute [rw] client_token
4455
+ # Unique, case-sensitive identifier that you provide to ensure the
4456
+ # idempotency of the request. If you don't specify a client token, a
4457
+ # randomly generated token is used for the request to ensure
4458
+ # idempotency.
4459
+ #
4460
+ # **A suitable default value is auto-generated.** You should normally
4461
+ # not need to pass this option.
4462
+ # @return [String]
4463
+ #
4464
+ # @!attribute [rw] protect_configuration_id
4465
+ # The unique identifier for the protect configuration.
4466
+ # @return [String]
4467
+ #
4468
+ # @!attribute [rw] destination_phone_number
4469
+ # The destination phone number in E.164 format.
4470
+ # @return [String]
4471
+ #
4472
+ # @!attribute [rw] action
4473
+ # The action for the rule to either block or allow messages to the
4474
+ # destination phone number.
4475
+ # @return [String]
4476
+ #
4477
+ # @!attribute [rw] expiration_timestamp
4478
+ # The time the rule will expire at. If `ExpirationTimestamp` is not
4479
+ # set then the rule does not expire.
4480
+ # @return [Time]
4481
+ #
4482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutProtectConfigurationRuleSetNumberOverrideRequest AWS API Documentation
4483
+ #
4484
+ class PutProtectConfigurationRuleSetNumberOverrideRequest < Struct.new(
4485
+ :client_token,
4486
+ :protect_configuration_id,
4487
+ :destination_phone_number,
4488
+ :action,
4489
+ :expiration_timestamp)
4490
+ SENSITIVE = []
4491
+ include Aws::Structure
4492
+ end
4493
+
4494
+ # @!attribute [rw] protect_configuration_arn
4495
+ # The Amazon Resource Name (ARN) of the protect configuration.
4496
+ # @return [String]
4497
+ #
4498
+ # @!attribute [rw] protect_configuration_id
4499
+ # The unique identifier for the protect configuration.
4500
+ # @return [String]
4501
+ #
4502
+ # @!attribute [rw] destination_phone_number
4503
+ # The destination phone number in E.164 format.
4504
+ # @return [String]
4505
+ #
4506
+ # @!attribute [rw] created_timestamp
4507
+ # The time when the rule was created, in [UNIX epoch time][1] format.
4508
+ #
4509
+ #
4510
+ #
4511
+ # [1]: https://www.epochconverter.com/
4512
+ # @return [Time]
4513
+ #
4514
+ # @!attribute [rw] action
4515
+ # The action for the rule to take.
4516
+ # @return [String]
4517
+ #
4518
+ # @!attribute [rw] iso_country_code
4519
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
4520
+ # country or region.
4521
+ # @return [String]
4522
+ #
4523
+ # @!attribute [rw] expiration_timestamp
4524
+ # The time the rule will expire at.
4525
+ # @return [Time]
4526
+ #
4527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutProtectConfigurationRuleSetNumberOverrideResult AWS API Documentation
4528
+ #
4529
+ class PutProtectConfigurationRuleSetNumberOverrideResult < Struct.new(
4530
+ :protect_configuration_arn,
4531
+ :protect_configuration_id,
4532
+ :destination_phone_number,
4533
+ :created_timestamp,
4534
+ :action,
4535
+ :iso_country_code,
4536
+ :expiration_timestamp)
4537
+ SENSITIVE = []
4538
+ include Aws::Structure
4539
+ end
4540
+
4222
4541
  # @!attribute [rw] registration_id
4223
4542
  # The unique identifier for the registration.
4224
4543
  # @return [String]
@@ -5709,7 +6028,8 @@ module Aws::PinpointSMSVoiceV2
5709
6028
  # @return [String]
5710
6029
  #
5711
6030
  # @!attribute [rw] time_to_live
5712
- # How long the text message is valid for. By default this is 72 hours.
6031
+ # How long the media message is valid for. By default this is 72
6032
+ # hours.
5713
6033
  # @return [Integer]
5714
6034
  #
5715
6035
  # @!attribute [rw] context
@@ -5726,6 +6046,12 @@ module Aws::PinpointSMSVoiceV2
5726
6046
  # The unique identifier of the protect configuration to use.
5727
6047
  # @return [String]
5728
6048
  #
6049
+ # @!attribute [rw] message_feedback_enabled
6050
+ # Set to true to enable message feedback for the message. When a user
6051
+ # receives the message you need to update the message status using
6052
+ # PutMessageFeedback.
6053
+ # @return [Boolean]
6054
+ #
5729
6055
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendMediaMessageRequest AWS API Documentation
5730
6056
  #
5731
6057
  class SendMediaMessageRequest < Struct.new(
@@ -5738,7 +6064,8 @@ module Aws::PinpointSMSVoiceV2
5738
6064
  :time_to_live,
5739
6065
  :context,
5740
6066
  :dry_run,
5741
- :protect_configuration_id)
6067
+ :protect_configuration_id,
6068
+ :message_feedback_enabled)
5742
6069
  SENSITIVE = []
5743
6070
  include Aws::Structure
5744
6071
  end
@@ -5849,6 +6176,12 @@ module Aws::PinpointSMSVoiceV2
5849
6176
  # The unique identifier for the protect configuration.
5850
6177
  # @return [String]
5851
6178
  #
6179
+ # @!attribute [rw] message_feedback_enabled
6180
+ # Set to true to enable message feedback for the message. When a user
6181
+ # receives the message you need to update the message status using
6182
+ # PutMessageFeedback.
6183
+ # @return [Boolean]
6184
+ #
5852
6185
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessageRequest AWS API Documentation
5853
6186
  #
5854
6187
  class SendTextMessageRequest < Struct.new(
@@ -5863,7 +6196,8 @@ module Aws::PinpointSMSVoiceV2
5863
6196
  :context,
5864
6197
  :destination_country_parameters,
5865
6198
  :dry_run,
5866
- :protect_configuration_id)
6199
+ :protect_configuration_id,
6200
+ :message_feedback_enabled)
5867
6201
  SENSITIVE = []
5868
6202
  include Aws::Structure
5869
6203
  end
@@ -5948,6 +6282,12 @@ module Aws::PinpointSMSVoiceV2
5948
6282
  # The unique identifier for the protect configuration.
5949
6283
  # @return [String]
5950
6284
  #
6285
+ # @!attribute [rw] message_feedback_enabled
6286
+ # Set to true to enable message feedback for the message. When a user
6287
+ # receives the message you need to update the message status using
6288
+ # PutMessageFeedback.
6289
+ # @return [Boolean]
6290
+ #
5951
6291
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessageRequest AWS API Documentation
5952
6292
  #
5953
6293
  class SendVoiceMessageRequest < Struct.new(
@@ -5961,7 +6301,8 @@ module Aws::PinpointSMSVoiceV2
5961
6301
  :time_to_live,
5962
6302
  :context,
5963
6303
  :dry_run,
5964
- :protect_configuration_id)
6304
+ :protect_configuration_id,
6305
+ :message_feedback_enabled)
5965
6306
  SENSITIVE = []
5966
6307
  include Aws::Structure
5967
6308
  end
@@ -6125,6 +6466,46 @@ module Aws::PinpointSMSVoiceV2
6125
6466
  include Aws::Structure
6126
6467
  end
6127
6468
 
6469
+ # @!attribute [rw] configuration_set_name
6470
+ # The name of the configuration set to use. This can be either the
6471
+ # ConfigurationSetName or ConfigurationSetArn.
6472
+ # @return [String]
6473
+ #
6474
+ # @!attribute [rw] message_feedback_enabled
6475
+ # Set to true to enable message feedback.
6476
+ # @return [Boolean]
6477
+ #
6478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageFeedbackEnabledRequest AWS API Documentation
6479
+ #
6480
+ class SetDefaultMessageFeedbackEnabledRequest < Struct.new(
6481
+ :configuration_set_name,
6482
+ :message_feedback_enabled)
6483
+ SENSITIVE = []
6484
+ include Aws::Structure
6485
+ end
6486
+
6487
+ # @!attribute [rw] configuration_set_arn
6488
+ # The arn of the configuration set.
6489
+ # @return [String]
6490
+ #
6491
+ # @!attribute [rw] configuration_set_name
6492
+ # The name of the configuration.
6493
+ # @return [String]
6494
+ #
6495
+ # @!attribute [rw] message_feedback_enabled
6496
+ # True if message feedback is enabled.
6497
+ # @return [Boolean]
6498
+ #
6499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SetDefaultMessageFeedbackEnabledResult AWS API Documentation
6500
+ #
6501
+ class SetDefaultMessageFeedbackEnabledResult < Struct.new(
6502
+ :configuration_set_arn,
6503
+ :configuration_set_name,
6504
+ :message_feedback_enabled)
6505
+ SENSITIVE = []
6506
+ include Aws::Structure
6507
+ end
6508
+
6128
6509
  # @!attribute [rw] configuration_set_name
6129
6510
  # The configuration set to update with a new default message type.
6130
6511
  # This field can be the ConsigurationSetName or ConfigurationSetArn.
@@ -55,7 +55,7 @@ module Aws::PinpointSMSVoiceV2
55
55
  autoload :EndpointProvider, 'aws-sdk-pinpointsmsvoicev2/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-pinpointsmsvoicev2/endpoints'
57
57
 
58
- GEM_VERSION = '1.30.0'
58
+ GEM_VERSION = '1.31.0'
59
59
 
60
60
  end
61
61