aws-sdk-pinpointsmsvoicev2 1.45.0 → 1.47.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.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +198 -119
  5. data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +34 -0
  6. data/lib/aws-sdk-pinpointsmsvoicev2/endpoint_parameters.rb +4 -4
  7. data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +208 -124
  8. data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
  9. data/sig/client.rbs +17 -0
  10. data/sig/types.rbs +17 -0
  11. metadata +1 -1
data/lib/aws-sdk-pinpointsmsvoicev2/types.rb CHANGED
@@ -78,10 +78,14 @@ module Aws::PinpointSMSVoiceV2
78
78
  # @!attribute [rw] pool_id
79
79
  # The pool to update with the new Identity. This value can be either
80
80
  # the PoolId or PoolArn, and you can find these values using
81
- # DescribePools.
81
+ # [DescribePools][1].
82
82
  #
83
- # If you are using a shared AWS End User Messaging SMS and Voice
84
- # resource then you must use the full Amazon Resource Name(ARN).
83
+ # If you are using a shared End User MessagingSMS; resource then you
84
+ # must use the full Amazon Resource Name(ARN).
85
+ #
86
+ #
87
+ #
88
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePools.html
85
89
  # @return [String]
86
90
  #
87
91
  # @!attribute [rw] origination_identity
@@ -91,8 +95,8 @@ module Aws::PinpointSMSVoiceV2
91
95
  # PhoneNumberArn, while DescribeSenderIds can be used to get the
92
96
  # values for SenderId and SenderIdArn.
93
97
  #
94
- # If you are using a shared AWS End User Messaging SMS and Voice
95
- # resource then you must use the full Amazon Resource Name(ARN).
98
+ # If you are using a shared End User MessagingSMS resource then you
99
+ # must use the full Amazon Resource Name(ARN).
96
100
  # @return [String]
97
101
  #
98
102
  # @!attribute [rw] iso_country_code
@@ -200,6 +204,81 @@ module Aws::PinpointSMSVoiceV2
200
204
  include Aws::Structure
201
205
  end
202
206
 
207
+ # @!attribute [rw] phone_number
208
+ # The phone number that you want to retrieve information about. You
209
+ # can provide the phone number in various formats including special
210
+ # characters such as parentheses, brackets, spaces, hyphens, periods,
211
+ # and commas. The service automatically converts the input to E164
212
+ # format for processing.
213
+ # @return [String]
214
+ #
215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookupRequest AWS API Documentation
216
+ #
217
+ class CarrierLookupRequest < Struct.new(
218
+ :phone_number)
219
+ SENSITIVE = []
220
+ include Aws::Structure
221
+ end
222
+
223
+ # @!attribute [rw] e164_phone_number
224
+ # The phone number in E164 format, sanitized from the original input
225
+ # by removing any formatting characters.
226
+ # @return [String]
227
+ #
228
+ # @!attribute [rw] dialing_country_code
229
+ # The numeric dialing code for the country or region where the phone
230
+ # number was originally registered.
231
+ # @return [String]
232
+ #
233
+ # @!attribute [rw] iso_country_code
234
+ # The two-character code, in ISO 3166-1 alpha-2 format, for the
235
+ # country or region where the phone number was originally registered.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] country
239
+ # The name of the country where the phone number was originally
240
+ # registered.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] mcc
244
+ # The phone number's mobile country code, for mobile phone number
245
+ # types
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] mnc
249
+ # The phone number's mobile network code, for mobile phone number
250
+ # types.
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] carrier
254
+ # The carrier or service provider that the phone number is currently
255
+ # registered with. In some countries and regions, this value may be
256
+ # the carrier or service provider that the phone number was originally
257
+ # registered with.
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] phone_number_type
261
+ # Describes the type of phone number. Valid values are: MOBILE,
262
+ # LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to
263
+ # INVALID phone numbers, as these numbers are unlikely to belong to
264
+ # actual recipients.
265
+ # @return [String]
266
+ #
267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookupResult AWS API Documentation
268
+ #
269
+ class CarrierLookupResult < Struct.new(
270
+ :e164_phone_number,
271
+ :dialing_country_code,
272
+ :iso_country_code,
273
+ :country,
274
+ :mcc,
275
+ :mnc,
276
+ :carrier,
277
+ :phone_number_type)
278
+ SENSITIVE = []
279
+ include Aws::Structure
280
+ end
281
+
203
282
  # Contains the destination configuration to use when publishing message
204
283
  # sending events.
205
284
  #
@@ -407,8 +486,7 @@ module Aws::PinpointSMSVoiceV2
407
486
  #
408
487
  # @!attribute [rw] matching_event_types
409
488
  # An array of event types that determine which events to log. If
