aws-sdk-pinpointsmsvoicev2 1.48.0 → 1.49.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +103 -88
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +5 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +106 -71
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- data/sig/client.rbs +8 -6
- data/sig/types.rbs +12 -7
- metadata +1 -1
|
@@ -1477,6 +1477,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1477
1477
|
RegistrationFieldValueInformation.add_member(:text_value, Shapes::ShapeRef.new(shape: TextValue, location_name: "TextValue"))
|
|
1478
1478
|
RegistrationFieldValueInformation.add_member(:registration_attachment_id, Shapes::ShapeRef.new(shape: RegistrationAttachmentIdOrArn, location_name: "RegistrationAttachmentId"))
|
|
1479
1479
|
RegistrationFieldValueInformation.add_member(:denied_reason, Shapes::ShapeRef.new(shape: String, location_name: "DeniedReason"))
|
|
1480
|
+
RegistrationFieldValueInformation.add_member(:feedback, Shapes::ShapeRef.new(shape: String, location_name: "Feedback"))
|
|
1480
1481
|
RegistrationFieldValueInformation.struct_class = Types::RegistrationFieldValueInformation
|
|
1481
1482
|
|
|
1482
1483
|
RegistrationFieldValueInformationList.member = Shapes::ShapeRef.new(shape: RegistrationFieldValueInformation)
|
|
@@ -1547,6 +1548,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1547
1548
|
RegistrationVersionInformation.add_member(:registration_version_status, Shapes::ShapeRef.new(shape: RegistrationVersionStatus, required: true, location_name: "RegistrationVersionStatus"))
|
|
1548
1549
|
RegistrationVersionInformation.add_member(:registration_version_status_history, Shapes::ShapeRef.new(shape: RegistrationVersionStatusHistory, required: true, location_name: "RegistrationVersionStatusHistory"))
|
|
1549
1550
|
RegistrationVersionInformation.add_member(:denied_reasons, Shapes::ShapeRef.new(shape: RegistrationDeniedReasonInformationList, location_name: "DeniedReasons"))
|
|
1551
|
+
RegistrationVersionInformation.add_member(:feedback, Shapes::ShapeRef.new(shape: String, location_name: "Feedback"))
|
|
1550
1552
|
RegistrationVersionInformation.struct_class = Types::RegistrationVersionInformation
|
|
1551
1553
|
|
|
1552
1554
|
RegistrationVersionInformationList.member = Shapes::ShapeRef.new(shape: RegistrationVersionInformation)
|
|
@@ -1555,6 +1557,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1555
1557
|
|
|
1556
1558
|
RegistrationVersionStatusHistory.add_member(:draft_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "DraftTimestamp"))
|
|
1557
1559
|
RegistrationVersionStatusHistory.add_member(:submitted_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmittedTimestamp"))
|
|
1560
|
+
RegistrationVersionStatusHistory.add_member(:aws_reviewing_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "AwsReviewingTimestamp"))
|
|
1558
1561
|
RegistrationVersionStatusHistory.add_member(:reviewing_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ReviewingTimestamp"))
|
|
1559
1562
|
RegistrationVersionStatusHistory.add_member(:requires_authentication_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "RequiresAuthenticationTimestamp"))
|
|
1560
1563
|
RegistrationVersionStatusHistory.add_member(:approved_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ApprovedTimestamp"))
|
|
@@ -1832,6 +1835,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1832
1835
|
StringMap.value = Shapes::ShapeRef.new(shape: String)
|
|
1833
1836
|
|
|
1834
1837
|
SubmitRegistrationVersionRequest.add_member(:registration_id, Shapes::ShapeRef.new(shape: RegistrationIdOrArn, required: true, location_name: "RegistrationId"))
|
|
1838
|
+
SubmitRegistrationVersionRequest.add_member(:aws_review, Shapes::ShapeRef.new(shape: PrimitiveBoolean, location_name: "AwsReview"))
|
|
1835
1839
|
SubmitRegistrationVersionRequest.struct_class = Types::SubmitRegistrationVersionRequest
|
|
1836
1840
|
|
|
1837
1841
|
SubmitRegistrationVersionResult.add_member(:registration_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "RegistrationArn"))
|
|
@@ -1839,6 +1843,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1839
1843
|
SubmitRegistrationVersionResult.add_member(:version_number, Shapes::ShapeRef.new(shape: RegistrationVersionNumber, required: true, location_name: "VersionNumber"))
|
|
1840
1844
|
SubmitRegistrationVersionResult.add_member(:registration_version_status, Shapes::ShapeRef.new(shape: RegistrationVersionStatus, required: true, location_name: "RegistrationVersionStatus"))
|
|
1841
1845
|
SubmitRegistrationVersionResult.add_member(:registration_version_status_history, Shapes::ShapeRef.new(shape: RegistrationVersionStatusHistory, required: true, location_name: "RegistrationVersionStatusHistory"))
|
|
1846
|
+
SubmitRegistrationVersionResult.add_member(:aws_review, Shapes::ShapeRef.new(shape: PrimitiveBoolean, required: true, location_name: "AwsReview"))
|
|
1842
1847
|
SubmitRegistrationVersionResult.struct_class = Types::SubmitRegistrationVersionResult
|
|
1843
1848
|
|
|
1844
1849
|
SupportedAssociation.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ResourceType"))
|
|
@@ -80,7 +80,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
80
80
|
# the PoolId or PoolArn, and you can find these values using
|
|
81
81
|
# [DescribePools][1].
|
|
82
82
|
#
|
|
83
|
-
# If you are using a shared End User
|
|
83
|
+
# If you are using a shared End User Messaging SMS; resource then you
|
|
84
84
|
# must use the full Amazon Resource Name(ARN).
|
|
85
85
|
#
|
|
86
86
|
#
|
|
@@ -95,7 +95,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
95
95
|
# PhoneNumberArn, while DescribeSenderIds can be used to get the
|
|
96
96
|
# values for SenderId and SenderIdArn.
|
|
97
97
|
#
|
|
98
|
-
# If you are using a shared End User
|
|
98
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
99
99
|
# must use the full Amazon Resource Name(ARN).
|
|
100
100
|
# @return [String]
|
|
101
101
|
#
|
|
@@ -226,18 +226,16 @@ module Aws::PinpointSMSVoiceV2
|
|
|
226
226
|
# @return [String]
|
|
227
227
|
#
|
|
228
228
|
# @!attribute [rw] dialing_country_code
|
|
229
|
-
# The numeric dialing code for the
|
|
230
|
-
# number was originally registered.
|
|
229
|
+
# The country or region numeric dialing code for the phone number.
|
|
231
230
|
# @return [String]
|
|
232
231
|
#
|
|
233
232
|
# @!attribute [rw] iso_country_code
|
|
234
|
-
# The two-character code, in ISO 3166-1 alpha-2
|
|
235
|
-
#
|
|
233
|
+
# The two-character country or region code, in ISO 3166-1 alpha-2
|
|
234
|
+
# format, for the phone number.
|
|
236
235
|
# @return [String]
|
|
237
236
|
#
|
|
238
237
|
# @!attribute [rw] country
|
|
239
|
-
# The name of the country
|
|
240
|
-
# registered.
|
|
238
|
+
# The name of the country or region for the phone number.
|
|
241
239
|
# @return [String]
|
|
242
240
|
#
|
|
243
241
|
# @!attribute [rw] mcc
|
|
@@ -486,7 +484,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
486
484
|
#
|
|
487
485
|
# @!attribute [rw] matching_event_types
|
|
488
486
|
# An array of event types that determine which events to log. If
|
|
489
|
-
# "ALL" is used, then End User
|
|
487
|
+
# "ALL" is used, then End User Messaging SMS logs every event type.
|
|
490
488
|
#
|
|
491
489
|
# <note markdown="1"> The `TEXT_SENT` event type is not supported.
|
|
492
490
|
#
|
|
@@ -625,7 +623,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
625
623
|
# After the pool is created you can add more origination identities to
|
|
626
624
|
# the pool by using [AssociateOriginationIdentity][3].
|
|
627
625
|
#
|
|
628
|
-
# If you are using a shared End User
|
|
626
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
629
627
|
# must use the full Amazon Resource Name(ARN).
|
|
630
628
|
#
|
|
631
629
|
#
|
|
@@ -723,7 +721,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
723
721
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
724
722
|
# By default this is set to false. When set to false, and an end
|
|
725
723
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
726
|
-
# your dedicated numbers, End User
|
|
724
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
727
725
|
# with a customizable message and adds the end recipient to the
|
|
728
726
|
# OptOutList. When set to true you're responsible for responding to
|
|
729
727
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -1471,7 +1469,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1471
1469
|
# to find the values for PhoneNumberId and PhoneNumberArn and
|
|
1472
1470
|
# DescribePools to find the values of PoolId and PoolArn.
|
|
1473
1471
|
#
|
|
1474
|
-
# If you are using a shared End User
|
|
1472
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
1475
1473
|
# must use the full Amazon Resource Name(ARN).
|
|
1476
1474
|
# @return [String]
|
|
1477
1475
|
#
|
|
@@ -1543,7 +1541,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1543
1541
|
# can use DescribeOptOutLists to find the values for OptOutListName
|
|
1544
1542
|
# and OptOutListArn.
|
|
1545
1543
|
#
|
|
1546
|
-
# If you are using a shared End User
|
|
1544
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
1547
1545
|
# must use the full Amazon Resource Name(ARN).
|
|
1548
1546
|
# @return [String]
|
|
1549
1547
|
#
|
|
@@ -1585,7 +1583,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1585
1583
|
# @!attribute [rw] opt_out_list_name
|
|
1586
1584
|
# The OptOutListName or OptOutListArn to remove the phone number from.
|
|
1587
1585
|
#
|
|
1588
|
-
# If you are using a shared End User
|
|
1586
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
1589
1587
|
# must use the full Amazon Resource Name(ARN).
|
|
1590
1588
|
# @return [String]
|
|
1591
1589
|
#
|
|
@@ -1644,7 +1642,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1644
1642
|
# The PoolId or PoolArn of the pool to delete. You can use
|
|
1645
1643
|
# DescribePools to find the values for PoolId and PoolArn .
|
|
1646
1644
|
#
|
|
1647
|
-
# If you are using a shared End User
|
|
1645
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
1648
1646
|
# must use the full Amazon Resource Name(ARN).
|
|
1649
1647
|
# @return [String]
|
|
1650
1648
|
#
|
|
@@ -1696,7 +1694,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1696
1694
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
1697
1695
|
# By default this is set to false. When set to false and an end
|
|
1698
1696
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
1699
|
-
# your dedicated numbers, End User
|
|
1697
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
1700
1698
|
# with a customizable message and adds the end recipient to the
|
|
1701
1699
|
# OptOutList. When set to true you're responsible for responding to
|
|
1702
1700
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -2073,8 +2071,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2073
2071
|
end
|
|
2074
2072
|
|
|
2075
2073
|
# @!attribute [rw] resource_arn
|
|
2076
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
2077
|
-
# you're deleting the resource-based policy from.
|
|
2074
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
2075
|
+
# resource you're deleting the resource-based policy from.
|
|
2078
2076
|
# @return [String]
|
|
2079
2077
|
#
|
|
2080
2078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteResourcePolicyRequest AWS API Documentation
|
|
@@ -2086,8 +2084,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2086
2084
|
end
|
|
2087
2085
|
|
|
2088
2086
|
# @!attribute [rw] resource_arn
|
|
2089
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
2090
|
-
# that the resource-based policy was deleted from.
|
|
2087
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
2088
|
+
# resource that the resource-based policy was deleted from.
|
|
2091
2089
|
# @return [String]
|
|
2092
2090
|
#
|
|
2093
2091
|
# @!attribute [rw] policy
|
|
@@ -2320,7 +2318,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2320
2318
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
|
2321
2319
|
# for SenderId and SenderIdArn.
|
|
2322
2320
|
#
|
|
2323
|
-
# If you are using a shared End User
|
|
2321
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
2324
2322
|
# must use the full Amazon Resource Name(ARN).
|
|
2325
2323
|
# @return [String]
|
|
2326
2324
|
#
|
|
@@ -2387,7 +2385,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2387
2385
|
# The OptOutLists to show the details of. This is an array of strings
|
|
2388
2386
|
# that can be either the OptOutListName or OptOutListArn.
|
|
2389
2387
|
#
|
|
2390
|
-
# If you are using a shared End User
|
|
2388
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
2391
2389
|
# must use the full Amazon Resource Name(ARN).
|
|
2392
2390
|
# @return [Array<String>]
|
|
2393
2391
|
#
|
|
@@ -2442,7 +2440,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2442
2440
|
# DescribeOptOutLists to find the values for OptOutListName and
|
|
2443
2441
|
# OptOutListArn.
|
|
2444
2442
|
#
|
|
2445
|
-
# If you are using a shared End User
|
|
2443
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
2446
2444
|
# must use the full Amazon Resource Name(ARN).
|
|
2447
2445
|
# @return [String]
|
|
2448
2446
|
#
|
|
@@ -2512,7 +2510,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2512
2510
|
# This is an array of strings that can be either the PhoneNumberId or
|
|
2513
2511
|
# PhoneNumberArn.
|
|
2514
2512
|
#
|
|
2515
|
-
# If you are using a shared End User
|
|
2513
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
2516
2514
|
# must use the full Amazon Resource Name(ARN).
|
|
2517
2515
|
# @return [Array<String>]
|
|
2518
2516
|
#
|
|
@@ -2571,7 +2569,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2571
2569
|
# The unique identifier of pools to find. This is an array of strings
|
|
2572
2570
|
# that can be either the PoolId or PoolArn.
|
|
2573
2571
|
#
|
|
2574
|
-
# If you are using a shared End User
|
|
2572
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
2575
2573
|
# must use the full Amazon Resource Name(ARN).
|
|
2576
2574
|
# @return [Array<String>]
|
|
2577
2575
|
#
|
|
@@ -3064,7 +3062,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3064
3062
|
# @!attribute [rw] sender_ids
|
|
3065
3063
|
# An array of SenderIdAndCountry objects to search for.
|
|
3066
3064
|
#
|
|
3067
|
-
# If you are using a shared End User
|
|
3065
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
3068
3066
|
# must use the full Amazon Resource Name(ARN).
|
|
3069
3067
|
# @return [Array<Types::SenderIdAndCountry>]
|
|
3070
3068
|
#
|
|
@@ -3213,7 +3211,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3213
3211
|
# origination identity. This value can be either the PoolId or
|
|
3214
3212
|
# PoolArn.
|
|
3215
3213
|
#
|
|
3216
|
-
# If you are using a shared End User
|
|
3214
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
3217
3215
|
# must use the full Amazon Resource Name(ARN).
|
|
3218
3216
|
# @return [String]
|
|
3219
3217
|
#
|
|
@@ -3224,7 +3222,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3224
3222
|
# PhoneNumberArn, or use DescribeSenderIds to get the values for
|
|
3225
3223
|
# SenderId and SenderIdArn.
|
|
3226
3224
|
#
|
|
3227
|
-
# If you are using a shared End User
|
|
3225
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
3228
3226
|
# must use the full Amazon Resource Name(ARN).
|
|
3229
3227
|
# @return [String]
|
|
3230
3228
|
#
|
|
@@ -3487,7 +3485,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3487
3485
|
# contain the details for the requested NumberCapability. The Key is
|
|
3488
3486
|
# the two-letter ISO country code. For a list of supported ISO country
|
|
3489
3487
|
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
|
3490
|
-
# End User
|
|
3488
|
+
# End User Messaging SMS User Guide.
|
|
3491
3489
|
#
|
|
3492
3490
|
#
|
|
3493
3491
|
#
|
|
@@ -3506,8 +3504,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3506
3504
|
end
|
|
3507
3505
|
|
|
3508
3506
|
# @!attribute [rw] resource_arn
|
|
3509
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
3510
|
-
# attached to the resource-based policy.
|
|
3507
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
3508
|
+
# resource attached to the resource-based policy.
|
|
3511
3509
|
# @return [String]
|
|
3512
3510
|
#
|
|
3513
3511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetResourcePolicyRequest AWS API Documentation
|
|
@@ -3519,13 +3517,13 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3519
3517
|
end
|
|
3520
3518
|
|
|
3521
3519
|
# @!attribute [rw] resource_arn
|
|
3522
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
3523
|
-
# attached to the resource-based policy.
|
|
3520
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
3521
|
+
# resource attached to the resource-based policy.
|
|
3524
3522
|
# @return [String]
|
|
3525
3523
|
#
|
|
3526
3524
|
# @!attribute [rw] policy
|
|
3527
3525
|
# The JSON formatted string that contains the resource-based policy
|
|
3528
|
-
# attached to the End User
|
|
3526
|
+
# attached to the End User Messaging SMS resource.
|
|
3529
3527
|
# @return [String]
|
|
3530
3528
|
#
|
|
3531
3529
|
# @!attribute [rw] created_timestamp
|
|
@@ -3640,7 +3638,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3640
3638
|
# The unique identifier for the pool. This value can be either the
|
|
3641
3639
|
# PoolId or PoolArn.
|
|
3642
3640
|
#
|
|
3643
|
-
# If you are using a shared End User
|
|
3641
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
3644
3642
|
# must use the full Amazon Resource Name(ARN).
|
|
3645
3643
|
# @return [String]
|
|
3646
3644
|
#
|
|
@@ -4041,7 +4039,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4041
4039
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
4042
4040
|
# When set to false and an end recipient sends a message that begins
|
|
4043
4041
|
# with HELP or STOP to one of your dedicated numbers, End User
|
|
4044
|
-
#
|
|
4042
|
+
# Messaging SMS automatically replies with a customizable message and
|
|
4045
4043
|
# adds the end recipient to the OptOutList. When set to true you're
|
|
4046
4044
|
# responsible for responding to HELP and STOP requests. You're also
|
|
4047
4045
|
# responsible for tracking and honoring opt-out request. For more
|
|
@@ -4163,12 +4161,12 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4163
4161
|
#
|
|
4164
4162
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
4165
4163
|
# When set to false, an end recipient sends a message that begins with
|
|
4166
|
-
# HELP or STOP to one of your dedicated numbers, End User
|
|
4167
|
-
# automatically replies with a customizable message and adds the
|
|
4168
|
-
# recipient to the OptOutList. When set to true you're
|
|
4169
|
-
# for responding to HELP and STOP requests. You're also
|
|
4170
|
-
# for tracking and honoring opt-out requests. For more
|
|
4171
|
-
# [Self-managed opt-outs][1]
|
|
4164
|
+
# HELP or STOP to one of your dedicated numbers, End User Messaging
|
|
4165
|
+
# SMS automatically replies with a customizable message and adds the
|
|
4166
|
+
# end recipient to the OptOutList. When set to true you're
|
|
4167
|
+
# responsible for responding to HELP and STOP requests. You're also
|
|
4168
|
+
# responsible for tracking and honoring opt-out requests. For more
|
|
4169
|
+
# information see [Self-managed opt-outs][1]
|
|
4172
4170
|
#
|
|
4173
4171
|
#
|
|
4174
4172
|
#
|
|
@@ -4385,7 +4383,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4385
4383
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
|
4386
4384
|
# for SenderId and SenderIdArn.
|
|
4387
4385
|
#
|
|
4388
|
-
# If you are using a shared End User
|
|
4386
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
4389
4387
|
# must use the full Amazon Resource Name(ARN).
|
|
4390
4388
|
# @return [String]
|
|
4391
4389
|
#
|
|
@@ -4487,7 +4485,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4487
4485
|
# @!attribute [rw] opt_out_list_name
|
|
4488
4486
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
|
4489
4487
|
#
|
|
4490
|
-
# If you are using a shared End User
|
|
4488
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
4491
4489
|
# must use the full Amazon Resource Name(ARN).
|
|
4492
4490
|
# @return [String]
|
|
4493
4491
|
#
|
|
@@ -4706,8 +4704,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4706
4704
|
end
|
|
4707
4705
|
|
|
4708
4706
|
# @!attribute [rw] resource_arn
|
|
4709
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
4710
|
-
# to attach the resource-based policy to.
|
|
4707
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
4708
|
+
# resource to attach the resource-based policy to.
|
|
4711
4709
|
# @return [String]
|
|
4712
4710
|
#
|
|
4713
4711
|
# @!attribute [rw] policy
|
|
@@ -4724,8 +4722,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4724
4722
|
end
|
|
4725
4723
|
|
|
4726
4724
|
# @!attribute [rw] resource_arn
|
|
4727
|
-
# The Amazon Resource Name (ARN) of the End User
|
|
4728
|
-
# attached to the resource-based policy.
|
|
4725
|
+
# The Amazon Resource Name (ARN) of the End User Messaging SMS
|
|
4726
|
+
# resource attached to the resource-based policy.
|
|
4729
4727
|
# @return [String]
|
|
4730
4728
|
#
|
|
4731
4729
|
# @!attribute [rw] policy
|
|
@@ -5028,6 +5026,12 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5028
5026
|
# A description of why the registration was denied.
|
|
5029
5027
|
# @return [String]
|
|
5030
5028
|
#
|
|
5029
|
+
# @!attribute [rw] feedback
|
|
5030
|
+
# Feedback provided for this specific field during the registration
|
|
5031
|
+
# review process. This may include validation errors, suggestions for
|
|
5032
|
+
# improvement, or additional requirements.
|
|
5033
|
+
# @return [String]
|
|
5034
|
+
#
|
|
5031
5035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationFieldValueInformation AWS API Documentation
|
|
5032
5036
|
#
|
|
5033
5037
|
class RegistrationFieldValueInformation < Struct.new(
|
|
@@ -5035,7 +5039,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5035
5039
|
:select_choices,
|
|
5036
5040
|
:text_value,
|
|
5037
5041
|
:registration_attachment_id,
|
|
5038
|
-
:denied_reason
|
|
5042
|
+
:denied_reason,
|
|
5043
|
+
:feedback)
|
|
5039
5044
|
SENSITIVE = []
|
|
5040
5045
|
include Aws::Structure
|
|
5041
5046
|
end
|
|
@@ -5341,13 +5346,20 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5341
5346
|
# An array of RegistrationDeniedReasonInformation objects.
|
|
5342
5347
|
# @return [Array<Types::RegistrationDeniedReasonInformation>]
|
|
5343
5348
|
#
|
|
5349
|
+
# @!attribute [rw] feedback
|
|
5350
|
+
# Feedback information provided during the registration review
|
|
5351
|
+
# process. This includes comments, suggestions, or additional
|
|
5352
|
+
# requirements.
|
|
5353
|
+
# @return [String]
|
|
5354
|
+
#
|
|
5344
5355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/RegistrationVersionInformation AWS API Documentation
|
|
5345
5356
|
#
|
|
5346
5357
|
class RegistrationVersionInformation < Struct.new(
|
|
5347
5358
|
:version_number,
|
|
5348
5359
|
:registration_version_status,
|
|
5349
5360
|
:registration_version_status_history,
|
|
5350
|
-
:denied_reasons
|
|
5361
|
+
:denied_reasons,
|
|
5362
|
+
:feedback)
|
|
5351
5363
|
SENSITIVE = []
|
|
5352
5364
|
include Aws::Structure
|
|
5353
5365
|
end
|
|
@@ -5373,6 +5385,15 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5373
5385
|
# [1]: https://www.epochconverter.com/
|
|
5374
5386
|
# @return [Time]
|
|
5375
5387
|
#
|
|
5388
|
+
# @!attribute [rw] aws_reviewing_timestamp
|
|
5389
|
+
# The time when the registration was in the AWS reviewing state, in
|
|
5390
|
+
# [UNIX epoch time][1] format.
|
|
5391
|
+
#
|
|
5392
|
+
#
|
|
5393
|
+
#
|
|
5394
|
+
# [1]: https://www.epochconverter.com/
|
|
5395
|
+
# @return [Time]
|
|
5396
|
+
#
|
|
5376
5397
|
# @!attribute [rw] reviewing_timestamp
|
|
5377
5398
|
# The time when the registration was in the reviewing state, in [UNIX
|
|
5378
5399
|
# epoch time][1] format.
|
|
@@ -5441,6 +5462,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5441
5462
|
class RegistrationVersionStatusHistory < Struct.new(
|
|
5442
5463
|
:draft_timestamp,
|
|
5443
5464
|
:submitted_timestamp,
|
|
5465
|
+
:aws_reviewing_timestamp,
|
|
5444
5466
|
:reviewing_timestamp,
|
|
5445
5467
|
:requires_authentication_timestamp,
|
|
5446
5468
|
:approved_timestamp,
|
|
@@ -5457,7 +5479,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5457
5479
|
# You can use DescribePhoneNumbers to get the values for PhoneNumberId
|
|
5458
5480
|
# and PhoneNumberArn.
|
|
5459
5481
|
#
|
|
5460
|
-
# If you are using a shared End User
|
|
5482
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
5461
5483
|
# must use the full Amazon Resource Name(ARN).
|
|
5462
5484
|
# @return [String]
|
|
5463
5485
|
#
|
|
@@ -5524,7 +5546,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5524
5546
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
5525
5547
|
# By default this is set to false. When set to false and an end
|
|
5526
5548
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
5527
|
-
# your dedicated numbers, End User
|
|
5549
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
5528
5550
|
# with a customizable message and adds the end recipient to the
|
|
5529
5551
|
# OptOutList. When set to true you're responsible for responding to
|
|
5530
5552
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -5662,7 +5684,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5662
5684
|
# The name of the OptOutList to associate with the phone number. You
|
|
5663
5685
|
# can use the OptOutListName or OptOutListArn.
|
|
5664
5686
|
#
|
|
5665
|
-
# If you are using a shared End User
|
|
5687
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
5666
5688
|
# must use the full Amazon Resource Name(ARN).
|
|
5667
5689
|
# @return [String]
|
|
5668
5690
|
#
|
|
@@ -5670,7 +5692,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5670
5692
|
# The pool to associated with the phone number. You can use the PoolId
|
|
5671
5693
|
# or PoolArn.
|
|
5672
5694
|
#
|
|
5673
|
-
# If you are using a shared End User
|
|
5695
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
5674
5696
|
# must use the full Amazon Resource Name(ARN).
|
|
5675
5697
|
# @return [String]
|
|
5676
5698
|
#
|
|
@@ -5779,7 +5801,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5779
5801
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
5780
5802
|
# By default this is set to false. When set to false and an end
|
|
5781
5803
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
5782
|
-
# your dedicated numbers, End User
|
|
5804
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
5783
5805
|
# with a customizable message and adds the end recipient to the
|
|
5784
5806
|
# OptOutList. When set to true you're responsible for responding to
|
|
5785
5807
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -6038,7 +6060,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6038
6060
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
6039
6061
|
# PoolId, or PoolArn.
|
|
6040
6062
|
#
|
|
6041
|
-
# If you are using a shared End User
|
|
6063
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
6042
6064
|
# must use the full Amazon Resource Name(ARN).
|
|
6043
6065
|
# @return [String]
|
|
6044
6066
|
#
|
|
@@ -6099,7 +6121,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6099
6121
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
6100
6122
|
# PoolId, or PoolArn.
|
|
6101
6123
|
#
|
|
6102
|
-
# If you are using a shared End User
|
|
6124
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
6103
6125
|
# must use the full Amazon Resource Name(ARN).
|
|
6104
6126
|
# @return [String]
|
|
6105
6127
|
#
|
|
@@ -6200,7 +6222,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6200
6222
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
6201
6223
|
# PoolId, or PoolArn.
|
|
6202
6224
|
#
|
|
6203
|
-
# If you are using a shared End User
|
|
6225
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
6204
6226
|
# must use the full Amazon Resource Name(ARN).
|
|
6205
6227
|
# @return [String]
|
|
6206
6228
|
#
|
|
@@ -6274,7 +6296,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6274
6296
|
# five. If your origination identity has a lower MPS limit then the
|
|
6275
6297
|
# lower MPS limit is used. For more information about MPS limits, see
|
|
6276
6298
|
# [Message Parts per Second (MPS) limits][1] in the *End User
|
|
6277
|
-
#
|
|
6299
|
+
# Messaging SMS User Guide*..
|
|
6278
6300
|
#
|
|
6279
6301
|
#
|
|
6280
6302
|
#
|
|
@@ -6331,7 +6353,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6331
6353
|
# The origination identity to use for the voice call. This can be the
|
|
6332
6354
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
|
|
6333
6355
|
#
|
|
6334
|
-
# If you are using a shared End User
|
|
6356
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
6335
6357
|
# must use the full Amazon Resource Name(ARN).
|
|
6336
6358
|
# @return [String]
|
|
6337
6359
|
#
|
|
@@ -6430,7 +6452,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6430
6452
|
|
|
6431
6453
|
# The alphanumeric sender ID in a specific country that you want to
|
|
6432
6454
|
# describe. For more information on sender IDs see [Requesting sender
|
|
6433
|
-
# IDs ][1] in the *End User
|
|
6455
|
+
# IDs ][1] in the *End User Messaging SMS User Guide*.
|
|
6434
6456
|
#
|
|
6435
6457
|
#
|
|
6436
6458
|
#
|
|
@@ -6793,7 +6815,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6793
6815
|
# Describes the current monthly spend limits for sending voice and text
|
|
6794
6816
|
# messages. For more information on increasing your monthly spend limit,
|
|
6795
6817
|
# see [ Requesting a spending quota increase ][1] in the *End User
|
|
6796
|
-
#
|
|
6818
|
+
# Messaging SMS User Guide*.
|
|
6797
6819
|
#
|
|
6798
6820
|
#
|
|
6799
6821
|
#
|
|
@@ -6837,10 +6859,17 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6837
6859
|
# The unique identifier for the registration.
|
|
6838
6860
|
# @return [String]
|
|
6839
6861
|
#
|
|
6862
|
+
# @!attribute [rw] aws_review
|
|
6863
|
+
# Set to true to request AWS review of the registration. When enabled,
|
|
6864
|
+
# AWS will perform additional validation and review of the
|
|
6865
|
+
# registration submission before processing.
|
|
6866
|
+
# @return [Boolean]
|
|
6867
|
+
#
|
|
6840
6868
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SubmitRegistrationVersionRequest AWS API Documentation
|
|
6841
6869
|
#
|
|
6842
6870
|
class SubmitRegistrationVersionRequest < Struct.new(
|
|
6843
|
-
:registration_id
|
|
6871
|
+
:registration_id,
|
|
6872
|
+
:aws_review)
|
|
6844
6873
|
SENSITIVE = []
|
|
6845
6874
|
include Aws::Structure
|
|
6846
6875
|
end
|
|
@@ -6890,6 +6919,11 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6890
6919
|
# stamps for when the reservations status changes.
|
|
6891
6920
|
# @return [Types::RegistrationVersionStatusHistory]
|
|
6892
6921
|
#
|
|
6922
|
+
# @!attribute [rw] aws_review
|
|
6923
|
+
# Indicates whether AWS review was requested for this registration
|
|
6924
|
+
# submission.
|
|
6925
|
+
# @return [Boolean]
|
|
6926
|
+
#
|
|
6893
6927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/SubmitRegistrationVersionResult AWS API Documentation
|
|
6894
6928
|
#
|
|
6895
6929
|
class SubmitRegistrationVersionResult < Struct.new(
|
|
@@ -6897,7 +6931,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
6897
6931
|
:registration_id,
|
|
6898
6932
|
:version_number,
|
|
6899
6933
|
:registration_version_status,
|
|
6900
|
-
:registration_version_status_history
|
|
6934
|
+
:registration_version_status_history,
|
|
6935
|
+
:aws_review)
|
|
6901
6936
|
SENSITIVE = []
|
|
6902
6937
|
include Aws::Structure
|
|
6903
6938
|
end
|
|
@@ -7136,7 +7171,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7136
7171
|
# The unique identifier of the phone number. Valid values for this
|
|
7137
7172
|
# field can be either the PhoneNumberId or PhoneNumberArn.
|
|
7138
7173
|
#
|
|
7139
|
-
# If you are using a shared End User
|
|
7174
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
7140
7175
|
# must use the full Amazon Resource Name(ARN).
|
|
7141
7176
|
# @return [String]
|
|
7142
7177
|
#
|
|
@@ -7157,7 +7192,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7157
7192
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
7158
7193
|
# By default this is set to false. When set to false and an end
|
|
7159
7194
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
7160
|
-
# your dedicated numbers, End User
|
|
7195
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
7161
7196
|
# with a customizable message and adds the end recipient to the
|
|
7162
7197
|
# OptOutList. When set to true you're responsible for responding to
|
|
7163
7198
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -7307,7 +7342,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7307
7342
|
# The unique identifier of the pool to update. Valid values are either
|
|
7308
7343
|
# the PoolId or PoolArn.
|
|
7309
7344
|
#
|
|
7310
|
-
# If you are using a shared End User
|
|
7345
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
7311
7346
|
# must use the full Amazon Resource Name(ARN).
|
|
7312
7347
|
# @return [String]
|
|
7313
7348
|
#
|
|
@@ -7328,7 +7363,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7328
7363
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
7329
7364
|
# By default this is set to false. When set to false and an end
|
|
7330
7365
|
# recipient sends a message that begins with HELP or STOP to one of
|
|
7331
|
-
# your dedicated numbers, End User
|
|
7366
|
+
# your dedicated numbers, End User Messaging SMS automatically replies
|
|
7332
7367
|
# with a customizable message and adds the end recipient to the
|
|
7333
7368
|
# OptOutList. When set to true you're responsible for responding to
|
|
7334
7369
|
# HELP and STOP requests. You're also responsible for tracking and
|
|
@@ -7339,7 +7374,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7339
7374
|
# The OptOutList to associate with the pool. Valid values are either
|
|
7340
7375
|
# OptOutListName or OptOutListArn.
|
|
7341
7376
|
#
|
|
7342
|
-
# If you are using a shared End User
|
|
7377
|
+
# If you are using a shared End User Messaging SMS resource then you
|
|
7343
7378
|
# must use the full Amazon Resource Name(ARN).
|
|
7344
7379
|
# @return [String]
|
|
7345
7380
|
#
|
|
@@ -7399,7 +7434,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7399
7434
|
# @!attribute [rw] self_managed_opt_outs_enabled
|
|
7400
7435
|
# When set to false and an end recipient sends a message that begins
|
|
7401
7436
|
# with HELP or STOP to one of your dedicated numbers, End User
|
|
7402
|
-
#
|
|
7437
|
+
# Messaging SMS automatically replies with a customizable message and
|
|
7403
7438
|
# adds the end recipient to the OptOutList. When set to true you're
|
|
7404
7439
|
# responsible for responding to HELP and STOP requests. You're also
|
|
7405
7440
|
# responsible for tracking and honoring opt-out requests.
|
|
@@ -7457,7 +7492,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
7457
7492
|
# contain the details for the requested NumberCapability. The Key is
|
|
7458
7493
|
# the two-letter ISO country code. For a list of supported ISO country
|
|
7459
7494
|
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
|
7460
|
-
# End User
|
|
7495
|
+
# End User Messaging SMS User Guide.
|
|
7461
7496
|
#
|
|
7462
7497
|
# For example, to set the United States as allowed and Canada as
|
|
7463
7498
|
# blocked, the `CountryRuleSetUpdates` would be formatted as:
|