aws-sdk-pinpointsmsvoicev2 1.29.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +286 -13
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +169 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +488 -76
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- data/sig/client.rbs +93 -6
- data/sig/types.rbs +106 -7
- metadata +2 -2
@@ -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 = []
|
@@ -962,27 +967,30 @@ module Aws::PinpointSMSVoiceV2
|
|
962
967
|
# @!attribute [rw] registration_status
|
963
968
|
# The status of the registration.
|
964
969
|
#
|
970
|
+
# * `CLOSED`: The phone number or sender ID has been deleted and you
|
971
|
+
# must also delete the registration for the number.
|
972
|
+
#
|
965
973
|
# * `CREATED`: Your registration is created but not submitted.
|
966
974
|
#
|
967
|
-
# * `
|
968
|
-
#
|
975
|
+
# * `COMPLETE`: Your registration has been approved and your
|
976
|
+
# origination identity has been created.
|
969
977
|
#
|
970
|
-
# * `
|
971
|
-
# reviewed.
|
978
|
+
# * `DELETED`: The registration has been deleted.
|
972
979
|
#
|
973
980
|
# * `PROVISIONING`: Your registration has been approved and your
|
974
981
|
# origination identity is being created.
|
975
982
|
#
|
976
|
-
# * `
|
977
|
-
#
|
983
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
984
|
+
# authentication.
|
978
985
|
#
|
979
986
|
# * `REQUIRES_UPDATES`: You must fix your registration and resubmit
|
980
987
|
# it.
|
981
988
|
#
|
982
|
-
# * `
|
983
|
-
#
|
989
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
990
|
+
# reviewed.
|
984
991
|
#
|
985
|
-
# * `
|
992
|
+
# * `SUBMITTED`: Your registration has been submitted and is awaiting
|
993
|
+
# review.
|
986
994
|
# @return [String]
|
987
995
|
#
|
988
996
|
# @!attribute [rw] current_version_number
|
@@ -1050,26 +1058,29 @@ module Aws::PinpointSMSVoiceV2
|
|
1050
1058
|
# @!attribute [rw] registration_version_status
|
1051
1059
|
# The status of the registration.
|
1052
1060
|
#
|
1053
|
-
# * `
|
1054
|
-
# created.
|
1055
|
-
#
|
1056
|
-
# * `SUBMITTED`: Your registration has been submitted.
|
1061
|
+
# * `APPROVED`: Your registration has been approved.
|
1057
1062
|
#
|
1058
|
-
# * `
|
1059
|
-
#
|
1063
|
+
# * `ARCHIVED`: Your previously approved registration version moves
|
1064
|
+
# into this status when a more recently submitted version is
|
1065
|
+
# approved.
|
1060
1066
|
#
|
1061
|
-
# * `
|
1067
|
+
# * `DENIED`: You must fix your registration and resubmit it.
|
1062
1068
|
#
|
1063
1069
|
# * `DISCARDED`: You've abandon this version of their registration to
|
1064
1070
|
# start over with a new version.
|
1065
1071
|
#
|
1066
|
-
# * `
|
1072
|
+
# * `DRAFT`: The initial status of a registration version after it’s
|
1073
|
+
# created.
|
1074
|
+
#
|
1075
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
1076
|
+
# authentication.
|
1077
|
+
#
|
1078
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
1079
|
+
# reviewed.
|
1067
1080
|
#
|
1068
1081
|
# * `REVOKED`: Your previously approved registration has been revoked.
|
1069
1082
|
#
|
1070
|
-
# * `
|
1071
|
-
# into this status when a more recently submitted version is
|
1072
|
-
# approved.
|
1083
|
+
# * `SUBMITTED`: Your registration has been submitted.
|
1073
1084
|
# @return [String]
|
1074
1085
|
#
|
1075
1086
|
# @!attribute [rw] registration_version_status_history
|
@@ -1225,6 +1236,11 @@ module Aws::PinpointSMSVoiceV2
|
|
1225
1236
|
# The default Sender ID of the configuration set that was deleted.
|
1226
1237
|
# @return [String]
|
1227
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
|
+
#
|
1228
1244
|
# @!attribute [rw] created_timestamp
|
1229
1245
|
# The time that the deleted configuration set was created in [UNIX
|
1230
1246
|
# epoch time][1] format.
|
@@ -1242,6 +1258,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1242
1258
|
:event_destinations,
|
1243
1259
|
:default_message_type,
|
1244
1260
|
:default_sender_id,
|
1261
|
+
:default_message_feedback_enabled,
|
1245
1262
|
:created_timestamp)
|
1246
1263
|
SENSITIVE = []
|
1247
1264
|
include Aws::Structure
|
@@ -1689,6 +1706,75 @@ module Aws::PinpointSMSVoiceV2
|
|
1689
1706
|
include Aws::Structure
|
1690
1707
|
end
|
1691
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
|
+
|
1692
1778
|
# @!attribute [rw] registration_attachment_id
|
1693
1779
|
# The unique identifier for the registration attachment.
|
1694
1780
|
# @return [String]
|
@@ -1834,27 +1920,30 @@ module Aws::PinpointSMSVoiceV2
|
|
1834
1920
|
# @!attribute [rw] registration_status
|
1835
1921
|
# The status of the registration.
|
1836
1922
|
#
|
1923
|
+
# * `CLOSED`: The phone number or sender ID has been deleted and you
|
1924
|
+
# must also delete the registration for the number.
|
1925
|
+
#
|
1837
1926
|
# * `CREATED`: Your registration is created but not submitted.
|
1838
1927
|
#
|
1839
|
-
# * `
|
1840
|
-
#
|
1928
|
+
# * `COMPLETE`: Your registration has been approved and your
|
1929
|
+
# origination identity has been created.
|
1841
1930
|
#
|
1842
|
-
# * `
|
1843
|
-
# reviewed.
|
1931
|
+
# * `DELETED`: The registration has been deleted.
|
1844
1932
|
#
|
1845
1933
|
# * `PROVISIONING`: Your registration has been approved and your
|
1846
1934
|
# origination identity is being created.
|
1847
1935
|
#
|
1848
|
-
# * `
|
1849
|
-
#
|
1936
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
1937
|
+
# authentication.
|
1850
1938
|
#
|
1851
1939
|
# * `REQUIRES_UPDATES`: You must fix your registration and resubmit
|
1852
1940
|
# it.
|
1853
1941
|
#
|
1854
|
-
# * `
|
1855
|
-
#
|
1942
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
1943
|
+
# reviewed.
|
1856
1944
|
#
|
1857
|
-
# * `
|
1945
|
+
# * `SUBMITTED`: Your registration has been submitted and is awaiting
|
1946
|
+
# review.
|
1858
1947
|
# @return [String]
|
1859
1948
|
#
|
1860
1949
|
# @!attribute [rw] current_version_number
|
@@ -2984,7 +3073,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2984
3073
|
end
|
2985
3074
|
|
2986
3075
|
# @!attribute [rw] verified_destination_number_ids
|
2987
|
-
# An array of VerifiedDestinationNumberid to
|
3076
|
+
# An array of VerifiedDestinationNumberid to retrieve.
|
2988
3077
|
# @return [Array<String>]
|
2989
3078
|
#
|
2990
3079
|
# @!attribute [rw] destination_phone_numbers
|
@@ -3186,26 +3275,29 @@ module Aws::PinpointSMSVoiceV2
|
|
3186
3275
|
# @!attribute [rw] registration_version_status
|
3187
3276
|
# The status of the registration version.
|
3188
3277
|
#
|
3189
|
-
# * `
|
3190
|
-
# created.
|
3191
|
-
#
|
3192
|
-
# * `SUBMITTED`: Your registration has been submitted.
|
3278
|
+
# * `APPROVED`: Your registration has been approved.
|
3193
3279
|
#
|
3194
|
-
# * `
|
3195
|
-
#
|
3280
|
+
# * `ARCHIVED`: Your previously approved registration version moves
|
3281
|
+
# into this status when a more recently submitted version is
|
3282
|
+
# approved.
|
3196
3283
|
#
|
3197
|
-
# * `
|
3284
|
+
# * `DENIED`: You must fix your registration and resubmit it.
|
3198
3285
|
#
|
3199
3286
|
# * `DISCARDED`: You've abandon this version of their registration to
|
3200
3287
|
# start over with a new version.
|
3201
3288
|
#
|
3202
|
-
# * `
|
3289
|
+
# * `DRAFT`: The initial status of a registration version after it’s
|
3290
|
+
# created.
|
3291
|
+
#
|
3292
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
3293
|
+
# authentication.
|
3294
|
+
#
|
3295
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
3296
|
+
# reviewed.
|
3203
3297
|
#
|
3204
3298
|
# * `REVOKED`: Your previously approved registration has been revoked.
|
3205
3299
|
#
|
3206
|
-
# * `
|
3207
|
-
# into this status when a more recently submitted version is
|
3208
|
-
# approved.
|
3300
|
+
# * `SUBMITTED`: Your registration has been submitted.
|
3209
3301
|
# @return [String]
|
3210
3302
|
#
|
3211
3303
|
# @!attribute [rw] registration_version_status_history
|
@@ -3521,6 +3613,63 @@ module Aws::PinpointSMSVoiceV2
|
|
3521
3613
|
include Aws::Structure
|
3522
3614
|
end
|
3523
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
|
+
|
3524
3673
|
# @!attribute [rw] registration_id
|
3525
3674
|
# The unique identifier for the registration.
|
3526
3675
|
# @return [String]
|
@@ -4077,6 +4226,67 @@ module Aws::PinpointSMSVoiceV2
|
|
4077
4226
|
include Aws::Structure
|
4078
4227
|
end
|
4079
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
|
+
|
4080
4290
|
# @!attribute [rw] origination_identity
|
4081
4291
|
# The origination identity to use such as a PhoneNumberId,
|
4082
4292
|
# PhoneNumberArn, SenderId or SenderIdArn. You can use
|
@@ -4149,6 +4359,40 @@ module Aws::PinpointSMSVoiceV2
|
|
4149
4359
|
include Aws::Structure
|
4150
4360
|
end
|
4151
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
|
+
|
4152
4396
|
# @!attribute [rw] opt_out_list_name
|
4153
4397
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
4154
4398
|
#
|
@@ -4207,6 +4451,93 @@ module Aws::PinpointSMSVoiceV2
|
|
4207
4451
|
include Aws::Structure
|
4208
4452
|
end
|
4209
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
|
+
|
4210
4541
|
# @!attribute [rw] registration_id
|
4211
4542
|
# The unique identifier for the registration.
|
4212
4543
|
# @return [String]
|
@@ -4656,27 +4987,30 @@ module Aws::PinpointSMSVoiceV2
|
|
4656
4987
|
# @!attribute [rw] registration_status
|
4657
4988
|
# The status of the registration.
|
4658
4989
|
#
|
4990
|
+
# * `CLOSED`: The phone number or sender ID has been deleted and you
|
4991
|
+
# must also delete the registration for the number.
|
4992
|
+
#
|
4659
4993
|
# * `CREATED`: Your registration is created but not submitted.
|
4660
4994
|
#
|
4661
|
-
# * `
|
4662
|
-
#
|
4995
|
+
# * `COMPLETE`: Your registration has been approved and your
|
4996
|
+
# origination identity has been created.
|
4663
4997
|
#
|
4664
|
-
# * `
|
4665
|
-
# reviewed.
|
4998
|
+
# * `DELETED`: The registration has been deleted.
|
4666
4999
|
#
|
4667
5000
|
# * `PROVISIONING`: Your registration has been approved and your
|
4668
5001
|
# origination identity is being created.
|
4669
5002
|
#
|
4670
|
-
# * `
|
4671
|
-
#
|
5003
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
5004
|
+
# authentication.
|
4672
5005
|
#
|
4673
5006
|
# * `REQUIRES_UPDATES`: You must fix your registration and resubmit
|
4674
5007
|
# it.
|
4675
5008
|
#
|
4676
|
-
# * `
|
4677
|
-
#
|
5009
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
5010
|
+
# reviewed.
|
4678
5011
|
#
|
4679
|
-
# * `
|
5012
|
+
# * `SUBMITTED`: Your registration has been submitted and is awaiting
|
5013
|
+
# review.
|
4680
5014
|
# @return [String]
|
4681
5015
|
#
|
4682
5016
|
# @!attribute [rw] current_version_number
|
@@ -4882,26 +5216,29 @@ module Aws::PinpointSMSVoiceV2
|
|
4882
5216
|
# @!attribute [rw] registration_version_status
|
4883
5217
|
# The status of the registration.
|
4884
5218
|
#
|
4885
|
-
# * `
|
4886
|
-
# created.
|
4887
|
-
#
|
4888
|
-
# * `SUBMITTED`: Your registration has been submitted.
|
5219
|
+
# * `APPROVED`: Your registration has been approved.
|
4889
5220
|
#
|
4890
|
-
# * `
|
4891
|
-
#
|
5221
|
+
# * `ARCHIVED`: Your previously approved registration version moves
|
5222
|
+
# into this status when a more recently submitted version is
|
5223
|
+
# approved.
|
4892
5224
|
#
|
4893
|
-
# * `
|
5225
|
+
# * `DENIED`: You must fix your registration and resubmit it.
|
4894
5226
|
#
|
4895
5227
|
# * `DISCARDED`: You've abandon this version of their registration to
|
4896
5228
|
# start over with a new version.
|
4897
5229
|
#
|
4898
|
-
# * `
|
5230
|
+
# * `DRAFT`: The initial status of a registration version after it’s
|
5231
|
+
# created.
|
5232
|
+
#
|
5233
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
5234
|
+
# authentication.
|
5235
|
+
#
|
5236
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
5237
|
+
# reviewed.
|
4899
5238
|
#
|
4900
5239
|
# * `REVOKED`: Your previously approved registration has been revoked.
|
4901
5240
|
#
|
4902
|
-
# * `
|
4903
|
-
# into this status when a more recently submitted version is
|
4904
|
-
# approved.
|
5241
|
+
# * `SUBMITTED`: Your registration has been submitted.
|
4905
5242
|
# @return [String]
|
4906
5243
|
#
|
4907
5244
|
# @!attribute [rw] registration_version_status_history
|
@@ -4954,6 +5291,15 @@ module Aws::PinpointSMSVoiceV2
|
|
4954
5291
|
# [1]: https://www.epochconverter.com/
|
4955
5292
|
# @return [Time]
|
4956
5293
|
#
|
5294
|
+
# @!attribute [rw] requires_authentication_timestamp
|
5295
|
+
# The time when the registration was in the requires authentication
|
5296
|
+
# state, in [UNIX epoch time][1] format.
|
5297
|
+
#
|
5298
|
+
#
|
5299
|
+
#
|
5300
|
+
# [1]: https://www.epochconverter.com/
|
5301
|
+
# @return [Time]
|
5302
|
+
#
|
4957
5303
|
# @!attribute [rw] approved_timestamp
|
4958
5304
|
# The time when the registration was in the approved state, in [UNIX
|
4959
5305
|
# epoch time][1] format.
|
@@ -5005,6 +5351,7 @@ module Aws::PinpointSMSVoiceV2
|
|
5005
5351
|
:draft_timestamp,
|
5006
5352
|
:submitted_timestamp,
|
5007
5353
|
:reviewing_timestamp,
|
5354
|
+
:requires_authentication_timestamp,
|
5008
5355
|
:approved_timestamp,
|
5009
5356
|
:discarded_timestamp,
|
5010
5357
|
:denied_timestamp,
|
@@ -5681,7 +6028,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5681
6028
|
# @return [String]
|
5682
6029
|
#
|
5683
6030
|
# @!attribute [rw] time_to_live
|
5684
|
-
# How long the
|
6031
|
+
# How long the media message is valid for. By default this is 72
|
6032
|
+
# hours.
|
5685
6033
|
# @return [Integer]
|
5686
6034
|
#
|
5687
6035
|
# @!attribute [rw] context
|
@@ -5698,6 +6046,12 @@ module Aws::PinpointSMSVoiceV2
|
|
5698
6046
|
# The unique identifier of the protect configuration to use.
|
5699
6047
|
# @return [String]
|
5700
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
|
+
#
|
5701
6055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendMediaMessageRequest AWS API Documentation
|
5702
6056
|
#
|
5703
6057
|
class SendMediaMessageRequest < Struct.new(
|
@@ -5710,7 +6064,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5710
6064
|
:time_to_live,
|
5711
6065
|
:context,
|
5712
6066
|
:dry_run,
|
5713
|
-
:protect_configuration_id
|
6067
|
+
:protect_configuration_id,
|
6068
|
+
:message_feedback_enabled)
|
5714
6069
|
SENSITIVE = []
|
5715
6070
|
include Aws::Structure
|
5716
6071
|
end
|
@@ -5821,6 +6176,12 @@ module Aws::PinpointSMSVoiceV2
|
|
5821
6176
|
# The unique identifier for the protect configuration.
|
5822
6177
|
# @return [String]
|
5823
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
|
+
#
|
5824
6185
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendTextMessageRequest AWS API Documentation
|
5825
6186
|
#
|
5826
6187
|
class SendTextMessageRequest < Struct.new(
|
@@ -5835,7 +6196,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5835
6196
|
:context,
|
5836
6197
|
:destination_country_parameters,
|
5837
6198
|
:dry_run,
|
5838
|
-
:protect_configuration_id
|
6199
|
+
:protect_configuration_id,
|
6200
|
+
:message_feedback_enabled)
|
5839
6201
|
SENSITIVE = []
|
5840
6202
|
include Aws::Structure
|
5841
6203
|
end
|
@@ -5920,6 +6282,12 @@ module Aws::PinpointSMSVoiceV2
|
|
5920
6282
|
# The unique identifier for the protect configuration.
|
5921
6283
|
# @return [String]
|
5922
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
|
+
#
|
5923
6291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SendVoiceMessageRequest AWS API Documentation
|
5924
6292
|
#
|
5925
6293
|
class SendVoiceMessageRequest < Struct.new(
|
@@ -5933,7 +6301,8 @@ module Aws::PinpointSMSVoiceV2
|
|
5933
6301
|
:time_to_live,
|
5934
6302
|
:context,
|
5935
6303
|
:dry_run,
|
5936
|
-
:protect_configuration_id
|
6304
|
+
:protect_configuration_id,
|
6305
|
+
:message_feedback_enabled)
|
5937
6306
|
SENSITIVE = []
|
5938
6307
|
include Aws::Structure
|
5939
6308
|
end
|
@@ -6097,6 +6466,46 @@ module Aws::PinpointSMSVoiceV2
|
|
6097
6466
|
include Aws::Structure
|
6098
6467
|
end
|
6099
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
|
+
|
6100
6509
|
# @!attribute [rw] configuration_set_name
|
6101
6510
|
# The configuration set to update with a new default message type.
|
6102
6511
|
# This field can be the ConsigurationSetName or ConfigurationSetArn.
|
@@ -6342,26 +6751,29 @@ module Aws::PinpointSMSVoiceV2
|
|
6342
6751
|
# @!attribute [rw] registration_version_status
|
6343
6752
|
# The status of the registration version.
|
6344
6753
|
#
|
6345
|
-
# * `
|
6346
|
-
# created.
|
6347
|
-
#
|
6348
|
-
# * `SUBMITTED`: Your registration has been submitted.
|
6754
|
+
# * `APPROVED`: Your registration has been approved.
|
6349
6755
|
#
|
6350
|
-
# * `
|
6351
|
-
#
|
6756
|
+
# * `ARCHIVED`: Your previously approved registration version moves
|
6757
|
+
# into this status when a more recently submitted version is
|
6758
|
+
# approved.
|
6352
6759
|
#
|
6353
|
-
# * `
|
6760
|
+
# * `DENIED`: You must fix your registration and resubmit it.
|
6354
6761
|
#
|
6355
6762
|
# * `DISCARDED`: You've abandon this version of their registration to
|
6356
6763
|
# start over with a new version.
|
6357
6764
|
#
|
6358
|
-
# * `
|
6765
|
+
# * `DRAFT`: The initial status of a registration version after it’s
|
6766
|
+
# created.
|
6767
|
+
#
|
6768
|
+
# * `REQUIRES_AUTHENTICATION`: You need to complete email
|
6769
|
+
# authentication.
|
6770
|
+
#
|
6771
|
+
# * `REVIEWING`: Your registration has been accepted and is being
|
6772
|
+
# reviewed.
|
6359
6773
|
#
|
6360
6774
|
# * `REVOKED`: Your previously approved registration has been revoked.
|
6361
6775
|
#
|
6362
|
-
# * `
|
6363
|
-
# into this status when a more recently submitted version is
|
6364
|
-
# approved.
|
6776
|
+
# * `SUBMITTED`: Your registration has been submitted.
|
6365
6777
|
# @return [String]
|
6366
6778
|
#
|
6367
6779
|
# @!attribute [rw] registration_version_status_history
|