410
- # "ALL" is used, then AWS End User Messaging SMS and Voice logs
411
- # every event type.
489
+ # "ALL" is used, then End User MessagingSMS logs every event type.
412
490
  #
413
491
  # <note markdown="1"> The `TEXT_SENT` event type is not supported.
414
492
  #
@@ -540,19 +618,21 @@ module Aws::PinpointSMSVoiceV2
540
618
  # @!attribute [rw] origination_identity
541
619
  # The origination identity to use such as a PhoneNumberId,
542
620
  # PhoneNumberArn, SenderId or SenderIdArn. You can use
543
- # DescribePhoneNumbers to find the values for PhoneNumberId and
544
- # PhoneNumberArn while DescribeSenderIds can be used to get the values
545
- # for SenderId and SenderIdArn.
621
+ # [DescribePhoneNumbers][1] to find the values for PhoneNumberId and
622
+ # PhoneNumberArn, and use [DescribeSenderIds][2] can be used to get
623
+ # the values for SenderId and SenderIdArn.
546
624
  #
547
625
  # After the pool is created you can add more origination identities to
548
- # the pool by using [AssociateOriginationIdentity][1].
626
+ # the pool by using [AssociateOriginationIdentity][3].
549
627
  #
550
- # If you are using a shared AWS End User Messaging SMS and Voice
551
- # resource then you must use the full Amazon Resource Name(ARN).
628
+ # If you are using a shared End User MessagingSMS resource then you
629
+ # must use the full Amazon Resource Name(ARN).
552
630
  #
553
631
  #
554
632
  #
555
- # [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html
633
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePhoneNumbers.html
634
+ # [2]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribeSenderIds.html
635
+ # [3]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html
556
636
  # @return [String]
557
637
  #
558
638
  # @!attribute [rw] iso_country_code
@@ -569,7 +649,11 @@ module Aws::PinpointSMSVoiceV2
569
649
  #
570
650
  # @!attribute [rw] deletion_protection_enabled
571
651
  # By default this is set to false. When set to true the pool can't be
572
- # deleted. You can change this value using the UpdatePool action.
652
+ # deleted. You can change this value using the [UpdatePool][1] action.
653
+ #
654
+ #
655
+ #
656
+ # [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_UpdatePool.html
573
657
  # @return [Boolean]
574
658
  #
575
659
  # @!attribute [rw] tags
@@ -637,9 +721,9 @@ module Aws::PinpointSMSVoiceV2
637
721
  # @return [String]
638
722
  #
639
723
  # @!attribute [rw] self_managed_opt_outs_enabled
640
- # By default this is set to false. When an end recipient sends a
641
- # message that begins with HELP or STOP to one of your dedicated
642
- # numbers, AWS End User Messaging SMS and Voice automatically replies
724
+ # By default this is set to false. When set to false, and an end
725
+ # recipient sends a message that begins with HELP or STOP to one of
726
+ # your dedicated numbers, End User MessagingSMS automatically replies
643
727
  # with a customizable message and adds the end recipient to the
644
728
  # OptOutList. When set to true you're responsible for responding to
645
729
  # HELP and STOP requests. You're also responsible for tracking and
@@ -1387,8 +1471,8 @@ module Aws::PinpointSMSVoiceV2
1387
1471
  # to find the values for PhoneNumberId and PhoneNumberArn and
1388
1472
  # DescribePools to find the values of PoolId and PoolArn.
1389
1473
  #
1390
- # If you are using a shared AWS End User Messaging SMS and Voice
1391
- # resource then you must use the full Amazon Resource Name(ARN).
1474
+ # If you are using a shared End User MessagingSMS resource then you
1475
+ # must use the full Amazon Resource Name(ARN).
1392
1476
  # @return [String]
1393
1477
  #
1394
1478
  # @!attribute [rw] keyword
@@ -1459,8 +1543,8 @@ module Aws::PinpointSMSVoiceV2
1459
1543
  # can use DescribeOptOutLists to find the values for OptOutListName
1460
1544
  # and OptOutListArn.
1461
1545
  #
1462
- # If you are using a shared AWS End User Messaging SMS and Voice
1463
- # resource then you must use the full Amazon Resource Name(ARN).
1546
+ # If you are using a shared End User MessagingSMS resource then you
1547
+ # must use the full Amazon Resource Name(ARN).
1464
1548
  # @return [String]
1465
1549
  #
1466
1550
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutListRequest AWS API Documentation
@@ -1501,8 +1585,8 @@ module Aws::PinpointSMSVoiceV2
1501
1585
  # @!attribute [rw] opt_out_list_name
1502
1586
  # The OptOutListName or OptOutListArn to remove the phone number from.
1503
1587
  #
