aws-sdk-pinpointsmsvoicev2 1.26.0 → 1.27.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 +227 -3
- data/lib/aws-sdk-pinpointsmsvoicev2/client_api.rb +76 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/endpoints.rb +33 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-pinpointsmsvoicev2/types.rb +248 -4
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +3 -1
- data/sig/client.rbs +45 -4
- data/sig/types.rbs +43 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a6a096ea210f76bfdd4859120fd150d3a4ca4ada1dc3def7a71da68813d0f503
|
4
|
+
data.tar.gz: a25b481bb11f755c84d7b023c1cf2ddada94811439d17fff619b0dcb96b4ba13
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 785dac853591842e777542b0004b913563b4a1eea6e92393d09b92cc932a643a7b84c6ca6694dcc7a5d727e6a18cd39e49126abde119a36951c33b2f5fcc22f8
|
7
|
+
data.tar.gz: b0226ffb4a33583f4d2f5dead1be987e24aecdbb9b1f5a809d40b3225fd0b8ff36b07806a34c24f30409c42bdceb76df6eeeb4099ad11495735dcfd0d458f834
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.27.0 (2024-09-24)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS End User Messaging SMS-Voice V2 has added support for resource policies. Use the three new APIs to create, view, edit, and delete resource policies.
|
8
|
+
|
4
9
|
1.26.0 (2024-09-23)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.27.0
|
@@ -36,8 +36,6 @@ require 'aws-sdk-core/plugins/telemetry.rb'
|
|
36
36
|
require 'aws-sdk-core/plugins/sign.rb'
|
37
37
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
38
38
|
|
39
|
-
Aws::Plugins::GlobalConfiguration.add_identifier(:pinpointsmsvoicev2)
|
40
|
-
|
41
39
|
module Aws::PinpointSMSVoiceV2
|
42
40
|
# An API client for PinpointSMSVoiceV2. To construct a client, you need to configure a `:region` and `:credentials`.
|
43
41
|
#
|
@@ -469,6 +467,9 @@ module Aws::PinpointSMSVoiceV2
|
|
469
467
|
# The pool to update with the new Identity. This value can be either the
|
470
468
|
# PoolId or PoolArn, and you can find these values using DescribePools.
|
471
469
|
#
|
470
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
471
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
472
|
+
#
|
472
473
|
# @option params [required, String] :origination_identity
|
473
474
|
# The origination identity to use, such as PhoneNumberId,
|
474
475
|
# PhoneNumberArn, SenderId, or SenderIdArn. You can use
|
@@ -476,6 +477,9 @@ module Aws::PinpointSMSVoiceV2
|
|
476
477
|
# PhoneNumberArn, while DescribeSenderIds can be used to get the values
|
477
478
|
# for SenderId and SenderIdArn.
|
478
479
|
#
|
480
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
481
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
482
|
+
#
|
479
483
|
# @option params [required, String] :iso_country_code
|
480
484
|
# The new two-character code, in ISO 3166-1 alpha-2 format, for the
|
481
485
|
# country or region of the origination identity.
|
@@ -822,6 +826,9 @@ module Aws::PinpointSMSVoiceV2
|
|
822
826
|
# After the pool is created you can add more origination identities to
|
823
827
|
# the pool by using [AssociateOriginationIdentity][1].
|
824
828
|
#
|
829
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
830
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
831
|
+
#
|
825
832
|
#
|
826
833
|
#
|
827
834
|
# [1]: https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_AssociateOriginationIdentity.html
|
@@ -1491,6 +1498,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1491
1498
|
# find the values for PhoneNumberId and PhoneNumberArn and DescribePools
|
1492
1499
|
# to find the values of PoolId and PoolArn.
|
1493
1500
|
#
|
1501
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1502
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1503
|
+
#
|
1494
1504
|
# @option params [required, String] :keyword
|
1495
1505
|
# The keyword to delete.
|
1496
1506
|
#
|
@@ -1565,6 +1575,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1565
1575
|
# can use DescribeOptOutLists to find the values for OptOutListName and
|
1566
1576
|
# OptOutListArn.
|
1567
1577
|
#
|
1578
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1579
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1580
|
+
#
|
1568
1581
|
# @return [Types::DeleteOptOutListResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1569
1582
|
#
|
1570
1583
|
# * {Types::DeleteOptOutListResult#opt_out_list_arn #opt_out_list_arn} => String
|
@@ -1603,6 +1616,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1603
1616
|
# @option params [required, String] :opt_out_list_name
|
1604
1617
|
# The OptOutListName or OptOutListArn to remove the phone number from.
|
1605
1618
|
#
|
1619
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1620
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1621
|
+
#
|
1606
1622
|
# @option params [required, String] :opted_out_number
|
1607
1623
|
# The phone number, in E.164 format, to remove from the OptOutList.
|
1608
1624
|
#
|
@@ -1652,6 +1668,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1652
1668
|
# The PoolId or PoolArn of the pool to delete. You can use DescribePools
|
1653
1669
|
# to find the values for PoolId and PoolArn .
|
1654
1670
|
#
|
1671
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1672
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1673
|
+
#
|
1655
1674
|
# @return [Types::DeletePoolResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1656
1675
|
#
|
1657
1676
|
# * {Types::DeletePoolResult#pool_arn #pool_arn} => String
|
@@ -1861,6 +1880,41 @@ module Aws::PinpointSMSVoiceV2
|
|
1861
1880
|
req.send_request(options)
|
1862
1881
|
end
|
1863
1882
|
|
1883
|
+
# Deletes the resource-based policy document attached to the AWS End
|
1884
|
+
# User Messaging SMS and Voice resource. A shared resource can be a
|
1885
|
+
# Pool, Opt-out list, Sender Id, or Phone number.
|
1886
|
+
#
|
1887
|
+
# @option params [required, String] :resource_arn
|
1888
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
1889
|
+
# Voice resource you're deleting the resource-based policy from.
|
1890
|
+
#
|
1891
|
+
# @return [Types::DeleteResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1892
|
+
#
|
1893
|
+
# * {Types::DeleteResourcePolicyResult#resource_arn #resource_arn} => String
|
1894
|
+
# * {Types::DeleteResourcePolicyResult#policy #policy} => String
|
1895
|
+
# * {Types::DeleteResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
1896
|
+
#
|
1897
|
+
# @example Request syntax with placeholder values
|
1898
|
+
#
|
1899
|
+
# resp = client.delete_resource_policy({
|
1900
|
+
# resource_arn: "AmazonResourceName", # required
|
1901
|
+
# })
|
1902
|
+
#
|
1903
|
+
# @example Response structure
|
1904
|
+
#
|
1905
|
+
# resp.resource_arn #=> String
|
1906
|
+
# resp.policy #=> String
|
1907
|
+
# resp.created_timestamp #=> Time
|
1908
|
+
#
|
1909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteResourcePolicy AWS API Documentation
|
1910
|
+
#
|
1911
|
+
# @overload delete_resource_policy(params = {})
|
1912
|
+
# @param [Hash] params ({})
|
1913
|
+
def delete_resource_policy(params = {}, options = {})
|
1914
|
+
req = build_request(:delete_resource_policy, params)
|
1915
|
+
req.send_request(options)
|
1916
|
+
end
|
1917
|
+
|
1864
1918
|
# Deletes an account-level monthly spending limit override for sending
|
1865
1919
|
# text messages. Deleting a spend limit override will set the
|
1866
1920
|
# `EnforcedLimit` to equal the `MaxLimit`, which is controlled by Amazon
|
@@ -2145,6 +2199,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2145
2199
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
2146
2200
|
# for SenderId and SenderIdArn.
|
2147
2201
|
#
|
2202
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2203
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2204
|
+
#
|
2148
2205
|
# @option params [Array<String>] :keywords
|
2149
2206
|
# An array of keywords to search for.
|
2150
2207
|
#
|
@@ -2217,6 +2274,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2217
2274
|
# The OptOutLists to show the details of. This is an array of strings
|
2218
2275
|
# that can be either the OptOutListName or OptOutListArn.
|
2219
2276
|
#
|
2277
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2278
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2279
|
+
#
|
2220
2280
|
# @option params [String] :next_token
|
2221
2281
|
# The token to be used for the next set of paginated results. You don't
|
2222
2282
|
# need to supply a value for this field in the initial request.
|
@@ -2224,6 +2284,12 @@ module Aws::PinpointSMSVoiceV2
|
|
2224
2284
|
# @option params [Integer] :max_results
|
2225
2285
|
# The maximum number of results to return per each request.
|
2226
2286
|
#
|
2287
|
+
# @option params [String] :owner
|
2288
|
+
# Use `SELF` to filter the list of Opt-Out List to ones your account
|
2289
|
+
# owns or use `SHARED` to filter on Opt-Out List shared with your
|
2290
|
+
# account. The `Owner` and `OptOutListNames` parameters can't be used
|
2291
|
+
# at the same time.
|
2292
|
+
#
|
2227
2293
|
# @return [Types::DescribeOptOutListsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2228
2294
|
#
|
2229
2295
|
# * {Types::DescribeOptOutListsResult#opt_out_lists #opt_out_lists} => Array<Types::OptOutListInformation>
|
@@ -2237,6 +2303,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2237
2303
|
# opt_out_list_names: ["OptOutListNameOrArn"],
|
2238
2304
|
# next_token: "NextToken",
|
2239
2305
|
# max_results: 1,
|
2306
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2240
2307
|
# })
|
2241
2308
|
#
|
2242
2309
|
# @example Response structure
|
@@ -2274,6 +2341,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2274
2341
|
# DescribeOptOutLists to find the values for OptOutListName and
|
2275
2342
|
# OptOutListArn.
|
2276
2343
|
#
|
2344
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2345
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2346
|
+
#
|
2277
2347
|
# @option params [Array<String>] :opted_out_numbers
|
2278
2348
|
# An array of phone numbers to search for in the OptOutList.
|
2279
2349
|
#
|
@@ -2347,6 +2417,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2347
2417
|
# is an array of strings that can be either the PhoneNumberId or
|
2348
2418
|
# PhoneNumberArn.
|
2349
2419
|
#
|
2420
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2421
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2422
|
+
#
|
2350
2423
|
# @option params [Array<Types::PhoneNumberFilter>] :filters
|
2351
2424
|
# An array of PhoneNumberFilter objects to filter the results.
|
2352
2425
|
#
|
@@ -2357,6 +2430,12 @@ module Aws::PinpointSMSVoiceV2
|
|
2357
2430
|
# @option params [Integer] :max_results
|
2358
2431
|
# The maximum number of results to return per each request.
|
2359
2432
|
#
|
2433
|
+
# @option params [String] :owner
|
2434
|
+
# Use `SELF` to filter the list of phone numbers to ones your account
|
2435
|
+
# owns or use `SHARED` to filter on phone numbers shared with your
|
2436
|
+
# account. The `Owner` and `PhoneNumberIds` parameters can't be used at
|
2437
|
+
# the same time.
|
2438
|
+
#
|
2360
2439
|
# @return [Types::DescribePhoneNumbersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2361
2440
|
#
|
2362
2441
|
# * {Types::DescribePhoneNumbersResult#phone_numbers #phone_numbers} => Array<Types::PhoneNumberInformation>
|
@@ -2376,6 +2455,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2376
2455
|
# ],
|
2377
2456
|
# next_token: "NextToken",
|
2378
2457
|
# max_results: 1,
|
2458
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2379
2459
|
# })
|
2380
2460
|
#
|
2381
2461
|
# @example Response structure
|
@@ -2430,6 +2510,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2430
2510
|
# The unique identifier of pools to find. This is an array of strings
|
2431
2511
|
# that can be either the PoolId or PoolArn.
|
2432
2512
|
#
|
2513
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2514
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2515
|
+
#
|
2433
2516
|
# @option params [Array<Types::PoolFilter>] :filters
|
2434
2517
|
# An array of PoolFilter objects to filter the results.
|
2435
2518
|
#
|
@@ -2440,6 +2523,11 @@ module Aws::PinpointSMSVoiceV2
|
|
2440
2523
|
# @option params [Integer] :max_results
|
2441
2524
|
# The maximum number of results to return per each request.
|
2442
2525
|
#
|
2526
|
+
# @option params [String] :owner
|
2527
|
+
# Use `SELF` to filter the list of Pools to ones your account owns or
|
2528
|
+
# use `SHARED` to filter on Pools shared with your account. The `Owner`
|
2529
|
+
# and `PoolIds` parameters can't be used at the same time.
|
2530
|
+
#
|
2443
2531
|
# @return [Types::DescribePoolsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2444
2532
|
#
|
2445
2533
|
# * {Types::DescribePoolsResult#pools #pools} => Array<Types::PoolInformation>
|
@@ -2459,6 +2547,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2459
2547
|
# ],
|
2460
2548
|
# next_token: "NextToken",
|
2461
2549
|
# max_results: 1,
|
2550
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2462
2551
|
# })
|
2463
2552
|
#
|
2464
2553
|
# @example Response structure
|
@@ -3010,6 +3099,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3010
3099
|
# @option params [Array<Types::SenderIdAndCountry>] :sender_ids
|
3011
3100
|
# An array of SenderIdAndCountry objects to search for.
|
3012
3101
|
#
|
3102
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3103
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3104
|
+
#
|
3013
3105
|
# @option params [Array<Types::SenderIdFilter>] :filters
|
3014
3106
|
# An array of SenderIdFilter objects to filter the results.
|
3015
3107
|
#
|
@@ -3020,6 +3112,11 @@ module Aws::PinpointSMSVoiceV2
|
|
3020
3112
|
# @option params [Integer] :max_results
|
3021
3113
|
# The maximum number of results to return per each request.
|
3022
3114
|
#
|
3115
|
+
# @option params [String] :owner
|
3116
|
+
# Use `SELF` to filter the list of Sender Ids to ones your account owns
|
3117
|
+
# or use `SHARED` to filter on Sender Ids shared with your account. The
|
3118
|
+
# `Owner` and `SenderIds` parameters can't be used at the same time.
|
3119
|
+
#
|
3023
3120
|
# @return [Types::DescribeSenderIdsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3024
3121
|
#
|
3025
3122
|
# * {Types::DescribeSenderIdsResult#sender_ids #sender_ids} => Array<Types::SenderIdInformation>
|
@@ -3044,6 +3141,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3044
3141
|
# ],
|
3045
3142
|
# next_token: "NextToken",
|
3046
3143
|
# max_results: 1,
|
3144
|
+
# owner: "SELF", # accepts SELF, SHARED
|
3047
3145
|
# })
|
3048
3146
|
#
|
3049
3147
|
# @example Response structure
|
@@ -3190,6 +3288,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3190
3288
|
# The unique identifier for the pool to disassociate with the
|
3191
3289
|
# origination identity. This value can be either the PoolId or PoolArn.
|
3192
3290
|
#
|
3291
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3292
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3293
|
+
#
|
3193
3294
|
# @option params [required, String] :origination_identity
|
3194
3295
|
# The origination identity to use such as a PhoneNumberId,
|
3195
3296
|
# PhoneNumberArn, SenderId or SenderIdArn. You can use
|
@@ -3197,6 +3298,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3197
3298
|
# PhoneNumberArn, or use DescribeSenderIds to get the values for
|
3198
3299
|
# SenderId and SenderIdArn.
|
3199
3300
|
#
|
3301
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3302
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3303
|
+
#
|
3200
3304
|
# @option params [required, String] :iso_country_code
|
3201
3305
|
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
3202
3306
|
# or region.
|
@@ -3366,6 +3470,41 @@ module Aws::PinpointSMSVoiceV2
|
|
3366
3470
|
req.send_request(options)
|
3367
3471
|
end
|
3368
3472
|
|
3473
|
+
# Retrieves the JSON text of the resource-based policy document attached
|
3474
|
+
# to the AWS End User Messaging SMS and Voice resource. A shared
|
3475
|
+
# resource can be a Pool, Opt-out list, Sender Id, or Phone number.
|
3476
|
+
#
|
3477
|
+
# @option params [required, String] :resource_arn
|
3478
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
3479
|
+
# Voice resource attached to the resource-based policy.
|
3480
|
+
#
|
3481
|
+
# @return [Types::GetResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3482
|
+
#
|
3483
|
+
# * {Types::GetResourcePolicyResult#resource_arn #resource_arn} => String
|
3484
|
+
# * {Types::GetResourcePolicyResult#policy #policy} => String
|
3485
|
+
# * {Types::GetResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
3486
|
+
#
|
3487
|
+
# @example Request syntax with placeholder values
|
3488
|
+
#
|
3489
|
+
# resp = client.get_resource_policy({
|
3490
|
+
# resource_arn: "AmazonResourceName", # required
|
3491
|
+
# })
|
3492
|
+
#
|
3493
|
+
# @example Response structure
|
3494
|
+
#
|
3495
|
+
# resp.resource_arn #=> String
|
3496
|
+
# resp.policy #=> String
|
3497
|
+
# resp.created_timestamp #=> Time
|
3498
|
+
#
|
3499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetResourcePolicy AWS API Documentation
|
3500
|
+
#
|
3501
|
+
# @overload get_resource_policy(params = {})
|
3502
|
+
# @param [Hash] params ({})
|
3503
|
+
def get_resource_policy(params = {}, options = {})
|
3504
|
+
req = build_request(:get_resource_policy, params)
|
3505
|
+
req.send_request(options)
|
3506
|
+
end
|
3507
|
+
|
3369
3508
|
# Lists all associated origination identities in your pool.
|
3370
3509
|
#
|
3371
3510
|
# If you specify filters, the output includes information for only those
|
@@ -3375,6 +3514,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3375
3514
|
# The unique identifier for the pool. This value can be either the
|
3376
3515
|
# PoolId or PoolArn.
|
3377
3516
|
#
|
3517
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3518
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3519
|
+
#
|
3378
3520
|
# @option params [Array<Types::PoolOriginationIdentitiesFilter>] :filters
|
3379
3521
|
# An array of PoolOriginationIdentitiesFilter objects to filter the
|
3380
3522
|
# results..
|
@@ -3545,6 +3687,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3545
3687
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
3546
3688
|
# for SenderId and SenderIdArn.
|
3547
3689
|
#
|
3690
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3691
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3692
|
+
#
|
3548
3693
|
# @option params [required, String] :keyword
|
3549
3694
|
# The new keyword to add.
|
3550
3695
|
#
|
@@ -3602,6 +3747,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3602
3747
|
# @option params [required, String] :opt_out_list_name
|
3603
3748
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
3604
3749
|
#
|
3750
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3751
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3752
|
+
#
|
3605
3753
|
# @option params [required, String] :opted_out_number
|
3606
3754
|
# The phone number to add to the OptOutList in E.164 format.
|
3607
3755
|
#
|
@@ -3695,6 +3843,52 @@ module Aws::PinpointSMSVoiceV2
|
|
3695
3843
|
req.send_request(options)
|
3696
3844
|
end
|
3697
3845
|
|
3846
|
+
# Attaches a resource-based policy to a AWS End User Messaging SMS and
|
3847
|
+
# Voice resource(phone number, sender Id, phone poll, or opt-out list)
|
3848
|
+
# that is used for sharing the resource. A shared resource can be a
|
3849
|
+
# Pool, Opt-out list, Sender Id, or Phone number. For more information
|
3850
|
+
# about resource-based policies, see [Working with shared resources][1]
|
3851
|
+
# in the *AWS End User Messaging SMS User Guide*.
|
3852
|
+
#
|
3853
|
+
#
|
3854
|
+
#
|
3855
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html
|
3856
|
+
#
|
3857
|
+
# @option params [required, String] :resource_arn
|
3858
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
3859
|
+
# Voice resource to attach the resource-based policy to.
|
3860
|
+
#
|
3861
|
+
# @option params [required, String] :policy
|
3862
|
+
# The JSON formatted resource-based policy to attach.
|
3863
|
+
#
|
3864
|
+
# @return [Types::PutResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3865
|
+
#
|
3866
|
+
# * {Types::PutResourcePolicyResult#resource_arn #resource_arn} => String
|
3867
|
+
# * {Types::PutResourcePolicyResult#policy #policy} => String
|
3868
|
+
# * {Types::PutResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
3869
|
+
#
|
3870
|
+
# @example Request syntax with placeholder values
|
3871
|
+
#
|
3872
|
+
# resp = client.put_resource_policy({
|
3873
|
+
# resource_arn: "AmazonResourceName", # required
|
3874
|
+
# policy: "ResourcePolicy", # required
|
3875
|
+
# })
|
3876
|
+
#
|
3877
|
+
# @example Response structure
|
3878
|
+
#
|
3879
|
+
# resp.resource_arn #=> String
|
3880
|
+
# resp.policy #=> String
|
3881
|
+
# resp.created_timestamp #=> Time
|
3882
|
+
#
|
3883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutResourcePolicy AWS API Documentation
|
3884
|
+
#
|
3885
|
+
# @overload put_resource_policy(params = {})
|
3886
|
+
# @param [Hash] params ({})
|
3887
|
+
def put_resource_policy(params = {}, options = {})
|
3888
|
+
req = build_request(:put_resource_policy, params)
|
3889
|
+
req.send_request(options)
|
3890
|
+
end
|
3891
|
+
|
3698
3892
|
# Releases an existing origination phone number in your account. Once
|
3699
3893
|
# released, a phone number is no longer available for sending messages.
|
3700
3894
|
#
|
@@ -3706,6 +3900,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3706
3900
|
# You can use DescribePhoneNumbers to get the values for PhoneNumberId
|
3707
3901
|
# and PhoneNumberArn.
|
3708
3902
|
#
|
3903
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3904
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3905
|
+
#
|
3709
3906
|
# @return [Types::ReleasePhoneNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3710
3907
|
#
|
3711
3908
|
# * {Types::ReleasePhoneNumberResult#phone_number_arn #phone_number_arn} => String
|
@@ -3834,10 +4031,16 @@ module Aws::PinpointSMSVoiceV2
|
|
3834
4031
|
# The name of the OptOutList to associate with the phone number. You can
|
3835
4032
|
# use the OptOutListName or OptOutListArn.
|
3836
4033
|
#
|
4034
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4035
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4036
|
+
#
|
3837
4037
|
# @option params [String] :pool_id
|
3838
4038
|
# The pool to associated with the phone number. You can use the PoolId
|
3839
4039
|
# or PoolArn.
|
3840
4040
|
#
|
4041
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4042
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4043
|
+
#
|
3841
4044
|
# @option params [String] :registration_id
|
3842
4045
|
# Use this field to attach your phone number for an external
|
3843
4046
|
# registration process.
|
@@ -4037,6 +4240,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4037
4240
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4038
4241
|
# PoolId, or PoolArn.
|
4039
4242
|
#
|
4243
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4244
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4245
|
+
#
|
4040
4246
|
# @option params [String] :configuration_set_name
|
4041
4247
|
# The name of the configuration set to use. This can be either the
|
4042
4248
|
# ConfigurationSetName or ConfigurationSetArn.
|
@@ -4100,6 +4306,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4100
4306
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4101
4307
|
# PoolId, or PoolArn.
|
4102
4308
|
#
|
4309
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4310
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4311
|
+
#
|
4103
4312
|
# @option params [String] :message_body
|
4104
4313
|
# The text body of the message.
|
4105
4314
|
#
|
@@ -4197,6 +4406,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4197
4406
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4198
4407
|
# PoolId, or PoolArn.
|
4199
4408
|
#
|
4409
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4410
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4411
|
+
#
|
4200
4412
|
# @option params [String] :message_body
|
4201
4413
|
# The body of the text message.
|
4202
4414
|
#
|
@@ -4321,6 +4533,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4321
4533
|
# The origination identity to use for the voice call. This can be the
|
4322
4534
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
|
4323
4535
|
#
|
4536
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4537
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4538
|
+
#
|
4324
4539
|
# @option params [String] :message_body
|
4325
4540
|
# The text to convert to a voice message.
|
4326
4541
|
#
|
@@ -4834,6 +5049,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4834
5049
|
# The unique identifier of the phone number. Valid values for this field
|
4835
5050
|
# can be either the PhoneNumberId or PhoneNumberArn.
|
4836
5051
|
#
|
5052
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5053
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5054
|
+
#
|
4837
5055
|
# @option params [Boolean] :two_way_enabled
|
4838
5056
|
# By default this is set to false. When set to true you can receive
|
4839
5057
|
# incoming text messages from your end recipients.
|
@@ -4933,6 +5151,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4933
5151
|
# The unique identifier of the pool to update. Valid values are either
|
4934
5152
|
# the PoolId or PoolArn.
|
4935
5153
|
#
|
5154
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5155
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5156
|
+
#
|
4936
5157
|
# @option params [Boolean] :two_way_enabled
|
4937
5158
|
# By default this is set to false. When set to true you can receive
|
4938
5159
|
# incoming text messages from your end recipients.
|
@@ -4957,6 +5178,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4957
5178
|
# The OptOutList to associate with the pool. Valid values are either
|
4958
5179
|
# OptOutListName or OptOutListArn.
|
4959
5180
|
#
|
5181
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5182
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5183
|
+
#
|
4960
5184
|
# @option params [Boolean] :shared_routes_enabled
|
4961
5185
|
# Indicates whether shared routes are enabled for the pool.
|
4962
5186
|
#
|
@@ -5228,7 +5452,7 @@ module Aws::PinpointSMSVoiceV2
|
|
5228
5452
|
tracer: tracer
|
5229
5453
|
)
|
5230
5454
|
context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
|
5231
|
-
context[:gem_version] = '1.
|
5455
|
+
context[:gem_version] = '1.27.0'
|
5232
5456
|
Seahorse::Client::Request.new(handlers, context)
|
5233
5457
|
end
|
5234
5458
|
|