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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +198 -119
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +34 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +208 -124
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +1 -1
- data/sig/client.rbs +17 -0
- data/sig/types.rbs +17 -0
- metadata +1 -1
|
@@ -494,10 +494,15 @@ module Aws::PinpointSMSVoiceV2
|
|
|
494
494
|
#
|
|
495
495
|
# @option params [required, String] :pool_id
|
|
496
496
|
# The pool to update with the new Identity. This value can be either the
|
|
497
|
-
# PoolId or PoolArn, and you can find these values using
|
|
497
|
+
# PoolId or PoolArn, and you can find these values using
|
|
498
|
+
# [DescribePools][1].
|
|
498
499
|
#
|
|
499
|
-
# If you are using a shared
|
|
500
|
-
#
|
|
500
|
+
# If you are using a shared End User MessagingSMS; resource then you
|
|
501
|
+
# must use the full Amazon Resource Name(ARN).
|
|
502
|
+
#
|
|
503
|
+
#
|
|
504
|
+
#
|
|
505
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePools.html
|
|
501
506
|
#
|
|
502
507
|
# @option params [required, String] :origination_identity
|
|
503
508
|
# The origination identity to use, such as PhoneNumberId,
|
|
@@ -506,8 +511,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
506
511
|
# PhoneNumberArn, while DescribeSenderIds can be used to get the values
|
|
507
512
|
# for SenderId and SenderIdArn.
|
|
508
513
|
#
|
|
509
|
-
# If you are using a shared
|
|
510
|
-
#
|
|
514
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
515
|
+
# use the full Amazon Resource Name(ARN).
|
|
511
516
|
#
|
|
512
517
|
# @option params [required, String] :iso_country_code
|
|
513
518
|
# The new two-character code, in ISO 3166-1 alpha-2 format, for the
|
|
@@ -598,6 +603,76 @@ module Aws::PinpointSMSVoiceV2
|
|
|
598
603
|
req.send_request(options)
|
|
599
604
|
end
|
|
600
605
|
|
|
606
|
+
# Returns information about a destination phone number, including
|
|
607
|
+
# whether the number type and whether it is valid, the carrier, and
|
|
608
|
+
# more.
|
|
609
|
+
#
|
|
610
|
+
# @option params [required, String] :phone_number
|
|
611
|
+
# The phone number that you want to retrieve information about. You can
|
|
612
|
+
# provide the phone number in various formats including special
|
|
613
|
+
# characters such as parentheses, brackets, spaces, hyphens, periods,
|
|
614
|
+
# and commas. The service automatically converts the input to E164
|
|
615
|
+
# format for processing.
|
|
616
|
+
#
|
|
617
|
+
# @return [Types::CarrierLookupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
618
|
+
#
|
|
619
|
+
# * {Types::CarrierLookupResult#e164_phone_number #e164_phone_number} => String
|
|
620
|
+
# * {Types::CarrierLookupResult#dialing_country_code #dialing_country_code} => String
|
|
621
|
+
# * {Types::CarrierLookupResult#iso_country_code #iso_country_code} => String
|
|
622
|
+
# * {Types::CarrierLookupResult#country #country} => String
|
|
623
|
+
# * {Types::CarrierLookupResult#mcc #mcc} => String
|
|
624
|
+
# * {Types::CarrierLookupResult#mnc #mnc} => String
|
|
625
|
+
# * {Types::CarrierLookupResult#carrier #carrier} => String
|
|
626
|
+
# * {Types::CarrierLookupResult#phone_number_type #phone_number_type} => String
|
|
627
|
+
#
|
|
628
|
+
#
|
|
629
|
+
# @example Example: Use CarrierLookup
|
|
630
|
+
#
|
|
631
|
+
# # Call the CarrierLookup operation to get information about a customer provided phone number, including if the number is
|
|
632
|
+
# # valid. The service accepts phone numbers with various formatting characters and returns the number in E164 format.
|
|
633
|
+
#
|
|
634
|
+
# resp = client.carrier_lookup({
|
|
635
|
+
# phone_number: "+1 (555) 555-5333",
|
|
636
|
+
# })
|
|
637
|
+
#
|
|
638
|
+
# resp.to_h outputs the following:
|
|
639
|
+
# {
|
|
640
|
+
# carrier: "ExampleCorp Mobile",
|
|
641
|
+
# country: "United States",
|
|
642
|
+
# dialing_country_code: "1",
|
|
643
|
+
# e164_phone_number: "+15555555333",
|
|
644
|
+
# iso_country_code: "US",
|
|
645
|
+
# mcc: "310",
|
|
646
|
+
# mnc: "260",
|
|
647
|
+
# phone_number_type: "MOBILE",
|
|
648
|
+
# }
|
|
649
|
+
#
|
|
650
|
+
# @example Request syntax with placeholder values
|
|
651
|
+
#
|
|
652
|
+
# resp = client.carrier_lookup({
|
|
653
|
+
# phone_number: "CarrierLookupInputPhoneNumberType", # required
|
|
654
|
+
# })
|
|
655
|
+
#
|
|
656
|
+
# @example Response structure
|
|
657
|
+
#
|
|
658
|
+
# resp.e164_phone_number #=> String
|
|
659
|
+
# resp.dialing_country_code #=> String
|
|
660
|
+
# resp.iso_country_code #=> String
|
|
661
|
+
# resp.country #=> String
|
|
662
|
+
# resp.mcc #=> String
|
|
663
|
+
# resp.mnc #=> String
|
|
664
|
+
# resp.carrier #=> String
|
|
665
|
+
# resp.phone_number_type #=> String, one of "MOBILE", "LANDLINE", "OTHER", "INVALID"
|
|
666
|
+
#
|
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CarrierLookup AWS API Documentation
|
|
668
|
+
#
|
|
669
|
+
# @overload carrier_lookup(params = {})
|
|
670
|
+
# @param [Hash] params ({})
|
|
671
|
+
def carrier_lookup(params = {}, options = {})
|
|
672
|
+
req = build_request(:carrier_lookup, params)
|
|
673
|
+
req.send_request(options)
|
|
674
|
+
end
|
|
675
|
+
|
|
601
676
|
# Creates a new configuration set. After you create the configuration
|
|
602
677
|
# set, you can add one or more event destinations to it.
|
|
603
678
|
#
|
|
@@ -690,8 +765,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
690
765
|
#
|
|
691
766
|
# @option params [required, Array<String>] :matching_event_types
|
|
692
767
|
# An array of event types that determine which events to log. If "ALL"
|
|
693
|
-
# is used, then
|
|
694
|
-
# type.
|
|
768
|
+
# is used, then End User MessagingSMS logs every event type.
|
|
695
769
|
#
|
|
696
770
|
# <note markdown="1"> The `TEXT_SENT` event type is not supported.
|
|
697
771
|
#
|
|
@@ -776,8 +850,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
776
850
|
# with the keyword "STOP," an entry for the phone number is added to
|
|
777
851
|
# the opt-out list. In addition to STOP, your recipients can use any
|
|
778
852
|
# supported opt-out keyword, such as CANCEL or OPTOUT. For a list of
|
|
779
|
-
# supported opt-out keywords, see [ SMS opt out ][1] in the
|
|
780
|
-
#
|
|
853
|
+
# supported opt-out keywords, see [ SMS opt out ][1] in the End User
|
|
854
|
+
# MessagingSMS User Guide.
|
|
781
855
|
#
|
|
782
856
|
#
|
|
783
857
|
#
|
|
@@ -854,19 +928,21 @@ module Aws::PinpointSMSVoiceV2
|
|
|
854
928
|
# @option params [required, String] :origination_identity
|
|
855
929
|
# The origination identity to use such as a PhoneNumberId,
|
|
856
930
|
# PhoneNumberArn, SenderId or SenderIdArn. You can use
|
|
857
|
-
# DescribePhoneNumbers to find the values for PhoneNumberId and
|
|
858
|
-
# PhoneNumberArn
|
|
859
|
-
# for SenderId and SenderIdArn.
|
|
931
|
+
# [DescribePhoneNumbers][1] to find the values for PhoneNumberId and
|
|
932
|
+
# PhoneNumberArn, and use [DescribeSenderIds][2] can be used to get the
|
|
933
|
+
# values for SenderId and SenderIdArn.
|
|
860
934
|
#
|
|
861
935
|
# After the pool is created you can add more origination identities to
|
|
862
|
-
# the pool by using [AssociateOriginationIdentity][
|
|
936
|
+
# the pool by using [AssociateOriginationIdentity][3].
|
|
863
937
|
#
|
|
864
|
-
# If you are using a shared
|
|
865
|
-
#
|
|
938
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
939
|
+
# use the full Amazon Resource Name(ARN).
|
|
866
940
|
#
|
|
867
941
|
#
|
|
868
942
|
#
|
|
869
|
-
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/
|
|
943
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePhoneNumbers.html
|
|
944
|
+
# [2]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribeSenderIds.html
|
|
945
|
+
# [3]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html
|
|
870
946
|
#
|
|
871
947
|
# @option params [required, String] :iso_country_code
|
|
872
948
|
# The new two-character code, in ISO 3166-1 alpha-2 format, for the
|
|
@@ -880,7 +956,11 @@ module Aws::PinpointSMSVoiceV2
|
|
|
880
956
|
#
|
|
881
957
|
# @option params [Boolean] :deletion_protection_enabled
|
|
882
958
|
# By default this is set to false. When set to true the pool can't be
|
|
883
|
-
# deleted. You can change this value using the UpdatePool action.
|
|
959
|
+
# deleted. You can change this value using the [UpdatePool][1] action.
|
|
960
|
+
#
|
|
961
|
+
#
|
|
962
|
+
#
|
|
963
|
+
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_UpdatePool.html
|
|
884
964
|
#
|
|
885
965
|
# @option params [Array<Types::Tag>] :tags
|
|
886
966
|
# An array of tags (key and value pairs) associated with the pool.
|
|
@@ -1529,8 +1609,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1529
1609
|
# number or pool. It is also a specific word or phrase that an end user
|
|
1530
1610
|
# can send to your number to elicit a response, such as an informational
|
|
1531
1611
|
# message or a special offer. When your number receives a message that
|
|
1532
|
-
# begins with a keyword,
|
|
1533
|
-
#
|
|
1612
|
+
# begins with a keyword, End User MessagingSMS responds with a
|
|
1613
|
+
# customizable message.
|
|
1534
1614
|
#
|
|
1535
1615
|
# Keywords "HELP" and "STOP" can't be deleted or modified.
|
|
1536
1616
|
#
|
|
@@ -1540,8 +1620,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1540
1620
|
# find the values for PhoneNumberId and PhoneNumberArn and DescribePools
|
|
1541
1621
|
# to find the values of PoolId and PoolArn.
|
|
1542
1622
|
#
|
|
1543
|
-
# If you are using a shared
|
|
1544
|
-
#
|
|
1623
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
1624
|
+
# use the full Amazon Resource Name(ARN).
|
|
1545
1625
|
#
|
|
1546
1626
|
# @option params [required, String] :keyword
|
|
1547
1627
|
# The keyword to delete.
|
|
@@ -1617,8 +1697,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1617
1697
|
# can use DescribeOptOutLists to find the values for OptOutListName and
|
|
1618
1698
|
# OptOutListArn.
|
|
1619
1699
|
#
|
|
1620
|
-
# If you are using a shared
|
|
1621
|
-
#
|
|
1700
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
1701
|
+
# use the full Amazon Resource Name(ARN).
|
|
1622
1702
|
#
|
|
1623
1703
|
# @return [Types::DeleteOptOutListResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1624
1704
|
#
|
|
@@ -1658,8 +1738,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1658
1738
|
# @option params [required, String] :opt_out_list_name
|
|
1659
1739
|
# The OptOutListName or OptOutListArn to remove the phone number from.
|
|
1660
1740
|
#
|
|
1661
|
-
# If you are using a shared
|
|
1662
|
-
#
|
|
1741
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
1742
|
+
# use the full Amazon Resource Name(ARN).
|
|
1663
1743
|
#
|
|
1664
1744
|
# @option params [required, String] :opted_out_number
|
|
1665
1745
|
# The phone number, in E.164 format, to remove from the OptOutList.
|
|
@@ -1710,8 +1790,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1710
1790
|
# The PoolId or PoolArn of the pool to delete. You can use DescribePools
|
|
1711
1791
|
# to find the values for PoolId and PoolArn .
|
|
1712
1792
|
#
|
|
1713
|
-
# If you are using a shared
|
|
1714
|
-
#
|
|
1793
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
1794
|
+
# use the full Amazon Resource Name(ARN).
|
|
1715
1795
|
#
|
|
1716
1796
|
# @return [Types::DeletePoolResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1717
1797
|
#
|
|
@@ -1966,13 +2046,13 @@ module Aws::PinpointSMSVoiceV2
|
|
|
1966
2046
|
req.send_request(options)
|
|
1967
2047
|
end
|
|
1968
2048
|
|
|
1969
|
-
# Deletes the resource-based policy document attached to the
|
|
1970
|
-
#
|
|
1971
|
-
#
|
|
2049
|
+
# Deletes the resource-based policy document attached to the End User
|
|
2050
|
+
# MessagingSMS resource. A shared resource can be a Pool, Opt-out list,
|
|
2051
|
+
# Sender Id, or Phone number.
|
|
1972
2052
|
#
|
|
1973
2053
|
# @option params [required, String] :resource_arn
|
|
1974
|
-
# The Amazon Resource Name (ARN) of the
|
|
1975
|
-
#
|
|
2054
|
+
# The Amazon Resource Name (ARN) of the End User MessagingSMS resource
|
|
2055
|
+
# you're deleting the resource-based policy from.
|
|
1976
2056
|
#
|
|
1977
2057
|
# @return [Types::DeleteResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1978
2058
|
#
|
|
@@ -2005,7 +2085,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2005
2085
|
# text messages. Deleting a spend limit override will set the
|
|
2006
2086
|
# `EnforcedLimit` to equal the `MaxLimit`, which is controlled by Amazon
|
|
2007
2087
|
# Web Services. For more information on spend limits (quotas) see
|
|
2008
|
-
# [Quotas ][1] in the *
|
|
2088
|
+
# [Quotas ][1] in the *End User MessagingSMS User Guide*.
|
|
2009
2089
|
#
|
|
2010
2090
|
#
|
|
2011
2091
|
#
|
|
@@ -2066,7 +2146,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2066
2146
|
# voice messages. Deleting a spend limit override sets the
|
|
2067
2147
|
# `EnforcedLimit` equal to the `MaxLimit`, which is controlled by Amazon
|
|
2068
2148
|
# Web Services. For more information on spending limits (quotas) see
|
|
2069
|
-
# [Quotas ][1] in the *
|
|
2149
|
+
# [Quotas ][1] in the *End User MessagingSMS User Guide*.
|
|
2070
2150
|
#
|
|
2071
2151
|
#
|
|
2072
2152
|
#
|
|
@@ -2136,16 +2216,16 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2136
2216
|
req.send_request(options)
|
|
2137
2217
|
end
|
|
2138
2218
|
|
|
2139
|
-
# Describes the current
|
|
2140
|
-
#
|
|
2141
|
-
#
|
|
2142
|
-
#
|
|
2219
|
+
# Describes the current End User MessagingSMS SMS Voice V2 resource
|
|
2220
|
+
# quotas for your account. The description for a quota includes the
|
|
2221
|
+
# quota name, current usage toward that quota, and the quota's maximum
|
|
2222
|
+
# value.
|
|
2143
2223
|
#
|
|
2144
2224
|
# When you establish an Amazon Web Services account, the account has
|
|
2145
2225
|
# initial quotas on the maximum number of configuration sets, opt-out
|
|
2146
2226
|
# lists, phone numbers, and pools that you can create in a given Region.
|
|
2147
|
-
# For more information see [Quotas ][1] in the *
|
|
2148
|
-
#
|
|
2227
|
+
# For more information see [Quotas ][1] in the *End User MessagingSMS
|
|
2228
|
+
# User Guide*.
|
|
2149
2229
|
#
|
|
2150
2230
|
#
|
|
2151
2231
|
#
|
|
@@ -2274,8 +2354,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2274
2354
|
# number or pool. It is also a specific word or phrase that an end user
|
|
2275
2355
|
# can send to your number to elicit a response, such as an informational
|
|
2276
2356
|
# message or a special offer. When your number receives a message that
|
|
2277
|
-
# begins with a keyword,
|
|
2278
|
-
#
|
|
2357
|
+
# begins with a keyword, End User MessagingSMS responds with a
|
|
2358
|
+
# customizable message.
|
|
2279
2359
|
#
|
|
2280
2360
|
# If you specify a keyword that isn't valid, an error is returned.
|
|
2281
2361
|
#
|
|
@@ -2286,8 +2366,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2286
2366
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
|
2287
2367
|
# for SenderId and SenderIdArn.
|
|
2288
2368
|
#
|
|
2289
|
-
# If you are using a shared
|
|
2290
|
-
#
|
|
2369
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
2370
|
+
# use the full Amazon Resource Name(ARN).
|
|
2291
2371
|
#
|
|
2292
2372
|
# @option params [Array<String>] :keywords
|
|
2293
2373
|
# An array of keywords to search for.
|
|
@@ -2361,8 +2441,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2361
2441
|
# The OptOutLists to show the details of. This is an array of strings
|
|
2362
2442
|
# that can be either the OptOutListName or OptOutListArn.
|
|
2363
2443
|
#
|
|
2364
|
-
# If you are using a shared
|
|
2365
|
-
#
|
|
2444
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
2445
|
+
# use the full Amazon Resource Name(ARN).
|
|
2366
2446
|
#
|
|
2367
2447
|
# @option params [String] :next_token
|
|
2368
2448
|
# The token to be used for the next set of paginated results. You don't
|
|
@@ -2428,8 +2508,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2428
2508
|
# DescribeOptOutLists to find the values for OptOutListName and
|
|
2429
2509
|
# OptOutListArn.
|
|
2430
2510
|
#
|
|
2431
|
-
# If you are using a shared
|
|
2432
|
-
#
|
|
2511
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
2512
|
+
# use the full Amazon Resource Name(ARN).
|
|
2433
2513
|
#
|
|
2434
2514
|
# @option params [Array<String>] :opted_out_numbers
|
|
2435
2515
|
# An array of phone numbers to search for in the OptOutList.
|
|
@@ -2507,8 +2587,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2507
2587
|
# is an array of strings that can be either the PhoneNumberId or
|
|
2508
2588
|
# PhoneNumberArn.
|
|
2509
2589
|
#
|
|
2510
|
-
# If you are using a shared
|
|
2511
|
-
#
|
|
2590
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
2591
|
+
# use the full Amazon Resource Name(ARN).
|
|
2512
2592
|
#
|
|
2513
2593
|
# @option params [Array<Types::PhoneNumberFilter>] :filters
|
|
2514
2594
|
# An array of PhoneNumberFilter objects to filter the results.
|
|
@@ -2601,8 +2681,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
2601
2681
|
# The unique identifier of pools to find. This is an array of strings
|
|
2602
2682
|
# that can be either the PoolId or PoolArn.
|
|
2603
2683
|
#
|
|
2604
|
-
# If you are using a shared
|
|
2605
|
-
#
|
|
2684
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
2685
|
+
# use the full Amazon Resource Name(ARN).
|
|
2606
2686
|
#
|
|
2607
2687
|
# @option params [Array<Types::PoolFilter>] :filters
|
|
2608
2688
|
# An array of PoolFilter objects to filter the results.
|
|
@@ -3191,8 +3271,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3191
3271
|
# @option params [Array<Types::SenderIdAndCountry>] :sender_ids
|
|
3192
3272
|
# An array of SenderIdAndCountry objects to search for.
|
|
3193
3273
|
#
|
|
3194
|
-
# If you are using a shared
|
|
3195
|
-
#
|
|
3274
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
3275
|
+
# use the full Amazon Resource Name(ARN).
|
|
3196
3276
|
#
|
|
3197
3277
|
# @option params [Array<Types::SenderIdFilter>] :filters
|
|
3198
3278
|
# An array of SenderIdFilter objects to filter the results.
|
|
@@ -3265,8 +3345,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3265
3345
|
# When you establish an Amazon Web Services account, the account has
|
|
3266
3346
|
# initial monthly spend limit in a given Region. For more information on
|
|
3267
3347
|
# increasing your monthly spend limit, see [ Requesting increases to
|
|
3268
|
-
# your monthly SMS, MMS, or Voice spending quota ][1] in the *
|
|
3269
|
-
#
|
|
3348
|
+
# your monthly SMS, MMS, or Voice spending quota ][1] in the *End User
|
|
3349
|
+
# MessagingSMS User Guide*.
|
|
3270
3350
|
#
|
|
3271
3351
|
#
|
|
3272
3352
|
#
|
|
@@ -3380,8 +3460,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3380
3460
|
# The unique identifier for the pool to disassociate with the
|
|
3381
3461
|
# origination identity. This value can be either the PoolId or PoolArn.
|
|
3382
3462
|
#
|
|
3383
|
-
# If you are using a shared
|
|
3384
|
-
#
|
|
3463
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
3464
|
+
# use the full Amazon Resource Name(ARN).
|
|
3385
3465
|
#
|
|
3386
3466
|
# @option params [required, String] :origination_identity
|
|
3387
3467
|
# The origination identity to use such as a PhoneNumberId,
|
|
@@ -3390,8 +3470,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3390
3470
|
# PhoneNumberArn, or use DescribeSenderIds to get the values for
|
|
3391
3471
|
# SenderId and SenderIdArn.
|
|
3392
3472
|
#
|
|
3393
|
-
# If you are using a shared
|
|
3394
|
-
#
|
|
3473
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
3474
|
+
# use the full Amazon Resource Name(ARN).
|
|
3395
3475
|
#
|
|
3396
3476
|
# @option params [required, String] :iso_country_code
|
|
3397
3477
|
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
|
@@ -3564,12 +3644,12 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3564
3644
|
end
|
|
3565
3645
|
|
|
3566
3646
|
# Retrieves the JSON text of the resource-based policy document attached
|
|
3567
|
-
# to the
|
|
3568
|
-
#
|
|
3647
|
+
# to the End User MessagingSMS resource. A shared resource can be a
|
|
3648
|
+
# Pool, Opt-out list, Sender Id, or Phone number.
|
|
3569
3649
|
#
|
|
3570
3650
|
# @option params [required, String] :resource_arn
|
|
3571
|
-
# The Amazon Resource Name (ARN) of the
|
|
3572
|
-
#
|
|
3651
|
+
# The Amazon Resource Name (ARN) of the End User MessagingSMS resource
|
|
3652
|
+
# attached to the resource-based policy.
|
|
3573
3653
|
#
|
|
3574
3654
|
# @return [Types::GetResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3575
3655
|
#
|
|
@@ -3607,8 +3687,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3607
3687
|
# The unique identifier for the pool. This value can be either the
|
|
3608
3688
|
# PoolId or PoolArn.
|
|
3609
3689
|
#
|
|
3610
|
-
# If you are using a shared
|
|
3611
|
-
#
|
|
3690
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
3691
|
+
# use the full Amazon Resource Name(ARN).
|
|
3612
3692
|
#
|
|
3613
3693
|
# @option params [Array<Types::PoolOriginationIdentitiesFilter>] :filters
|
|
3614
3694
|
# An array of PoolOriginationIdentitiesFilter objects to filter the
|
|
@@ -3829,8 +3909,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3829
3909
|
# number or pool. It is also a specific word or phrase that an end user
|
|
3830
3910
|
# can send to your number to elicit a response, such as an informational
|
|
3831
3911
|
# message or a special offer. When your number receives a message that
|
|
3832
|
-
# begins with a keyword,
|
|
3833
|
-
#
|
|
3912
|
+
# begins with a keyword, End User MessagingSMS responds with a
|
|
3913
|
+
# customizable message.
|
|
3834
3914
|
#
|
|
3835
3915
|
# If you specify a keyword that isn't valid, an error is returned.
|
|
3836
3916
|
#
|
|
@@ -3841,8 +3921,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3841
3921
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
|
3842
3922
|
# for SenderId and SenderIdArn.
|
|
3843
3923
|
#
|
|
3844
|
-
# If you are using a shared
|
|
3845
|
-
#
|
|
3924
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
3925
|
+
# use the full Amazon Resource Name(ARN).
|
|
3846
3926
|
#
|
|
3847
3927
|
# @option params [required, String] :keyword
|
|
3848
3928
|
# The new keyword to add.
|
|
@@ -3942,8 +4022,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
3942
4022
|
# @option params [required, String] :opt_out_list_name
|
|
3943
4023
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
|
3944
4024
|
#
|
|
3945
|
-
# If you are using a shared
|
|
3946
|
-
#
|
|
4025
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4026
|
+
# use the full Amazon Resource Name(ARN).
|
|
3947
4027
|
#
|
|
3948
4028
|
# @option params [required, String] :opted_out_number
|
|
3949
4029
|
# The phone number to add to the OptOutList in E.164 format.
|
|
@@ -4103,20 +4183,20 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4103
4183
|
req.send_request(options)
|
|
4104
4184
|
end
|
|
4105
4185
|
|
|
4106
|
-
# Attaches a resource-based policy to a
|
|
4107
|
-
#
|
|
4108
|
-
#
|
|
4109
|
-
#
|
|
4110
|
-
#
|
|
4111
|
-
#
|
|
4186
|
+
# Attaches a resource-based policy to a End User MessagingSMS
|
|
4187
|
+
# resource(phone number, sender Id, phone poll, or opt-out list) that is
|
|
4188
|
+
# used for sharing the resource. A shared resource can be a Pool,
|
|
4189
|
+
# Opt-out list, Sender Id, or Phone number. For more information about
|
|
4190
|
+
# resource-based policies, see [Working with shared resources][1] in the
|
|
4191
|
+
# *End User MessagingSMS User Guide*.
|
|
4112
4192
|
#
|
|
4113
4193
|
#
|
|
4114
4194
|
#
|
|
4115
4195
|
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html
|
|
4116
4196
|
#
|
|
4117
4197
|
# @option params [required, String] :resource_arn
|
|
4118
|
-
# The Amazon Resource Name (ARN) of the
|
|
4119
|
-
#
|
|
4198
|
+
# The Amazon Resource Name (ARN) of the End User MessagingSMS resource
|
|
4199
|
+
# to attach the resource-based policy to.
|
|
4120
4200
|
#
|
|
4121
4201
|
# @option params [required, String] :policy
|
|
4122
4202
|
# The JSON formatted resource-based policy to attach.
|
|
@@ -4160,8 +4240,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4160
4240
|
# You can use DescribePhoneNumbers to get the values for PhoneNumberId
|
|
4161
4241
|
# and PhoneNumberArn.
|
|
4162
4242
|
#
|
|
4163
|
-
# If you are using a shared
|
|
4164
|
-
#
|
|
4243
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4244
|
+
# use the full Amazon Resource Name(ARN).
|
|
4165
4245
|
#
|
|
4166
4246
|
# @return [Types::ReleasePhoneNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4167
4247
|
#
|
|
@@ -4265,7 +4345,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4265
4345
|
|
|
4266
4346
|
# Request an origination phone number for use in your account. For more
|
|
4267
4347
|
# information on phone number request see [Request a phone number][1] in
|
|
4268
|
-
# the *
|
|
4348
|
+
# the *End User MessagingSMS User Guide*.
|
|
4269
4349
|
#
|
|
4270
4350
|
#
|
|
4271
4351
|
#
|
|
@@ -4294,15 +4374,15 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4294
4374
|
# The name of the OptOutList to associate with the phone number. You can
|
|
4295
4375
|
# use the OptOutListName or OptOutListArn.
|
|
4296
4376
|
#
|
|
4297
|
-
# If you are using a shared
|
|
4298
|
-
#
|
|
4377
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4378
|
+
# use the full Amazon Resource Name(ARN).
|
|
4299
4379
|
#
|
|
4300
4380
|
# @option params [String] :pool_id
|
|
4301
4381
|
# The pool to associated with the phone number. You can use the PoolId
|
|
4302
4382
|
# or PoolArn.
|
|
4303
4383
|
#
|
|
4304
|
-
# If you are using a shared
|
|
4305
|
-
#
|
|
4384
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4385
|
+
# use the full Amazon Resource Name(ARN).
|
|
4306
4386
|
#
|
|
4307
4387
|
# @option params [String] :registration_id
|
|
4308
4388
|
# Use this field to attach your phone number for an external
|
|
@@ -4317,7 +4397,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4317
4397
|
# can't be deleted.
|
|
4318
4398
|
#
|
|
4319
4399
|
# @option params [Array<Types::Tag>] :tags
|
|
4320
|
-
# An array of tags (key and value pairs) associate with the requested
|
|
4400
|
+
# An array of tags (key and value pairs) to associate with the requested
|
|
4321
4401
|
# phone number.
|
|
4322
4402
|
#
|
|
4323
4403
|
# @option params [String] :client_token
|
|
@@ -4510,8 +4590,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4510
4590
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
4511
4591
|
# PoolId, or PoolArn.
|
|
4512
4592
|
#
|
|
4513
|
-
# If you are using a shared
|
|
4514
|
-
#
|
|
4593
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4594
|
+
# use the full Amazon Resource Name(ARN).
|
|
4515
4595
|
#
|
|
4516
4596
|
# @option params [String] :configuration_set_name
|
|
4517
4597
|
# The name of the configuration set to use. This can be either the
|
|
@@ -4576,8 +4656,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4576
4656
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
4577
4657
|
# PoolId, or PoolArn.
|
|
4578
4658
|
#
|
|
4579
|
-
# If you are using a shared
|
|
4580
|
-
#
|
|
4659
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4660
|
+
# use the full Amazon Resource Name(ARN).
|
|
4581
4661
|
#
|
|
4582
4662
|
# @option params [String] :message_body
|
|
4583
4663
|
# The text body of the message.
|
|
@@ -4670,8 +4750,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4670
4750
|
# Your MPS limit depends on the destination country of your messages, as
|
|
4671
4751
|
# well as the type of phone number (origination number) that you use to
|
|
4672
4752
|
# send the message. For more information about MPS, see [Message Parts
|
|
4673
|
-
# per Second (MPS) limits][1] in the *
|
|
4674
|
-
# Guide*.
|
|
4753
|
+
# per Second (MPS) limits][1] in the *End User MessagingSMS User Guide*.
|
|
4675
4754
|
#
|
|
4676
4755
|
#
|
|
4677
4756
|
#
|
|
@@ -4685,8 +4764,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4685
4764
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
|
4686
4765
|
# PoolId, or PoolArn.
|
|
4687
4766
|
#
|
|
4688
|
-
# If you are using a shared
|
|
4689
|
-
#
|
|
4767
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4768
|
+
# use the full Amazon Resource Name(ARN).
|
|
4690
4769
|
#
|
|
4691
4770
|
# @option params [String] :message_body
|
|
4692
4771
|
# The body of the text message.
|
|
@@ -4749,8 +4828,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4749
4828
|
# The Message Parts per Second (MPS) limit when using `DryRun` is five.
|
|
4750
4829
|
# If your origination identity has a lower MPS limit then the lower MPS
|
|
4751
4830
|
# limit is used. For more information about MPS limits, see [Message
|
|
4752
|
-
# Parts per Second (MPS) limits][1] in the *
|
|
4753
|
-
#
|
|
4831
|
+
# Parts per Second (MPS) limits][1] in the *End User MessagingSMS User
|
|
4832
|
+
# Guide*..
|
|
4754
4833
|
#
|
|
4755
4834
|
#
|
|
4756
4835
|
#
|
|
@@ -4818,8 +4897,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
4818
4897
|
# The origination identity to use for the voice call. This can be the
|
|
4819
4898
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
|
|
4820
4899
|
#
|
|
4821
|
-
# If you are using a shared
|
|
4822
|
-
#
|
|
4900
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
4901
|
+
# use the full Amazon Resource Name(ARN).
|
|
4823
4902
|
#
|
|
4824
4903
|
# @option params [String] :message_body
|
|
4825
4904
|
# The text to convert to a voice message.
|
|
@@ -5209,7 +5288,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5209
5288
|
# When you specify an existing tag key, the value is overwritten with
|
|
5210
5289
|
# the new value. Each tag consists of a key and an optional value. Tag
|
|
5211
5290
|
# keys must be unique per resource. For more information about tags, see
|
|
5212
|
-
# [Tags ][1] in the *
|
|
5291
|
+
# [Tags ][1] in the *End User MessagingSMS User Guide*.
|
|
5213
5292
|
#
|
|
5214
5293
|
#
|
|
5215
5294
|
#
|
|
@@ -5246,8 +5325,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5246
5325
|
end
|
|
5247
5326
|
|
|
5248
5327
|
# Removes the association of the specified tags from a resource. For
|
|
5249
|
-
# more information on tags see [Tags ][1] in the *
|
|
5250
|
-
#
|
|
5328
|
+
# more information on tags see [Tags ][1] in the *End User MessagingSMS
|
|
5329
|
+
# User Guide*.
|
|
5251
5330
|
#
|
|
5252
5331
|
#
|
|
5253
5332
|
#
|
|
@@ -5377,8 +5456,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5377
5456
|
# The unique identifier of the phone number. Valid values for this field
|
|
5378
5457
|
# can be either the PhoneNumberId or PhoneNumberArn.
|
|
5379
5458
|
#
|
|
5380
|
-
# If you are using a shared
|
|
5381
|
-
#
|
|
5459
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
5460
|
+
# use the full Amazon Resource Name(ARN).
|
|
5382
5461
|
#
|
|
5383
5462
|
# @option params [Boolean] :two_way_enabled
|
|
5384
5463
|
# By default this is set to false. When set to true you can receive
|
|
@@ -5392,17 +5471,17 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5392
5471
|
# inbound SMS messages.
|
|
5393
5472
|
#
|
|
5394
5473
|
# @option params [Boolean] :self_managed_opt_outs_enabled
|
|
5395
|
-
# By default this is set to false. When
|
|
5396
|
-
# that begins with HELP or STOP to one of your
|
|
5397
|
-
# End User
|
|
5474
|
+
# By default this is set to false. When set to false and an end
|
|
5475
|
+
# recipient sends a message that begins with HELP or STOP to one of your
|
|
5476
|
+
# dedicated numbers, End User MessagingSMS automatically replies with a
|
|
5398
5477
|
# customizable message and adds the end recipient to the OptOutList.
|
|
5399
5478
|
# When set to true you're responsible for responding to HELP and STOP
|
|
5400
5479
|
# requests. You're also responsible for tracking and honoring opt-out
|
|
5401
5480
|
# requests.
|
|
5402
5481
|
#
|
|
5403
5482
|
# @option params [String] :opt_out_list_name
|
|
5404
|
-
# The OptOutList to add the phone number to.
|
|
5405
|
-
#
|
|
5483
|
+
# The OptOutList to add the phone number to. You can use either the opt
|
|
5484
|
+
# out list name or the opt out list ARN.
|
|
5406
5485
|
#
|
|
5407
5486
|
# @option params [Boolean] :international_sending_enabled
|
|
5408
5487
|
# By default this is set to false. When set to true the international
|
|
@@ -5486,8 +5565,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5486
5565
|
# The unique identifier of the pool to update. Valid values are either
|
|
5487
5566
|
# the PoolId or PoolArn.
|
|
5488
5567
|
#
|
|
5489
|
-
# If you are using a shared
|
|
5490
|
-
#
|
|
5568
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
5569
|
+
# use the full Amazon Resource Name(ARN).
|
|
5491
5570
|
#
|
|
5492
5571
|
# @option params [Boolean] :two_way_enabled
|
|
5493
5572
|
# By default this is set to false. When set to true you can receive
|
|
@@ -5501,9 +5580,9 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5501
5580
|
# inbound SMS messages.
|
|
5502
5581
|
#
|
|
5503
5582
|
# @option params [Boolean] :self_managed_opt_outs_enabled
|
|
5504
|
-
# By default this is set to false. When
|
|
5505
|
-
# that begins with HELP or STOP to one of your
|
|
5506
|
-
# End User
|
|
5583
|
+
# By default this is set to false. When set to false and an end
|
|
5584
|
+
# recipient sends a message that begins with HELP or STOP to one of your
|
|
5585
|
+
# dedicated numbers, End User MessagingSMS automatically replies with a
|
|
5507
5586
|
# customizable message and adds the end recipient to the OptOutList.
|
|
5508
5587
|
# When set to true you're responsible for responding to HELP and STOP
|
|
5509
5588
|
# requests. You're also responsible for tracking and honoring opt-out
|
|
@@ -5513,8 +5592,8 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5513
5592
|
# The OptOutList to associate with the pool. Valid values are either
|
|
5514
5593
|
# OptOutListName or OptOutListArn.
|
|
5515
5594
|
#
|
|
5516
|
-
# If you are using a shared
|
|
5517
|
-
#
|
|
5595
|
+
# If you are using a shared End User MessagingSMS resource then you must
|
|
5596
|
+
# use the full Amazon Resource Name(ARN).
|
|
5518
5597
|
#
|
|
5519
5598
|
# @option params [Boolean] :shared_routes_enabled
|
|
5520
5599
|
# Indicates whether shared routes are enabled for the pool.
|
|
@@ -5631,7 +5710,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5631
5710
|
# contain the details for the requested NumberCapability. The Key is the
|
|
5632
5711
|
# two-letter ISO country code. For a list of supported ISO country
|
|
5633
5712
|
# codes, see [Supported countries and regions (SMS channel)][1] in the
|
|
5634
|
-
#
|
|
5713
|
+
# End User MessagingSMS User Guide.
|
|
5635
5714
|
#
|
|
5636
5715
|
# For example, to set the United States as allowed and Canada as
|
|
5637
5716
|
# blocked, the `CountryRuleSetUpdates` would be formatted as:
|
|
@@ -5792,7 +5871,7 @@ module Aws::PinpointSMSVoiceV2
|
|
|
5792
5871
|
tracer: tracer
|
|
5793
5872
|
)
|
|
5794
5873
|
context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
|
|
5795
|
-
context[:gem_version] = '1.
|
|
5874
|
+
context[:gem_version] = '1.47.0'
|
|
5796
5875
|
Seahorse::Client::Request.new(handlers, context)
|
|
5797
5876
|
end
|
|
5798
5877
|
|