1504
- # If you are using a shared AWS End User Messaging SMS and Voice
1505
- # resource then you must use the full Amazon Resource Name(ARN).
1588
+ # If you are using a shared End User MessagingSMS resource then you
1589
+ # must use the full Amazon Resource Name(ARN).
1506
1590
  # @return [String]
1507
1591
  #
1508
1592
  # @!attribute [rw] opted_out_number
@@ -1560,8 +1644,8 @@ module Aws::PinpointSMSVoiceV2
1560
1644
  # The PoolId or PoolArn of the pool to delete. You can use
1561
1645
  # DescribePools to find the values for PoolId and PoolArn .
1562
1646
  #
1563
- # If you are using a shared AWS End User Messaging SMS and Voice
1564
- # resource then you must use the full Amazon Resource Name(ARN).
1647
+ # If you are using a shared End User MessagingSMS resource then you
1648
+ # must use the full Amazon Resource Name(ARN).
1565
1649
  # @return [String]
1566
1650
  #
1567
1651
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeletePoolRequest AWS API Documentation
@@ -1610,9 +1694,9 @@ module Aws::PinpointSMSVoiceV2
1610
1694
  # @return [String]
1611
1695
  #
1612
1696
  # @!attribute [rw] self_managed_opt_outs_enabled
1613
- # By default this is set to false. When an end recipient sends a
1614
- # message that begins with HELP or STOP to one of your dedicated
1615
- # numbers, AWS End User Messaging SMS and Voice automatically replies
1697
+ # By default this is set to false. When set to false and an end
1698
+ # recipient sends a message that begins with HELP or STOP to one of
1699
+ # your dedicated numbers, End User MessagingSMS automatically replies
1616
1700
  # with a customizable message and adds the end recipient to the
1617
1701
  # OptOutList. When set to true you're responsible for responding to
1618
1702
  # HELP and STOP requests. You're also responsible for tracking and
@@ -1989,8 +2073,8 @@ module Aws::PinpointSMSVoiceV2
1989
2073
  end
1990
2074
 
1991
2075
  # @!attribute [rw] resource_arn
1992
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
1993
- # Voice resource you're deleting the resource-based policy from.
2076
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
2077
+ # you're deleting the resource-based policy from.
1994
2078
  # @return [String]
1995
2079
  #
1996
2080
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteResourcePolicyRequest AWS API Documentation
@@ -2002,8 +2086,8 @@ module Aws::PinpointSMSVoiceV2
2002
2086
  end
2003
2087
 
2004
2088
  # @!attribute [rw] resource_arn
2005
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
2006
- # Voice resource that the resource-based policy was deleted from.
2089
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
2090
+ # that the resource-based policy was deleted from.
2007
2091
  # @return [String]
2008
2092
  #
2009
2093
  # @!attribute [rw] policy
@@ -2236,8 +2320,8 @@ module Aws::PinpointSMSVoiceV2
2236
2320
  # PhoneNumberArn while DescribeSenderIds can be used to get the values
2237
2321
  # for SenderId and SenderIdArn.
2238
2322
  #
2239
- # If you are using a shared AWS End User Messaging SMS and Voice
2240
- # resource then you must use the full Amazon Resource Name(ARN).
2323
+ # If you are using a shared End User MessagingSMS resource then you
2324
+ # must use the full Amazon Resource Name(ARN).
2241
2325
  # @return [String]
2242
2326
  #
2243
2327
  # @!attribute [rw] keywords
@@ -2303,8 +2387,8 @@ module Aws::PinpointSMSVoiceV2
2303
2387
  # The OptOutLists to show the details of. This is an array of strings
2304
2388
  # that can be either the OptOutListName or OptOutListArn.
2305
2389
  #
2306
- # If you are using a shared AWS End User Messaging SMS and Voice
2307
- # resource then you must use the full Amazon Resource Name(ARN).
2390
+ # If you are using a shared End User MessagingSMS resource then you
2391
+ # must use the full Amazon Resource Name(ARN).
2308
2392
  # @return [Array<String>]
2309
2393
  #
2310
2394
  # @!attribute [rw] next_token
@@ -2358,8 +2442,8 @@ module Aws::PinpointSMSVoiceV2
2358
2442
  # DescribeOptOutLists to find the values for OptOutListName and
2359
2443
  # OptOutListArn.
2360
2444
  #
2361
- # If you are using a shared AWS End User Messaging SMS and Voice
2362
- # resource then you must use the full Amazon Resource Name(ARN).
2445
+ # If you are using a shared End User MessagingSMS resource then you
2446
+ # must use the full Amazon Resource Name(ARN).
2363
2447
  # @return [String]
2364
2448
  #
2365
2449
  # @!attribute [rw] opted_out_numbers
@@ -2428,8 +2512,8 @@ module Aws::PinpointSMSVoiceV2
2428
2512
  # This is an array of strings that can be either the PhoneNumberId or
