aws-sdk-pinpointsmsvoicev2 1.26.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pinpointsmsvoicev2/client.rb +248 -17
- 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 +254 -7
- data/lib/aws-sdk-pinpointsmsvoicev2.rb +3 -1
- data/sig/client.rbs +50 -9
- data/sig/types.rbs +51 -10
- 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: 23ab1dd59b2dacba525b2b198ad351de27b1ab4abbf9cd93b2a5d4d64a33dab8
|
4
|
+
data.tar.gz: ef8c3d1ff087ba9f34bd63c7261948b0b168646bceff45cc0493b98aab783256
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c54278df4eb120fd93b903e9ba48e87f94892f3c5c5f68e25314bb82524c38a5d44d074e47cf4425260ae01c189e9c1ca82b827d2d96725011754d6f95327bd6
|
7
|
+
data.tar.gz: 3aab2dad344acad850ca4782b532680d8d1f08517bd2807f9de4ec9da1fc4e4d73b11971a79889d96c99391d82a692cfdfbe6bf270ff523929e7c2c7a3433ac5
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.28.0 (2024-10-17)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added the registrations status of REQUIRES_AUTHENTICATION
|
8
|
+
|
9
|
+
1.27.0 (2024-09-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
4
14
|
1.26.0 (2024-09-23)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.28.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
|
@@ -1025,7 +1032,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1025
1032
|
# resp.registration_arn #=> String
|
1026
1033
|
# resp.registration_id #=> String
|
1027
1034
|
# resp.registration_type #=> String
|
1028
|
-
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
1035
|
+
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
1029
1036
|
# resp.current_version_number #=> Integer
|
1030
1037
|
# resp.additional_attributes #=> Hash
|
1031
1038
|
# resp.additional_attributes["String"] #=> String
|
@@ -1092,17 +1099,21 @@ module Aws::PinpointSMSVoiceV2
|
|
1092
1099
|
end
|
1093
1100
|
|
1094
1101
|
# Create a new registration attachment to use for uploading a file or a
|
1095
|
-
# URL to a file. The maximum file size is
|
1096
|
-
# are PDF, JPEG and PNG. For example, many sender ID
|
1097
|
-
# require a signed “letter of authorization” (LOA) to be
|
1102
|
+
# URL to a file. The maximum file size is 500KB and valid file
|
1103
|
+
# extensions are PDF, JPEG and PNG. For example, many sender ID
|
1104
|
+
# registrations require a signed “letter of authorization” (LOA) to be
|
1105
|
+
# submitted.
|
1106
|
+
#
|
1107
|
+
# Use either `AttachmentUrl` or `AttachmentBody` to upload your
|
1108
|
+
# attachment. If both are specified then an exception is returned.
|
1098
1109
|
#
|
1099
1110
|
# @option params [String, StringIO, File] :attachment_body
|
1100
|
-
# The registration file to upload. The maximum file size is
|
1111
|
+
# The registration file to upload. The maximum file size is 500KB and
|
1101
1112
|
# valid file extensions are PDF, JPEG and PNG.
|
1102
1113
|
#
|
1103
1114
|
# @option params [String] :attachment_url
|
1104
|
-
#
|
1105
|
-
# the
|
1115
|
+
# Registration files have to be stored in an Amazon S3 bucket. The URI
|
1116
|
+
# to use when sending is in the format `s3://BucketName/FileName`.
|
1106
1117
|
#
|
1107
1118
|
# @option params [Array<Types::Tag>] :tags
|
1108
1119
|
# An array of tags (key and value pairs) to associate with the
|
@@ -1184,7 +1195,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1184
1195
|
# resp.registration_arn #=> String
|
1185
1196
|
# resp.registration_id #=> String
|
1186
1197
|
# resp.version_number #=> Integer
|
1187
|
-
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
1198
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
1188
1199
|
# resp.registration_version_status_history.draft_timestamp #=> Time
|
1189
1200
|
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
1190
1201
|
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
@@ -1491,6 +1502,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1491
1502
|
# find the values for PhoneNumberId and PhoneNumberArn and DescribePools
|
1492
1503
|
# to find the values of PoolId and PoolArn.
|
1493
1504
|
#
|
1505
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1506
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1507
|
+
#
|
1494
1508
|
# @option params [required, String] :keyword
|
1495
1509
|
# The keyword to delete.
|
1496
1510
|
#
|
@@ -1565,6 +1579,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1565
1579
|
# can use DescribeOptOutLists to find the values for OptOutListName and
|
1566
1580
|
# OptOutListArn.
|
1567
1581
|
#
|
1582
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1583
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1584
|
+
#
|
1568
1585
|
# @return [Types::DeleteOptOutListResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1569
1586
|
#
|
1570
1587
|
# * {Types::DeleteOptOutListResult#opt_out_list_arn #opt_out_list_arn} => String
|
@@ -1603,6 +1620,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1603
1620
|
# @option params [required, String] :opt_out_list_name
|
1604
1621
|
# The OptOutListName or OptOutListArn to remove the phone number from.
|
1605
1622
|
#
|
1623
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1624
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1625
|
+
#
|
1606
1626
|
# @option params [required, String] :opted_out_number
|
1607
1627
|
# The phone number, in E.164 format, to remove from the OptOutList.
|
1608
1628
|
#
|
@@ -1652,6 +1672,9 @@ module Aws::PinpointSMSVoiceV2
|
|
1652
1672
|
# The PoolId or PoolArn of the pool to delete. You can use DescribePools
|
1653
1673
|
# to find the values for PoolId and PoolArn .
|
1654
1674
|
#
|
1675
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
1676
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
1677
|
+
#
|
1655
1678
|
# @return [Types::DeletePoolResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1656
1679
|
#
|
1657
1680
|
# * {Types::DeletePoolResult#pool_arn #pool_arn} => String
|
@@ -1762,7 +1785,7 @@ module Aws::PinpointSMSVoiceV2
|
|
1762
1785
|
# resp.registration_arn #=> String
|
1763
1786
|
# resp.registration_id #=> String
|
1764
1787
|
# resp.registration_type #=> String
|
1765
|
-
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
1788
|
+
# resp.registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
1766
1789
|
# resp.current_version_number #=> Integer
|
1767
1790
|
# resp.approved_version_number #=> Integer
|
1768
1791
|
# resp.latest_denied_version_number #=> Integer
|
@@ -1861,6 +1884,41 @@ module Aws::PinpointSMSVoiceV2
|
|
1861
1884
|
req.send_request(options)
|
1862
1885
|
end
|
1863
1886
|
|
1887
|
+
# Deletes the resource-based policy document attached to the AWS End
|
1888
|
+
# User Messaging SMS and Voice resource. A shared resource can be a
|
1889
|
+
# Pool, Opt-out list, Sender Id, or Phone number.
|
1890
|
+
#
|
1891
|
+
# @option params [required, String] :resource_arn
|
1892
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
1893
|
+
# Voice resource you're deleting the resource-based policy from.
|
1894
|
+
#
|
1895
|
+
# @return [Types::DeleteResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1896
|
+
#
|
1897
|
+
# * {Types::DeleteResourcePolicyResult#resource_arn #resource_arn} => String
|
1898
|
+
# * {Types::DeleteResourcePolicyResult#policy #policy} => String
|
1899
|
+
# * {Types::DeleteResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
1900
|
+
#
|
1901
|
+
# @example Request syntax with placeholder values
|
1902
|
+
#
|
1903
|
+
# resp = client.delete_resource_policy({
|
1904
|
+
# resource_arn: "AmazonResourceName", # required
|
1905
|
+
# })
|
1906
|
+
#
|
1907
|
+
# @example Response structure
|
1908
|
+
#
|
1909
|
+
# resp.resource_arn #=> String
|
1910
|
+
# resp.policy #=> String
|
1911
|
+
# resp.created_timestamp #=> Time
|
1912
|
+
#
|
1913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteResourcePolicy AWS API Documentation
|
1914
|
+
#
|
1915
|
+
# @overload delete_resource_policy(params = {})
|
1916
|
+
# @param [Hash] params ({})
|
1917
|
+
def delete_resource_policy(params = {}, options = {})
|
1918
|
+
req = build_request(:delete_resource_policy, params)
|
1919
|
+
req.send_request(options)
|
1920
|
+
end
|
1921
|
+
|
1864
1922
|
# Deletes an account-level monthly spending limit override for sending
|
1865
1923
|
# text messages. Deleting a spend limit override will set the
|
1866
1924
|
# `EnforcedLimit` to equal the `MaxLimit`, which is controlled by Amazon
|
@@ -2145,6 +2203,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2145
2203
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
2146
2204
|
# for SenderId and SenderIdArn.
|
2147
2205
|
#
|
2206
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2207
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2208
|
+
#
|
2148
2209
|
# @option params [Array<String>] :keywords
|
2149
2210
|
# An array of keywords to search for.
|
2150
2211
|
#
|
@@ -2217,6 +2278,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2217
2278
|
# The OptOutLists to show the details of. This is an array of strings
|
2218
2279
|
# that can be either the OptOutListName or OptOutListArn.
|
2219
2280
|
#
|
2281
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2282
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2283
|
+
#
|
2220
2284
|
# @option params [String] :next_token
|
2221
2285
|
# The token to be used for the next set of paginated results. You don't
|
2222
2286
|
# need to supply a value for this field in the initial request.
|
@@ -2224,6 +2288,12 @@ module Aws::PinpointSMSVoiceV2
|
|
2224
2288
|
# @option params [Integer] :max_results
|
2225
2289
|
# The maximum number of results to return per each request.
|
2226
2290
|
#
|
2291
|
+
# @option params [String] :owner
|
2292
|
+
# Use `SELF` to filter the list of Opt-Out List to ones your account
|
2293
|
+
# owns or use `SHARED` to filter on Opt-Out List shared with your
|
2294
|
+
# account. The `Owner` and `OptOutListNames` parameters can't be used
|
2295
|
+
# at the same time.
|
2296
|
+
#
|
2227
2297
|
# @return [Types::DescribeOptOutListsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2228
2298
|
#
|
2229
2299
|
# * {Types::DescribeOptOutListsResult#opt_out_lists #opt_out_lists} => Array<Types::OptOutListInformation>
|
@@ -2237,6 +2307,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2237
2307
|
# opt_out_list_names: ["OptOutListNameOrArn"],
|
2238
2308
|
# next_token: "NextToken",
|
2239
2309
|
# max_results: 1,
|
2310
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2240
2311
|
# })
|
2241
2312
|
#
|
2242
2313
|
# @example Response structure
|
@@ -2266,7 +2337,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2266
2337
|
# filters, the output includes information for all opted out destination
|
2267
2338
|
# numbers in your opt-out list.
|
2268
2339
|
#
|
2269
|
-
# If you specify an opted out number that isn't valid, an
|
2340
|
+
# If you specify an opted out number that isn't valid, an exception is
|
2270
2341
|
# returned.
|
2271
2342
|
#
|
2272
2343
|
# @option params [required, String] :opt_out_list_name
|
@@ -2274,9 +2345,15 @@ module Aws::PinpointSMSVoiceV2
|
|
2274
2345
|
# DescribeOptOutLists to find the values for OptOutListName and
|
2275
2346
|
# OptOutListArn.
|
2276
2347
|
#
|
2348
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2349
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2350
|
+
#
|
2277
2351
|
# @option params [Array<String>] :opted_out_numbers
|
2278
2352
|
# An array of phone numbers to search for in the OptOutList.
|
2279
2353
|
#
|
2354
|
+
# If you specify an opted out number that isn't valid, an exception is
|
2355
|
+
# returned.
|
2356
|
+
#
|
2280
2357
|
# @option params [Array<Types::OptedOutFilter>] :filters
|
2281
2358
|
# An array of OptedOutFilter objects to filter the results on.
|
2282
2359
|
#
|
@@ -2347,6 +2424,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2347
2424
|
# is an array of strings that can be either the PhoneNumberId or
|
2348
2425
|
# PhoneNumberArn.
|
2349
2426
|
#
|
2427
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2428
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2429
|
+
#
|
2350
2430
|
# @option params [Array<Types::PhoneNumberFilter>] :filters
|
2351
2431
|
# An array of PhoneNumberFilter objects to filter the results.
|
2352
2432
|
#
|
@@ -2357,6 +2437,12 @@ module Aws::PinpointSMSVoiceV2
|
|
2357
2437
|
# @option params [Integer] :max_results
|
2358
2438
|
# The maximum number of results to return per each request.
|
2359
2439
|
#
|
2440
|
+
# @option params [String] :owner
|
2441
|
+
# Use `SELF` to filter the list of phone numbers to ones your account
|
2442
|
+
# owns or use `SHARED` to filter on phone numbers shared with your
|
2443
|
+
# account. The `Owner` and `PhoneNumberIds` parameters can't be used at
|
2444
|
+
# the same time.
|
2445
|
+
#
|
2360
2446
|
# @return [Types::DescribePhoneNumbersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2361
2447
|
#
|
2362
2448
|
# * {Types::DescribePhoneNumbersResult#phone_numbers #phone_numbers} => Array<Types::PhoneNumberInformation>
|
@@ -2376,6 +2462,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2376
2462
|
# ],
|
2377
2463
|
# next_token: "NextToken",
|
2378
2464
|
# max_results: 1,
|
2465
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2379
2466
|
# })
|
2380
2467
|
#
|
2381
2468
|
# @example Response structure
|
@@ -2430,6 +2517,9 @@ module Aws::PinpointSMSVoiceV2
|
|
2430
2517
|
# The unique identifier of pools to find. This is an array of strings
|
2431
2518
|
# that can be either the PoolId or PoolArn.
|
2432
2519
|
#
|
2520
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
2521
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
2522
|
+
#
|
2433
2523
|
# @option params [Array<Types::PoolFilter>] :filters
|
2434
2524
|
# An array of PoolFilter objects to filter the results.
|
2435
2525
|
#
|
@@ -2440,6 +2530,11 @@ module Aws::PinpointSMSVoiceV2
|
|
2440
2530
|
# @option params [Integer] :max_results
|
2441
2531
|
# The maximum number of results to return per each request.
|
2442
2532
|
#
|
2533
|
+
# @option params [String] :owner
|
2534
|
+
# Use `SELF` to filter the list of Pools to ones your account owns or
|
2535
|
+
# use `SHARED` to filter on Pools shared with your account. The `Owner`
|
2536
|
+
# and `PoolIds` parameters can't be used at the same time.
|
2537
|
+
#
|
2443
2538
|
# @return [Types::DescribePoolsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2444
2539
|
#
|
2445
2540
|
# * {Types::DescribePoolsResult#pools #pools} => Array<Types::PoolInformation>
|
@@ -2459,6 +2554,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2459
2554
|
# ],
|
2460
2555
|
# next_token: "NextToken",
|
2461
2556
|
# max_results: 1,
|
2557
|
+
# owner: "SELF", # accepts SELF, SHARED
|
2462
2558
|
# })
|
2463
2559
|
#
|
2464
2560
|
# @example Response structure
|
@@ -2910,7 +3006,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2910
3006
|
# resp.registration_id #=> String
|
2911
3007
|
# resp.registration_versions #=> Array
|
2912
3008
|
# resp.registration_versions[0].version_number #=> Integer
|
2913
|
-
# resp.registration_versions[0].registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
3009
|
+
# resp.registration_versions[0].registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
2914
3010
|
# resp.registration_versions[0].registration_version_status_history.draft_timestamp #=> Time
|
2915
3011
|
# resp.registration_versions[0].registration_version_status_history.submitted_timestamp #=> Time
|
2916
3012
|
# resp.registration_versions[0].registration_version_status_history.reviewing_timestamp #=> Time
|
@@ -2978,7 +3074,7 @@ module Aws::PinpointSMSVoiceV2
|
|
2978
3074
|
# resp.registrations[0].registration_arn #=> String
|
2979
3075
|
# resp.registrations[0].registration_id #=> String
|
2980
3076
|
# resp.registrations[0].registration_type #=> String
|
2981
|
-
# resp.registrations[0].registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
3077
|
+
# resp.registrations[0].registration_status #=> String, one of "CREATED", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "PROVISIONING", "COMPLETE", "REQUIRES_UPDATES", "CLOSED", "DELETED"
|
2982
3078
|
# resp.registrations[0].current_version_number #=> Integer
|
2983
3079
|
# resp.registrations[0].approved_version_number #=> Integer
|
2984
3080
|
# resp.registrations[0].latest_denied_version_number #=> Integer
|
@@ -3010,6 +3106,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3010
3106
|
# @option params [Array<Types::SenderIdAndCountry>] :sender_ids
|
3011
3107
|
# An array of SenderIdAndCountry objects to search for.
|
3012
3108
|
#
|
3109
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3110
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3111
|
+
#
|
3013
3112
|
# @option params [Array<Types::SenderIdFilter>] :filters
|
3014
3113
|
# An array of SenderIdFilter objects to filter the results.
|
3015
3114
|
#
|
@@ -3020,6 +3119,11 @@ module Aws::PinpointSMSVoiceV2
|
|
3020
3119
|
# @option params [Integer] :max_results
|
3021
3120
|
# The maximum number of results to return per each request.
|
3022
3121
|
#
|
3122
|
+
# @option params [String] :owner
|
3123
|
+
# Use `SELF` to filter the list of Sender Ids to ones your account owns
|
3124
|
+
# or use `SHARED` to filter on Sender Ids shared with your account. The
|
3125
|
+
# `Owner` and `SenderIds` parameters can't be used at the same time.
|
3126
|
+
#
|
3023
3127
|
# @return [Types::DescribeSenderIdsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3024
3128
|
#
|
3025
3129
|
# * {Types::DescribeSenderIdsResult#sender_ids #sender_ids} => Array<Types::SenderIdInformation>
|
@@ -3044,6 +3148,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3044
3148
|
# ],
|
3045
3149
|
# next_token: "NextToken",
|
3046
3150
|
# max_results: 1,
|
3151
|
+
# owner: "SELF", # accepts SELF, SHARED
|
3047
3152
|
# })
|
3048
3153
|
#
|
3049
3154
|
# @example Response structure
|
@@ -3190,6 +3295,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3190
3295
|
# The unique identifier for the pool to disassociate with the
|
3191
3296
|
# origination identity. This value can be either the PoolId or PoolArn.
|
3192
3297
|
#
|
3298
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3299
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3300
|
+
#
|
3193
3301
|
# @option params [required, String] :origination_identity
|
3194
3302
|
# The origination identity to use such as a PhoneNumberId,
|
3195
3303
|
# PhoneNumberArn, SenderId or SenderIdArn. You can use
|
@@ -3197,6 +3305,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3197
3305
|
# PhoneNumberArn, or use DescribeSenderIds to get the values for
|
3198
3306
|
# SenderId and SenderIdArn.
|
3199
3307
|
#
|
3308
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3309
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3310
|
+
#
|
3200
3311
|
# @option params [required, String] :iso_country_code
|
3201
3312
|
# The two-character code, in ISO 3166-1 alpha-2 format, for the country
|
3202
3313
|
# or region.
|
@@ -3306,7 +3417,7 @@ module Aws::PinpointSMSVoiceV2
|
|
3306
3417
|
# resp.registration_arn #=> String
|
3307
3418
|
# resp.registration_id #=> String
|
3308
3419
|
# resp.version_number #=> Integer
|
3309
|
-
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
3420
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
3310
3421
|
# resp.registration_version_status_history.draft_timestamp #=> Time
|
3311
3422
|
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
3312
3423
|
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
@@ -3366,6 +3477,41 @@ module Aws::PinpointSMSVoiceV2
|
|
3366
3477
|
req.send_request(options)
|
3367
3478
|
end
|
3368
3479
|
|
3480
|
+
# Retrieves the JSON text of the resource-based policy document attached
|
3481
|
+
# to the AWS End User Messaging SMS and Voice resource. A shared
|
3482
|
+
# resource can be a Pool, Opt-out list, Sender Id, or Phone number.
|
3483
|
+
#
|
3484
|
+
# @option params [required, String] :resource_arn
|
3485
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
3486
|
+
# Voice resource attached to the resource-based policy.
|
3487
|
+
#
|
3488
|
+
# @return [Types::GetResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3489
|
+
#
|
3490
|
+
# * {Types::GetResourcePolicyResult#resource_arn #resource_arn} => String
|
3491
|
+
# * {Types::GetResourcePolicyResult#policy #policy} => String
|
3492
|
+
# * {Types::GetResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
3493
|
+
#
|
3494
|
+
# @example Request syntax with placeholder values
|
3495
|
+
#
|
3496
|
+
# resp = client.get_resource_policy({
|
3497
|
+
# resource_arn: "AmazonResourceName", # required
|
3498
|
+
# })
|
3499
|
+
#
|
3500
|
+
# @example Response structure
|
3501
|
+
#
|
3502
|
+
# resp.resource_arn #=> String
|
3503
|
+
# resp.policy #=> String
|
3504
|
+
# resp.created_timestamp #=> Time
|
3505
|
+
#
|
3506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/GetResourcePolicy AWS API Documentation
|
3507
|
+
#
|
3508
|
+
# @overload get_resource_policy(params = {})
|
3509
|
+
# @param [Hash] params ({})
|
3510
|
+
def get_resource_policy(params = {}, options = {})
|
3511
|
+
req = build_request(:get_resource_policy, params)
|
3512
|
+
req.send_request(options)
|
3513
|
+
end
|
3514
|
+
|
3369
3515
|
# Lists all associated origination identities in your pool.
|
3370
3516
|
#
|
3371
3517
|
# If you specify filters, the output includes information for only those
|
@@ -3375,6 +3521,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3375
3521
|
# The unique identifier for the pool. This value can be either the
|
3376
3522
|
# PoolId or PoolArn.
|
3377
3523
|
#
|
3524
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3525
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3526
|
+
#
|
3378
3527
|
# @option params [Array<Types::PoolOriginationIdentitiesFilter>] :filters
|
3379
3528
|
# An array of PoolOriginationIdentitiesFilter objects to filter the
|
3380
3529
|
# results..
|
@@ -3545,6 +3694,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3545
3694
|
# PhoneNumberArn while DescribeSenderIds can be used to get the values
|
3546
3695
|
# for SenderId and SenderIdArn.
|
3547
3696
|
#
|
3697
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3698
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3699
|
+
#
|
3548
3700
|
# @option params [required, String] :keyword
|
3549
3701
|
# The new keyword to add.
|
3550
3702
|
#
|
@@ -3602,6 +3754,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3602
3754
|
# @option params [required, String] :opt_out_list_name
|
3603
3755
|
# The OptOutListName or OptOutListArn to add the phone number to.
|
3604
3756
|
#
|
3757
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3758
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3759
|
+
#
|
3605
3760
|
# @option params [required, String] :opted_out_number
|
3606
3761
|
# The phone number to add to the OptOutList in E.164 format.
|
3607
3762
|
#
|
@@ -3695,6 +3850,52 @@ module Aws::PinpointSMSVoiceV2
|
|
3695
3850
|
req.send_request(options)
|
3696
3851
|
end
|
3697
3852
|
|
3853
|
+
# Attaches a resource-based policy to a AWS End User Messaging SMS and
|
3854
|
+
# Voice resource(phone number, sender Id, phone poll, or opt-out list)
|
3855
|
+
# that is used for sharing the resource. A shared resource can be a
|
3856
|
+
# Pool, Opt-out list, Sender Id, or Phone number. For more information
|
3857
|
+
# about resource-based policies, see [Working with shared resources][1]
|
3858
|
+
# in the *AWS End User Messaging SMS User Guide*.
|
3859
|
+
#
|
3860
|
+
#
|
3861
|
+
#
|
3862
|
+
# [1]: https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html
|
3863
|
+
#
|
3864
|
+
# @option params [required, String] :resource_arn
|
3865
|
+
# The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and
|
3866
|
+
# Voice resource to attach the resource-based policy to.
|
3867
|
+
#
|
3868
|
+
# @option params [required, String] :policy
|
3869
|
+
# The JSON formatted resource-based policy to attach.
|
3870
|
+
#
|
3871
|
+
# @return [Types::PutResourcePolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3872
|
+
#
|
3873
|
+
# * {Types::PutResourcePolicyResult#resource_arn #resource_arn} => String
|
3874
|
+
# * {Types::PutResourcePolicyResult#policy #policy} => String
|
3875
|
+
# * {Types::PutResourcePolicyResult#created_timestamp #created_timestamp} => Time
|
3876
|
+
#
|
3877
|
+
# @example Request syntax with placeholder values
|
3878
|
+
#
|
3879
|
+
# resp = client.put_resource_policy({
|
3880
|
+
# resource_arn: "AmazonResourceName", # required
|
3881
|
+
# policy: "ResourcePolicy", # required
|
3882
|
+
# })
|
3883
|
+
#
|
3884
|
+
# @example Response structure
|
3885
|
+
#
|
3886
|
+
# resp.resource_arn #=> String
|
3887
|
+
# resp.policy #=> String
|
3888
|
+
# resp.created_timestamp #=> Time
|
3889
|
+
#
|
3890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/PutResourcePolicy AWS API Documentation
|
3891
|
+
#
|
3892
|
+
# @overload put_resource_policy(params = {})
|
3893
|
+
# @param [Hash] params ({})
|
3894
|
+
def put_resource_policy(params = {}, options = {})
|
3895
|
+
req = build_request(:put_resource_policy, params)
|
3896
|
+
req.send_request(options)
|
3897
|
+
end
|
3898
|
+
|
3698
3899
|
# Releases an existing origination phone number in your account. Once
|
3699
3900
|
# released, a phone number is no longer available for sending messages.
|
3700
3901
|
#
|
@@ -3706,6 +3907,9 @@ module Aws::PinpointSMSVoiceV2
|
|
3706
3907
|
# You can use DescribePhoneNumbers to get the values for PhoneNumberId
|
3707
3908
|
# and PhoneNumberArn.
|
3708
3909
|
#
|
3910
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
3911
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
3912
|
+
#
|
3709
3913
|
# @return [Types::ReleasePhoneNumberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3710
3914
|
#
|
3711
3915
|
# * {Types::ReleasePhoneNumberResult#phone_number_arn #phone_number_arn} => String
|
@@ -3834,10 +4038,16 @@ module Aws::PinpointSMSVoiceV2
|
|
3834
4038
|
# The name of the OptOutList to associate with the phone number. You can
|
3835
4039
|
# use the OptOutListName or OptOutListArn.
|
3836
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
|
+
#
|
3837
4044
|
# @option params [String] :pool_id
|
3838
4045
|
# The pool to associated with the phone number. You can use the PoolId
|
3839
4046
|
# or PoolArn.
|
3840
4047
|
#
|
4048
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4049
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4050
|
+
#
|
3841
4051
|
# @option params [String] :registration_id
|
3842
4052
|
# Use this field to attach your phone number for an external
|
3843
4053
|
# registration process.
|
@@ -4037,6 +4247,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4037
4247
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4038
4248
|
# PoolId, or PoolArn.
|
4039
4249
|
#
|
4250
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4251
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4252
|
+
#
|
4040
4253
|
# @option params [String] :configuration_set_name
|
4041
4254
|
# The name of the configuration set to use. This can be either the
|
4042
4255
|
# ConfigurationSetName or ConfigurationSetArn.
|
@@ -4100,6 +4313,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4100
4313
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4101
4314
|
# PoolId, or PoolArn.
|
4102
4315
|
#
|
4316
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4317
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4318
|
+
#
|
4103
4319
|
# @option params [String] :message_body
|
4104
4320
|
# The text body of the message.
|
4105
4321
|
#
|
@@ -4197,6 +4413,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4197
4413
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn,
|
4198
4414
|
# PoolId, or PoolArn.
|
4199
4415
|
#
|
4416
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4417
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4418
|
+
#
|
4200
4419
|
# @option params [String] :message_body
|
4201
4420
|
# The body of the text message.
|
4202
4421
|
#
|
@@ -4321,6 +4540,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4321
4540
|
# The origination identity to use for the voice call. This can be the
|
4322
4541
|
# PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
|
4323
4542
|
#
|
4543
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
4544
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
4545
|
+
#
|
4324
4546
|
# @option params [String] :message_body
|
4325
4547
|
# The text to convert to a voice message.
|
4326
4548
|
#
|
@@ -4642,7 +4864,7 @@ module Aws::PinpointSMSVoiceV2
|
|
4642
4864
|
# resp.registration_arn #=> String
|
4643
4865
|
# resp.registration_id #=> String
|
4644
4866
|
# resp.version_number #=> Integer
|
4645
|
-
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
4867
|
+
# resp.registration_version_status #=> String, one of "DRAFT", "SUBMITTED", "REVIEWING", "REQUIRES_AUTHENTICATION", "APPROVED", "DISCARDED", "DENIED", "REVOKED", "ARCHIVED"
|
4646
4868
|
# resp.registration_version_status_history.draft_timestamp #=> Time
|
4647
4869
|
# resp.registration_version_status_history.submitted_timestamp #=> Time
|
4648
4870
|
# resp.registration_version_status_history.reviewing_timestamp #=> Time
|
@@ -4834,6 +5056,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4834
5056
|
# The unique identifier of the phone number. Valid values for this field
|
4835
5057
|
# can be either the PhoneNumberId or PhoneNumberArn.
|
4836
5058
|
#
|
5059
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5060
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5061
|
+
#
|
4837
5062
|
# @option params [Boolean] :two_way_enabled
|
4838
5063
|
# By default this is set to false. When set to true you can receive
|
4839
5064
|
# incoming text messages from your end recipients.
|
@@ -4933,6 +5158,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4933
5158
|
# The unique identifier of the pool to update. Valid values are either
|
4934
5159
|
# the PoolId or PoolArn.
|
4935
5160
|
#
|
5161
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5162
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5163
|
+
#
|
4936
5164
|
# @option params [Boolean] :two_way_enabled
|
4937
5165
|
# By default this is set to false. When set to true you can receive
|
4938
5166
|
# incoming text messages from your end recipients.
|
@@ -4957,6 +5185,9 @@ module Aws::PinpointSMSVoiceV2
|
|
4957
5185
|
# The OptOutList to associate with the pool. Valid values are either
|
4958
5186
|
# OptOutListName or OptOutListArn.
|
4959
5187
|
#
|
5188
|
+
# If you are using a shared AWS End User Messaging SMS and Voice
|
5189
|
+
# resource then you must use the full Amazon Resource Name(ARN).
|
5190
|
+
#
|
4960
5191
|
# @option params [Boolean] :shared_routes_enabled
|
4961
5192
|
# Indicates whether shared routes are enabled for the pool.
|
4962
5193
|
#
|
@@ -5228,7 +5459,7 @@ module Aws::PinpointSMSVoiceV2
|
|
5228
5459
|
tracer: tracer
|
5229
5460
|
)
|
5230
5461
|
context[:gem_name] = 'aws-sdk-pinpointsmsvoicev2'
|
5231
|
-
context[:gem_version] = '1.
|
5462
|
+
context[:gem_version] = '1.28.0'
|
5232
5463
|
Seahorse::Client::Request.new(handlers, context)
|
5233
5464
|
end
|
5234
5465
|
|