2429
2513
  # PhoneNumberArn.
2430
2514
  #
2431
- # If you are using a shared AWS End User Messaging SMS and Voice
2432
- # resource then you must use the full Amazon Resource Name(ARN).
2515
+ # If you are using a shared End User MessagingSMS resource then you
2516
+ # must use the full Amazon Resource Name(ARN).
2433
2517
  # @return [Array<String>]
2434
2518
  #
2435
2519
  # @!attribute [rw] filters
@@ -2487,8 +2571,8 @@ module Aws::PinpointSMSVoiceV2
2487
2571
  # The unique identifier of pools to find. This is an array of strings
2488
2572
  # that can be either the PoolId or PoolArn.
2489
2573
  #
2490
- # If you are using a shared AWS End User Messaging SMS and Voice
2491
- # resource then you must use the full Amazon Resource Name(ARN).
2574
+ # If you are using a shared End User MessagingSMS resource then you
2575
+ # must use the full Amazon Resource Name(ARN).
2492
2576
  # @return [Array<String>]
2493
2577
  #
2494
2578
  # @!attribute [rw] filters
@@ -2980,8 +3064,8 @@ module Aws::PinpointSMSVoiceV2
2980
3064
  # @!attribute [rw] sender_ids
2981
3065
  # An array of SenderIdAndCountry objects to search for.
2982
3066
  #
2983
- # If you are using a shared AWS End User Messaging SMS and Voice
2984
- # resource then you must use the full Amazon Resource Name(ARN).
3067
+ # If you are using a shared End User MessagingSMS resource then you
3068
+ # must use the full Amazon Resource Name(ARN).
2985
3069
  # @return [Array<Types::SenderIdAndCountry>]
2986
3070
  #
2987
3071
  # @!attribute [rw] filters
@@ -3129,8 +3213,8 @@ module Aws::PinpointSMSVoiceV2
3129
3213
  # origination identity. This value can be either the PoolId or
3130
3214
  # PoolArn.
3131
3215
  #
3132
- # If you are using a shared AWS End User Messaging SMS and Voice
3133
- # resource then you must use the full Amazon Resource Name(ARN).
3216
+ # If you are using a shared End User MessagingSMS resource then you
3217
+ # must use the full Amazon Resource Name(ARN).
3134
3218
  # @return [String]
3135
3219
  #
3136
3220
  # @!attribute [rw] origination_identity
@@ -3140,8 +3224,8 @@ module Aws::PinpointSMSVoiceV2
3140
3224
  # PhoneNumberArn, or use DescribeSenderIds to get the values for
3141
3225
  # SenderId and SenderIdArn.
3142
3226
  #
3143
- # If you are using a shared AWS End User Messaging SMS and Voice
3144
- # resource then you must use the full Amazon Resource Name(ARN).
3227
+ # If you are using a shared End User MessagingSMS resource then you
3228
+ # must use the full Amazon Resource Name(ARN).
3145
3229
  # @return [String]
3146
3230
  #
3147
3231
  # @!attribute [rw] iso_country_code
@@ -3403,7 +3487,7 @@ module Aws::PinpointSMSVoiceV2
3403
3487
  # contain the details for the requested NumberCapability. The Key is
3404
3488
  # the two-letter ISO country code. For a list of supported ISO country
3405
3489
  # codes, see [Supported countries and regions (SMS channel)][1] in the
3406
- # AWS End User Messaging SMS User Guide.
3490
+ # End User MessagingSMS User Guide.
3407
3491
  #
3408
3492
  #
3409
3493
  #
@@ -3422,8 +3506,8 @@ module Aws::PinpointSMSVoiceV2
3422
3506
  end
3423
3507
 
3424
3508
  # @!attribute [rw] resource_arn
3425
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
3426
- # Voice resource attached to the resource-based policy.
3509
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
3510
+ # attached to the resource-based policy.
3427
3511
  # @return [String]
3428
3512
  #
3429
3513
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetResourcePolicyRequest AWS API Documentation
@@ -3435,13 +3519,13 @@ module Aws::PinpointSMSVoiceV2
3435
3519
  end
3436
3520
 
3437
3521
  # @!attribute [rw] resource_arn
3438
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
3439
- # Voice resource attached to the resource-based policy.
3522
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
3523
+ # attached to the resource-based policy.
3440
3524
  # @return [String]
3441
3525
  #
3442
3526
  # @!attribute [rw] policy
3443
3527
  # The JSON formatted string that contains the resource-based policy
3444
- # attached to the AWS End User Messaging SMS and Voice resource.
3528
+ # attached to the End User MessagingSMS resource.
3445
3529
  # @return [String]
3446
3530
  #
3447
3531
  # @!attribute [rw] created_timestamp
@@ -3556,8 +3640,8 @@ module Aws::PinpointSMSVoiceV2
3556
3640
  # The unique identifier for the pool. This value can be either the
3557
3641
  # PoolId or PoolArn.
3558
3642
  #
3559
- # If you are using a shared AWS End User Messaging SMS and Voice
3560
- # resource then you must use the full Amazon Resource Name(ARN).
3643
+ # If you are using a shared End User MessagingSMS resource then you
3644
+ # must use the full Amazon Resource Name(ARN).
3561
3645
  # @return [String]
3562
3646
  #
3563
3647
  # @!attribute [rw] filters
@@ -3955,13 +4039,13 @@ module Aws::PinpointSMSVoiceV2
3955
4039
  # @return [String]
3956
4040
  #
3957
4041
  # @!attribute [rw] self_managed_opt_outs_enabled
3958
- # When set to false an end recipient sends a message that begins with
3959
- # HELP or STOP to one of your dedicated numbers, AWS End User
3960
- # Messaging SMS and Voice automatically replies with a customizable
3961
- # message and adds the end recipient to the OptOutList. When set to
3962
- # true you're responsible for responding to HELP and STOP requests.
3963
- # You're also responsible for tracking and honoring opt-out request.
3964
- # For more information see [Self-managed opt-outs][1]
4042
+ # When set to false and an end recipient sends a message that begins
4043
+ # with HELP or STOP to one of your dedicated numbers, End User
4044
+ # MessagingSMS automatically replies with a customizable message and
4045
+ # adds the end recipient to the OptOutList. When set to true you're
4046
+ # responsible for responding to HELP and STOP requests. You're also
4047
+ # responsible for tracking and honoring opt-out request. For more
4048
+ # information see [Self-managed opt-outs][1]
3965
4049
  #
3966
4050
  #
3967
4051
  #
@@ -4079,12 +4163,12 @@ module Aws::PinpointSMSVoiceV2
4079
4163
  #
4080
4164
  # @!attribute [rw] self_managed_opt_outs_enabled
4081
4165
  # When set to false, an end recipient sends a message that begins with
4082
- # HELP or STOP to one of your dedicated numbers, AWS End User
4083
- # Messaging SMS and Voice automatically replies with a customizable
4084
- # message and adds the end recipient to the OptOutList. When set to
4085
- # true you're responsible for responding to HELP and STOP requests.
4086
- # You're also responsible for tracking and honoring opt-out requests.
4087
- # For more information see [Self-managed opt-outs][1]
4166
+ # HELP or STOP to one of your dedicated numbers, End User MessagingSMS
4167
+ # automatically replies with a customizable message and adds the end
4168
+ # recipient to the OptOutList. When set to true you're responsible
4169
+ # for responding to HELP and STOP requests. You're also responsible
4170
+ # for tracking and honoring opt-out requests. For more information see
4171
+ # [Self-managed opt-outs][1]
4088
4172
  #
4089
4173
  #
4090
4174
  #
@@ -4301,8 +4385,8 @@ module Aws::PinpointSMSVoiceV2
4301
4385
  # PhoneNumberArn while DescribeSenderIds can be used to get the values
4302
4386
  # for SenderId and SenderIdArn.
4303
4387
  #
4304
- # If you are using a shared AWS End User Messaging SMS and Voice
4305
- # resource then you must use the full Amazon Resource Name(ARN).
4388
+ # If you are using a shared End User MessagingSMS resource then you
4389
+ # must use the full Amazon Resource Name(ARN).
4306
4390
  # @return [String]
4307
4391
  #
4308
4392
  # @!attribute [rw] keyword
@@ -4403,8 +4487,8 @@ module Aws::PinpointSMSVoiceV2
4403
4487
  # @!attribute [rw] opt_out_list_name
4404
4488
  # The OptOutListName or OptOutListArn to add the phone number to.
4405
4489
  #
4406
- # If you are using a shared AWS End User Messaging SMS and Voice
4407
- # resource then you must use the full Amazon Resource Name(ARN).
4490
+ # If you are using a shared End User MessagingSMS resource then you
4491
+ # must use the full Amazon Resource Name(ARN).
4408
4492
  # @return [String]
4409
4493
  #
4410
4494
  # @!attribute [rw] opted_out_number
@@ -4622,8 +4706,8 @@ module Aws::PinpointSMSVoiceV2
4622
4706
  end
4623
4707
 
4624
4708
  # @!attribute [rw] resource_arn
4625
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
4626
- # Voice resource to attach the resource-based policy to.
4709
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
4710
+ # to attach the resource-based policy to.
4627
4711
  # @return [String]
4628
4712
  #
4629
4713
  # @!attribute [rw] policy
@@ -4640,8 +4724,8 @@ module Aws::PinpointSMSVoiceV2
4640
4724
  end
4641
4725
 
4642
4726
  # @!attribute [rw] resource_arn
4643
- # The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
4644
- # Voice resource attached to the resource-based policy.
4727
+ # The Amazon Resource Name (ARN) of the End User MessagingSMS resource
4728
+ # attached to the resource-based policy.
4645
4729
  # @return [String]
4646
4730
  #
4647
4731
  # @!attribute [rw] policy
@@ -5373,8 +5457,8 @@ module Aws::PinpointSMSVoiceV2
5373
5457
  # You can use DescribePhoneNumbers to get the values for PhoneNumberId
5374
5458
  # and PhoneNumberArn.
5375
5459
  #
5376
- # If you are using a shared AWS End User Messaging SMS and Voice
5377
- # resource then you must use the full Amazon Resource Name(ARN).
5460
+ # If you are using a shared End User MessagingSMS resource then you
5461
+ # must use the full Amazon Resource Name(ARN).
5378
5462
  # @return [String]
5379
5463
  #
5380
5464
  # @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/ReleasePhoneNumberRequest AWS API Documentation
@@ -5438,9 +5522,9 @@ module Aws::PinpointSMSVoiceV2
5438
5522
  # @return [String]
5439
5523
  #
5440
5524
  # @!attribute [rw] self_managed_opt_outs_enabled
5441
- # By default this is set to false. When an end recipient sends a
5442
- # message that begins with HELP or STOP to one of your dedicated
5443
- # numbers, AWS End User Messaging SMS and Voice automatically replies
5525
+ # By default this is set to false. When set to false and an end
5526
+ # recipient sends a message that begins with HELP or STOP to one of
5527
+ # your dedicated numbers, End User MessagingSMS automatically replies
5444
5528
  # with a customizable message and adds the end recipient to the
5445
5529
  # OptOutList. When set to true you're responsible for responding to
5446
5530
  # HELP and STOP requests. You're also responsible for tracking and
@@ -5578,16 +5662,16 @@ module Aws::PinpointSMSVoiceV2
5578
5662
  # The name of the OptOutList to associate with the phone number. You
5579
5663
  # can use the OptOutListName or OptOutListArn.
5580
5664
  #
5581
- # If you are using a shared AWS End User Messaging SMS and Voice
5582
- # resource then you must use the full Amazon Resource Name(ARN).
5665
+ # If you are using a shared End User MessagingSMS resource then you
5666
+ # must use the full Amazon Resource Name(ARN).
5583
5667
  # @return [String]
5584
5668
  #
5585
5669
  # @!attribute [rw] pool_id
5586
5670
  # The pool to associated with the phone number. You can use the PoolId
5587
5671
  # or PoolArn.
5588
5672
  #
5589
- # If you are using a shared AWS End User Messaging SMS and Voice
5590
- # resource then you must use the full Amazon Resource Name(ARN).
5673
+ # If you are using a shared End User MessagingSMS resource then you
5674
+ # must use the full Amazon Resource Name(ARN).
5591
5675
  # @return [String]
5592
5676
  #
5593
5677
  # @!attribute [rw] registration_id
@@ -5606,8 +5690,8 @@ module Aws::PinpointSMSVoiceV2
5606
5690
  # @return [Boolean]
5607
5691
  #
5608
5692
  # @!attribute [rw] tags
5609
- # An array of tags (key and value pairs) associate with the requested
5610
- # phone number.
5693
+ # An array of tags (key and value pairs) to associate with the
5694
+ # requested phone number.
5611
5695
  # @return [Array<Types::Tag>]
5612
5696
  #
5613
5697
  # @!attribute [rw] client_token
@@ -5693,9 +5777,9 @@ module Aws::PinpointSMSVoiceV2
5693
5777
  # @return [String]
5694
5778
  #
5695
5779
  # @!attribute [rw] self_managed_opt_outs_enabled
5696
- # By default this is set to false. When an end recipient sends a
5697
- # message that begins with HELP or STOP to one of your dedicated
5698
- # numbers, AWS End User Messaging SMS and Voice automatically replies
5780
+ # By default this is set to false. When set to false and an end
5781
+ # recipient sends a message that begins with HELP or STOP to one of
5782
+ # your dedicated numbers, End User MessagingSMS automatically replies
5699
5783
  # with a customizable message and adds the end recipient to the
5700
5784
  # OptOutList. When set to true you're responsible for responding to
5701
5785
  # HELP and STOP requests. You're also responsible for tracking and
@@ -5954,8 +6038,8 @@ module Aws::PinpointSMSVoiceV2
5954
6038
  # PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
5955
6039
  # PoolId, or PoolArn.
5956
6040
  #
5957
- # If you are using a shared AWS End User Messaging SMS and Voice
5958
- # resource then you must use the full Amazon Resource Name(ARN).
6041
+ # If you are using a shared End User MessagingSMS resource then you
6042
+ # must use the full Amazon Resource Name(ARN).
5959
6043
  # @return [String]
5960
6044
  #
5961
6045
  # @!attribute [rw] configuration_set_name
@@ -6015,8 +6099,8 @@ module Aws::PinpointSMSVoiceV2
6015
6099
  # PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
6016
6100
  # PoolId, or PoolArn.
6017
6101
  #
6018
- # If you are using a shared AWS End User Messaging SMS and Voice
6019
- # resource then you must use the full Amazon Resource Name(ARN).
6102
+ # If you are using a shared End User MessagingSMS resource then you
6103
+ # must use the full Amazon Resource Name(ARN).
6020
6104
  # @return [String]
6021
6105
  #
6022
6106
  # @!attribute [rw] message_body
@@ -6116,8 +6200,8 @@ module Aws::PinpointSMSVoiceV2
6116
6200
  # PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
6117
6201
  # PoolId, or PoolArn.
6118
6202
  #
6119
- # If you are using a shared AWS End User Messaging SMS and Voice
6120
- # resource then you must use the full Amazon Resource Name(ARN).
6203
+ # If you are using a shared End User MessagingSMS resource then you
6204
+ # must use the full Amazon Resource Name(ARN).
6121
6205
  # @return [String]
6122
6206
  #
6123
6207
  # @!attribute [rw] message_body
@@ -6189,8 +6273,8 @@ module Aws::PinpointSMSVoiceV2
6189
6273
  # The Message Parts per Second (MPS) limit when using `DryRun` is
6190
6274
  # five. If your origination identity has a lower MPS limit then the
6191
6275
  # lower MPS limit is used. For more information about MPS limits, see
6192
- # [Message Parts per Second (MPS) limits][1] in the *AWS End User
6193
- # Messaging SMS User Guide*..
6276
+ # [Message Parts per Second (MPS) limits][1] in the *End User
6277
+ # MessagingSMS User Guide*..
6194
6278
  #
6195
6279
  #
6196
6280
  #
@@ -6247,8 +6331,8 @@ module Aws::PinpointSMSVoiceV2
6247
6331
  # The origination identity to use for the voice call. This can be the
6248
6332
  # PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
6249
6333
  #
6250
- # If you are using a shared AWS End User Messaging SMS and Voice
6251
- # resource then you must use the full Amazon Resource Name(ARN).
6334
+ # If you are using a shared End User MessagingSMS resource then you
6335
+ # must use the full Amazon Resource Name(ARN).
6252
6336
  # @return [String]
6253
6337
  #
6254
6338
  # @!attribute [rw] message_body
@@ -6346,7 +6430,7 @@ module Aws::PinpointSMSVoiceV2
6346
6430
 
6347
6431
  # The alphanumeric sender ID in a specific country that you want to
6348
6432
  # describe. For more information on sender IDs see [Requesting sender
6349
- # IDs ][1] in the *AWS End User Messaging SMS User Guide*.
6433
+ # IDs ][1] in the *End User MessagingSMS User Guide*.
6350
6434
  #
6351
6435
  #
6352
6436
  #
@@ -6708,8 +6792,8 @@ module Aws::PinpointSMSVoiceV2
6708
6792
 
6709
6793
  # Describes the current monthly spend limits for sending voice and text
6710
6794
  # messages. For more information on increasing your monthly spend limit,
6711
- # see [ Requesting a spending quota increase ][1] in the *AWS End User
6712
- # Messaging SMS User Guide*.
6795
+ # see [ Requesting a spending quota increase ][1] in the *End User
6796
+ # MessagingSMS User Guide*.
6713
6797
  #
6714
6798
  #
6715
6799
  #
@@ -7052,8 +7136,8 @@ module Aws::PinpointSMSVoiceV2
7052
7136
  # The unique identifier of the phone number. Valid values for this
7053
7137
  # field can be either the PhoneNumberId or PhoneNumberArn.
7054
7138
  #
7055
- # If you are using a shared AWS End User Messaging SMS and Voice
7056
- # resource then you must use the full Amazon Resource Name(ARN).
7139
+ # If you are using a shared End User MessagingSMS resource then you
7140
+ # must use the full Amazon Resource Name(ARN).
7057
7141
  # @return [String]
7058
7142
  #
7059
7143
  # @!attribute [rw] two_way_enabled
@@ -7071,9 +7155,9 @@ module Aws::PinpointSMSVoiceV2
7071
7155
  # @return [String]
7072
7156
  #
7073
7157
  # @!attribute [rw] self_managed_opt_outs_enabled
7074
- # By default this is set to false. When an end recipient sends a
7075
- # message that begins with HELP or STOP to one of your dedicated
7076
- # numbers, AWS End User Messaging SMS and Voice automatically replies
7158
+ # By default this is set to false. When set to false and an end
7159
+ # recipient sends a message that begins with HELP or STOP to one of
7160
+ # your dedicated numbers, End User MessagingSMS automatically replies
7077
7161
  # with a customizable message and adds the end recipient to the
7078
7162
  # OptOutList. When set to true you're responsible for responding to
7079
7163
  # HELP and STOP requests. You're also responsible for tracking and
@@ -7081,8 +7165,8 @@ module Aws::PinpointSMSVoiceV2
7081
7165
  # @return [Boolean]
7082
7166
  #
7083
7167
  # @!attribute [rw] opt_out_list_name
7084
- # The OptOutList to add the phone number to. Valid values for this
7085
- # field can be either the OutOutListName or OutOutListArn.
7168
+ # The OptOutList to add the phone number to. You can use either the
7169
+ # opt out list name or the opt out list ARN.
7086
7170
  # @return [String]
7087
7171
  #
7088
7172
  # @!attribute [rw] international_sending_enabled
@@ -7223,8 +7307,8 @@ module Aws::PinpointSMSVoiceV2
7223
7307
  # The unique identifier of the pool to update. Valid values are either
7224
7308
  # the PoolId or PoolArn.
7225
7309
  #
7226
- # If you are using a shared AWS End User Messaging SMS and Voice
7227
- # resource then you must use the full Amazon Resource Name(ARN).
7310
+ # If you are using a shared End User MessagingSMS resource then you
7311
+ # must use the full Amazon Resource Name(ARN).
7228
7312
  # @return [String]
7229
7313
  #
7230
7314
  # @!attribute [rw] two_way_enabled
@@ -7242,9 +7326,9 @@ module Aws::PinpointSMSVoiceV2
7242
7326
  # @return [String]
7243
7327
  #
7244
7328
  # @!attribute [rw] self_managed_opt_outs_enabled
7245
- # By default this is set to false. When an end recipient sends a
7246
- # message that begins with HELP or STOP to one of your dedicated
7247
- # numbers, AWS End User Messaging SMS and Voice automatically replies
7329
+ # By default this is set to false. When set to false and an end
7330
+ # recipient sends a message that begins with HELP or STOP to one of
7331
+ # your dedicated numbers, End User MessagingSMS automatically replies
7248
7332
  # with a customizable message and adds the end recipient to the
7249
7333
  # OptOutList. When set to true you're responsible for responding to
7250
7334
  # HELP and STOP requests. You're also responsible for tracking and
@@ -7255,8 +7339,8 @@ module Aws::PinpointSMSVoiceV2
7255
7339
  # The OptOutList to associate with the pool. Valid values are either
7256
7340
  # OptOutListName or OptOutListArn.
7257
7341
  #
7258
- # If you are using a shared AWS End User Messaging SMS and Voice
7259
- # resource then you must use the full Amazon Resource Name(ARN).
7342
+ # If you are using a shared End User MessagingSMS resource then you
7343
+ # must use the full Amazon Resource Name(ARN).
7260
7344
  # @return [String]
7261
7345
  #
7262
7346
  # @!attribute [rw] shared_routes_enabled
@@ -7313,10 +7397,10 @@ module Aws::PinpointSMSVoiceV2
7313
7397
  # @return [String]
7314
7398
  #
7315
7399
  # @!attribute [rw] self_managed_opt_outs_enabled
7316
- # When an end recipient sends a message that begins with HELP or STOP
7317
- # to one of your dedicated numbers, AWS End User Messaging SMS and
7318
- # Voice automatically replies with a customizable message and adds the
7319
- # end recipient to the OptOutList. When set to true you're
7400
+ # When set to false and an end recipient sends a message that begins
7401
+ # with HELP or STOP to one of your dedicated numbers, End User
7402
+ # MessagingSMS automatically replies with a customizable message and
7403
+ # adds the end recipient to the OptOutList. When set to true you're
7320
7404
  # responsible for responding to HELP and STOP requests. You're also
7321
7405
  # responsible for tracking and honoring opt-out requests.
7322
7406
  # @return [Boolean]
@@ -7373,7 +7457,7 @@ module Aws::PinpointSMSVoiceV2
7373
7457
  # contain the details for the requested NumberCapability. The Key is
7374
7458
  # the two-letter ISO country code. For a list of supported ISO country
7375
7459
  # codes, see [Supported countries and regions (SMS channel)][1] in the
7376
- # AWS End User Messaging SMS User Guide.
7460
+ # End User MessagingSMS User Guide.
7377
7461
  #
7378
7462
  # For example, to set the United States as allowed and Canada as
7379
7463
  # blocked, the `CountryRuleSetUpdates` would be formatted as: