aws-sdk-sns 1.38.0 → 1.46.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 +315 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-sns/client.rb +302 -47
- data/lib/aws-sdk-sns/client_api.rb +197 -1
- data/lib/aws-sdk-sns/errors.rb +70 -1
- data/lib/aws-sdk-sns/message_verifier.rb +11 -1
- data/lib/aws-sdk-sns/platform_application.rb +1 -1
- data/lib/aws-sdk-sns/platform_endpoint.rb +1 -1
- data/lib/aws-sdk-sns/resource.rb +9 -9
- data/lib/aws-sdk-sns/subscription.rb +4 -4
- data/lib/aws-sdk-sns/topic.rb +25 -26
- data/lib/aws-sdk-sns/types.rb +375 -47
- data/lib/aws-sdk-sns.rb +2 -2
- metadata +12 -10
data/lib/aws-sdk-sns/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -29,9 +29,9 @@ module Aws::SNS
|
|
29
29
|
# @return [String]
|
30
30
|
#
|
31
31
|
# @!attribute [rw] aws_account_id
|
32
|
-
# The
|
33
|
-
#
|
34
|
-
#
|
32
|
+
# The account IDs of the users (principals) who will be given access
|
33
|
+
# to the specified actions. The users must have account, but do not
|
34
|
+
# need to be signed up for this service.
|
35
35
|
# @return [Array<String>]
|
36
36
|
#
|
37
37
|
# @!attribute [rw] action_name
|
@@ -141,10 +141,10 @@ module Aws::SNS
|
|
141
141
|
#
|
142
142
|
# @!attribute [rw] authenticate_on_unsubscribe
|
143
143
|
# Disallows unauthenticated unsubscribes of the subscription. If the
|
144
|
-
# value of this parameter is `true` and the request has an
|
145
|
-
# signature, then only the topic owner and the subscription
|
146
|
-
# unsubscribe the endpoint. The unsubscribe action requires
|
147
|
-
# authentication.
|
144
|
+
# value of this parameter is `true` and the request has an Amazon Web
|
145
|
+
# Services signature, then only the topic owner and the subscription
|
146
|
+
# owner can unsubscribe the endpoint. The unsubscribe action requires
|
147
|
+
# Amazon Web Services authentication.
|
148
148
|
# @return [String]
|
149
149
|
#
|
150
150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscriptionInput AWS API Documentation
|
@@ -211,7 +211,7 @@ module Aws::SNS
|
|
211
211
|
# @return [String]
|
212
212
|
#
|
213
213
|
# @!attribute [rw] attributes
|
214
|
-
# For a list of attributes, see [SetPlatformApplicationAttributes][1]
|
214
|
+
# For a list of attributes, see [SetPlatformApplicationAttributes][1].
|
215
215
|
#
|
216
216
|
#
|
217
217
|
#
|
@@ -295,6 +295,38 @@ module Aws::SNS
|
|
295
295
|
include Aws::Structure
|
296
296
|
end
|
297
297
|
|
298
|
+
# @note When making an API call, you may pass CreateSMSSandboxPhoneNumberInput
|
299
|
+
# data as a hash:
|
300
|
+
#
|
301
|
+
# {
|
302
|
+
# phone_number: "PhoneNumberString", # required
|
303
|
+
# language_code: "en-US", # accepts en-US, en-GB, es-419, es-ES, de-DE, fr-CA, fr-FR, it-IT, ja-JP, pt-BR, kr-KR, zh-CN, zh-TW
|
304
|
+
# }
|
305
|
+
#
|
306
|
+
# @!attribute [rw] phone_number
|
307
|
+
# The destination phone number to verify. On verification, Amazon SNS
|
308
|
+
# adds this phone number to the list of verified phone numbers that
|
309
|
+
# you can send SMS messages to.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] language_code
|
313
|
+
# The language to use for sending the OTP. The default value is
|
314
|
+
# `en-US`.
|
315
|
+
# @return [String]
|
316
|
+
#
|
317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumberInput AWS API Documentation
|
318
|
+
#
|
319
|
+
class CreateSMSSandboxPhoneNumberInput < Struct.new(
|
320
|
+
:phone_number,
|
321
|
+
:language_code)
|
322
|
+
SENSITIVE = []
|
323
|
+
include Aws::Structure
|
324
|
+
end
|
325
|
+
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateSMSSandboxPhoneNumberResult AWS API Documentation
|
327
|
+
#
|
328
|
+
class CreateSMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
|
329
|
+
|
298
330
|
# Input for CreateTopic action.
|
299
331
|
#
|
300
332
|
# @note When making an API call, you may pass CreateTopicInput
|
@@ -342,13 +374,13 @@ module Aws::SNS
|
|
342
374
|
# default, only the topic owner can publish or subscribe to the
|
343
375
|
# topic.
|
344
376
|
#
|
345
|
-
# The following attribute applies only to
|
346
|
-
#
|
377
|
+
# The following attribute applies only to [server-side
|
378
|
+
# encryption][1]\:
|
347
379
|
#
|
348
|
-
# * `KmsMasterKeyId` – The ID of an
|
349
|
-
# (CMK) for Amazon SNS or a custom CMK. For more
|
350
|
-
# [Key Terms][2]. For more examples, see [KeyId][3]
|
351
|
-
# Management Service API Reference*.
|
380
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
381
|
+
# customer master key (CMK) for Amazon SNS or a custom CMK. For more
|
382
|
+
# information, see [Key Terms][2]. For more examples, see [KeyId][3]
|
383
|
+
# in the *Key Management Service API Reference*.
|
352
384
|
#
|
353
385
|
# ^
|
354
386
|
#
|
@@ -370,7 +402,7 @@ module Aws::SNS
|
|
370
402
|
# message).
|
371
403
|
#
|
372
404
|
# (Optional) To override the generated value, you can specify a
|
373
|
-
# value for the
|
405
|
+
# value for the `MessageDeduplicationId` parameter for the
|
374
406
|
# `Publish` action.
|
375
407
|
#
|
376
408
|
#
|
@@ -457,6 +489,29 @@ module Aws::SNS
|
|
457
489
|
include Aws::Structure
|
458
490
|
end
|
459
491
|
|
492
|
+
# @note When making an API call, you may pass DeleteSMSSandboxPhoneNumberInput
|
493
|
+
# data as a hash:
|
494
|
+
#
|
495
|
+
# {
|
496
|
+
# phone_number: "PhoneNumberString", # required
|
497
|
+
# }
|
498
|
+
#
|
499
|
+
# @!attribute [rw] phone_number
|
500
|
+
# The destination phone number to delete.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumberInput AWS API Documentation
|
504
|
+
#
|
505
|
+
class DeleteSMSSandboxPhoneNumberInput < Struct.new(
|
506
|
+
:phone_number)
|
507
|
+
SENSITIVE = []
|
508
|
+
include Aws::Structure
|
509
|
+
end
|
510
|
+
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteSMSSandboxPhoneNumberResult AWS API Documentation
|
512
|
+
#
|
513
|
+
class DeleteSMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
|
514
|
+
|
460
515
|
# @note When making an API call, you may pass DeleteTopicInput
|
461
516
|
# data as a hash:
|
462
517
|
#
|
@@ -509,9 +564,9 @@ module Aws::SNS
|
|
509
564
|
include Aws::Structure
|
510
565
|
end
|
511
566
|
|
512
|
-
# Indicates that the number of filter polices in your
|
513
|
-
#
|
514
|
-
#
|
567
|
+
# Indicates that the number of filter polices in your account exceeds
|
568
|
+
# the limit. To add more filter polices, submit an SNS Limit Increase
|
569
|
+
# case in the Amazon Web Services Support Center.
|
515
570
|
#
|
516
571
|
# @!attribute [rw] message
|
517
572
|
# @return [String]
|
@@ -670,6 +725,24 @@ module Aws::SNS
|
|
670
725
|
include Aws::Structure
|
671
726
|
end
|
672
727
|
|
728
|
+
# @api private
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatusInput AWS API Documentation
|
731
|
+
#
|
732
|
+
class GetSMSSandboxAccountStatusInput < Aws::EmptyStructure; end
|
733
|
+
|
734
|
+
# @!attribute [rw] is_in_sandbox
|
735
|
+
# Indicates whether the calling account is in the SMS sandbox.
|
736
|
+
# @return [Boolean]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSSandboxAccountStatusResult AWS API Documentation
|
739
|
+
#
|
740
|
+
class GetSMSSandboxAccountStatusResult < Struct.new(
|
741
|
+
:is_in_sandbox)
|
742
|
+
SENSITIVE = []
|
743
|
+
include Aws::Structure
|
744
|
+
end
|
745
|
+
|
673
746
|
# Input for GetSubscriptionAttributes.
|
674
747
|
#
|
675
748
|
# @note When making an API call, you may pass GetSubscriptionAttributesInput
|
@@ -711,7 +784,7 @@ module Aws::SNS
|
|
711
784
|
# subscription. For more information, see [Amazon SNS Message
|
712
785
|
# Filtering][1] in the *Amazon SNS Developer Guide*.
|
713
786
|
#
|
714
|
-
# * `Owner` – The
|
787
|
+
# * `Owner` – The account ID of the subscription's owner.
|
715
788
|
#
|
716
789
|
# * `PendingConfirmation` – `true` if the subscription hasn't been
|
717
790
|
# confirmed. To confirm a pending subscription, call the
|
@@ -752,7 +825,7 @@ module Aws::SNS
|
|
752
825
|
#
|
753
826
|
#
|
754
827
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
|
755
|
-
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
828
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
|
756
829
|
# @return [Hash<String,String>]
|
757
830
|
#
|
758
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
|
@@ -796,7 +869,7 @@ module Aws::SNS
|
|
796
869
|
# * `DisplayName` – The human-readable name used in the `From` field
|
797
870
|
# for notifications to `email` and `email-json` endpoints.
|
798
871
|
#
|
799
|
-
# * `Owner` – The
|
872
|
+
# * `Owner` – The account ID of the topic's owner.
|
800
873
|
#
|
801
874
|
# * `Policy` – The JSON serialization of the topic's access control
|
802
875
|
# policy.
|
@@ -818,10 +891,10 @@ module Aws::SNS
|
|
818
891
|
# The following attribute applies only to
|
819
892
|
# [server-side-encryption][1]\:
|
820
893
|
#
|
821
|
-
# * `KmsMasterKeyId` - The ID of an
|
822
|
-
# (CMK) for Amazon SNS or a custom CMK. For more
|
823
|
-
# [Key Terms][2]. For more examples, see [KeyId][3]
|
824
|
-
# Management Service API Reference*.
|
894
|
+
# * `KmsMasterKeyId` - The ID of an Amazon Web Services managed
|
895
|
+
# customer master key (CMK) for Amazon SNS or a custom CMK. For more
|
896
|
+
# information, see [Key Terms][2]. For more examples, see [KeyId][3]
|
897
|
+
# in the *Key Management Service API Reference*.
|
825
898
|
#
|
826
899
|
# ^
|
827
900
|
#
|
@@ -843,7 +916,7 @@ module Aws::SNS
|
|
843
916
|
# message).
|
844
917
|
#
|
845
918
|
# (Optional) To override the generated value, you can specify a
|
846
|
-
# value for the
|
919
|
+
# value for the `MessageDeduplicationId` parameter for the
|
847
920
|
# `Publish` action.
|
848
921
|
#
|
849
922
|
#
|
@@ -949,8 +1022,8 @@ module Aws::SNS
|
|
949
1022
|
|
950
1023
|
# The request was rejected because the state of the specified resource
|
951
1024
|
# isn't valid for this request. For more information, see [How Key
|
952
|
-
# State Affects Use of a Customer Master Key][1] in the *
|
953
|
-
#
|
1025
|
+
# State Affects Use of a Customer Master Key][1] in the *Key Management
|
1026
|
+
# Service Developer Guide*.
|
954
1027
|
#
|
955
1028
|
#
|
956
1029
|
#
|
@@ -981,7 +1054,8 @@ module Aws::SNS
|
|
981
1054
|
include Aws::Structure
|
982
1055
|
end
|
983
1056
|
|
984
|
-
# The
|
1057
|
+
# The Amazon Web Services access key ID needs a subscription for the
|
1058
|
+
# service.
|
985
1059
|
#
|
986
1060
|
# @!attribute [rw] message
|
987
1061
|
# @return [String]
|
@@ -995,7 +1069,7 @@ module Aws::SNS
|
|
995
1069
|
end
|
996
1070
|
|
997
1071
|
# The request was denied due to request throttling. For more information
|
998
|
-
# about throttling, see [Limits][1] in the *
|
1072
|
+
# about throttling, see [Limits][1] in the *Key Management Service
|
999
1073
|
# Developer Guide.*
|
1000
1074
|
#
|
1001
1075
|
#
|
@@ -1064,6 +1138,51 @@ module Aws::SNS
|
|
1064
1138
|
include Aws::Structure
|
1065
1139
|
end
|
1066
1140
|
|
1141
|
+
# @note When making an API call, you may pass ListOriginationNumbersRequest
|
1142
|
+
# data as a hash:
|
1143
|
+
#
|
1144
|
+
# {
|
1145
|
+
# next_token: "nextToken",
|
1146
|
+
# max_results: 1,
|
1147
|
+
# }
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] next_token
|
1150
|
+
# Token that the previous `ListOriginationNumbers` request returns.
|
1151
|
+
# @return [String]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] max_results
|
1154
|
+
# The maximum number of origination numbers to return.
|
1155
|
+
# @return [Integer]
|
1156
|
+
#
|
1157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbersRequest AWS API Documentation
|
1158
|
+
#
|
1159
|
+
class ListOriginationNumbersRequest < Struct.new(
|
1160
|
+
:next_token,
|
1161
|
+
:max_results)
|
1162
|
+
SENSITIVE = []
|
1163
|
+
include Aws::Structure
|
1164
|
+
end
|
1165
|
+
|
1166
|
+
# @!attribute [rw] next_token
|
1167
|
+
# A `NextToken` string is returned when you call the
|
1168
|
+
# `ListOriginationNumbers` operation if additional pages of records
|
1169
|
+
# are available.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @!attribute [rw] phone_numbers
|
1173
|
+
# A list of the calling account's verified and pending origination
|
1174
|
+
# numbers.
|
1175
|
+
# @return [Array<Types::PhoneNumberInformation>]
|
1176
|
+
#
|
1177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListOriginationNumbersResult AWS API Documentation
|
1178
|
+
#
|
1179
|
+
class ListOriginationNumbersResult < Struct.new(
|
1180
|
+
:next_token,
|
1181
|
+
:phone_numbers)
|
1182
|
+
SENSITIVE = []
|
1183
|
+
include Aws::Structure
|
1184
|
+
end
|
1185
|
+
|
1067
1186
|
# The input for the `ListPhoneNumbersOptedOut` action.
|
1068
1187
|
#
|
1069
1188
|
# @note When making an API call, you may pass ListPhoneNumbersOptedOutInput
|
@@ -1155,6 +1274,51 @@ module Aws::SNS
|
|
1155
1274
|
include Aws::Structure
|
1156
1275
|
end
|
1157
1276
|
|
1277
|
+
# @note When making an API call, you may pass ListSMSSandboxPhoneNumbersInput
|
1278
|
+
# data as a hash:
|
1279
|
+
#
|
1280
|
+
# {
|
1281
|
+
# next_token: "nextToken",
|
1282
|
+
# max_results: 1,
|
1283
|
+
# }
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] next_token
|
1286
|
+
# Token that the previous `ListSMSSandboxPhoneNumbersInput` request
|
1287
|
+
# returns.
|
1288
|
+
# @return [String]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] max_results
|
1291
|
+
# The maximum number of phone numbers to return.
|
1292
|
+
# @return [Integer]
|
1293
|
+
#
|
1294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbersInput AWS API Documentation
|
1295
|
+
#
|
1296
|
+
class ListSMSSandboxPhoneNumbersInput < Struct.new(
|
1297
|
+
:next_token,
|
1298
|
+
:max_results)
|
1299
|
+
SENSITIVE = []
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# @!attribute [rw] phone_numbers
|
1304
|
+
# A list of the calling account's pending and verified phone numbers.
|
1305
|
+
# @return [Array<Types::SMSSandboxPhoneNumber>]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] next_token
|
1308
|
+
# A `NextToken` string is returned when you call the
|
1309
|
+
# `ListSMSSandboxPhoneNumbersInput` operation if additional pages of
|
1310
|
+
# records are available.
|
1311
|
+
# @return [String]
|
1312
|
+
#
|
1313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSMSSandboxPhoneNumbersResult AWS API Documentation
|
1314
|
+
#
|
1315
|
+
class ListSMSSandboxPhoneNumbersResult < Struct.new(
|
1316
|
+
:phone_numbers,
|
1317
|
+
:next_token)
|
1318
|
+
SENSITIVE = []
|
1319
|
+
include Aws::Structure
|
1320
|
+
end
|
1321
|
+
|
1158
1322
|
# Input for ListSubscriptionsByTopic action.
|
1159
1323
|
#
|
1160
1324
|
# @note When making an API call, you may pass ListSubscriptionsByTopicInput
|
@@ -1397,7 +1561,7 @@ module Aws::SNS
|
|
1397
1561
|
# }
|
1398
1562
|
#
|
1399
1563
|
# @!attribute [rw] phone_number
|
1400
|
-
# The phone number to opt in.
|
1564
|
+
# The phone number to opt in. Use E.164 format.
|
1401
1565
|
# @return [String]
|
1402
1566
|
#
|
1403
1567
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumberInput AWS API Documentation
|
@@ -1414,6 +1578,61 @@ module Aws::SNS
|
|
1414
1578
|
#
|
1415
1579
|
class OptInPhoneNumberResponse < Aws::EmptyStructure; end
|
1416
1580
|
|
1581
|
+
# Indicates that the specified phone number opted out of receiving SMS
|
1582
|
+
# messages from your account. You can't send SMS messages to phone
|
1583
|
+
# numbers that opt out.
|
1584
|
+
#
|
1585
|
+
# @!attribute [rw] message
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptedOutException AWS API Documentation
|
1589
|
+
#
|
1590
|
+
class OptedOutException < Struct.new(
|
1591
|
+
:message)
|
1592
|
+
SENSITIVE = []
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
1596
|
+
# A list of phone numbers and their metadata.
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] created_at
|
1599
|
+
# The date and time when the phone number was created.
|
1600
|
+
# @return [Time]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] phone_number
|
1603
|
+
# The phone number.
|
1604
|
+
# @return [String]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] status
|
1607
|
+
# The status of the phone number.
|
1608
|
+
# @return [String]
|
1609
|
+
#
|
1610
|
+
# @!attribute [rw] iso_2_country_code
|
1611
|
+
# The two-character code for the country or region, in ISO 3166-1
|
1612
|
+
# alpha-2 format.
|
1613
|
+
# @return [String]
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] route_type
|
1616
|
+
# The list of supported routes.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @!attribute [rw] number_capabilities
|
1620
|
+
# The capabilities of each phone number.
|
1621
|
+
# @return [Array<String>]
|
1622
|
+
#
|
1623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PhoneNumberInformation AWS API Documentation
|
1624
|
+
#
|
1625
|
+
class PhoneNumberInformation < Struct.new(
|
1626
|
+
:created_at,
|
1627
|
+
:phone_number,
|
1628
|
+
:status,
|
1629
|
+
:iso_2_country_code,
|
1630
|
+
:route_type,
|
1631
|
+
:number_capabilities)
|
1632
|
+
SENSITIVE = []
|
1633
|
+
include Aws::Structure
|
1634
|
+
end
|
1635
|
+
|
1417
1636
|
# Platform application object.
|
1418
1637
|
#
|
1419
1638
|
# @!attribute [rw] platform_application_arn
|
@@ -1682,7 +1901,8 @@ module Aws::SNS
|
|
1682
1901
|
include Aws::Structure
|
1683
1902
|
end
|
1684
1903
|
|
1685
|
-
# Can
|
1904
|
+
# Can’t perform the action on the specified resource. Make sure that the
|
1905
|
+
# resource exists.
|
1686
1906
|
#
|
1687
1907
|
# @!attribute [rw] message
|
1688
1908
|
# @return [String]
|
@@ -1695,6 +1915,38 @@ module Aws::SNS
|
|
1695
1915
|
include Aws::Structure
|
1696
1916
|
end
|
1697
1917
|
|
1918
|
+
# A verified or pending destination phone number in the SMS sandbox.
|
1919
|
+
#
|
1920
|
+
# When you start using Amazon SNS to send SMS messages, your account is
|
1921
|
+
# in the *SMS sandbox*. The SMS sandbox provides a safe environment for
|
1922
|
+
# you to try Amazon SNS features without risking your reputation as an
|
1923
|
+
# SMS sender. While your account is in the SMS sandbox, you can use all
|
1924
|
+
# of the features of Amazon SNS. However, you can send SMS messages only
|
1925
|
+
# to verified destination phone numbers. For more information, including
|
1926
|
+
# how to move out of the sandbox to send messages without restrictions,
|
1927
|
+
# see [SMS sandbox][1] in the *Amazon SNS Developer Guide*.
|
1928
|
+
#
|
1929
|
+
#
|
1930
|
+
#
|
1931
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html
|
1932
|
+
#
|
1933
|
+
# @!attribute [rw] phone_number
|
1934
|
+
# The destination phone number.
|
1935
|
+
# @return [String]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] status
|
1938
|
+
# The destination phone number's verification status.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SMSSandboxPhoneNumber AWS API Documentation
|
1942
|
+
#
|
1943
|
+
class SMSSandboxPhoneNumber < Struct.new(
|
1944
|
+
:phone_number,
|
1945
|
+
:status)
|
1946
|
+
SENSITIVE = []
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1698
1950
|
# Input for SetEndpointAttributes action.
|
1699
1951
|
#
|
1700
1952
|
# @note When making an API call, you may pass SetEndpointAttributesInput
|
@@ -1887,7 +2139,7 @@ module Aws::SNS
|
|
1887
2139
|
# * Total number of parts
|
1888
2140
|
#
|
1889
2141
|
# To receive the report, the bucket must have a policy that allows the
|
1890
|
-
# Amazon SNS service
|
2142
|
+
# Amazon SNS service principal to perform the `s3:PutObject` and
|
1891
2143
|
# `s3:GetBucketLocation` actions.
|
1892
2144
|
#
|
1893
2145
|
# For an example bucket policy and usage report, see [Monitoring SMS
|
@@ -1971,7 +2223,7 @@ module Aws::SNS
|
|
1971
2223
|
#
|
1972
2224
|
#
|
1973
2225
|
#
|
1974
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
2226
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
|
1975
2227
|
# @return [String]
|
1976
2228
|
#
|
1977
2229
|
# @!attribute [rw] attribute_value
|
@@ -2023,10 +2275,10 @@ module Aws::SNS
|
|
2023
2275
|
# The following attribute applies only to
|
2024
2276
|
# [server-side-encryption][1]\:
|
2025
2277
|
#
|
2026
|
-
# * `KmsMasterKeyId` – The ID of an
|
2027
|
-
# (CMK) for Amazon SNS or a custom CMK. For more
|
2028
|
-
# [Key Terms][2]. For more examples, see [KeyId][3]
|
2029
|
-
# Management Service API Reference*.
|
2278
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2279
|
+
# customer master key (CMK) for Amazon SNS or a custom CMK. For more
|
2280
|
+
# information, see [Key Terms][2]. For more examples, see [KeyId][3]
|
2281
|
+
# in the *Key Management Service API Reference*.
|
2030
2282
|
#
|
2031
2283
|
# ^
|
2032
2284
|
#
|
@@ -2046,7 +2298,7 @@ module Aws::SNS
|
|
2046
2298
|
# message).
|
2047
2299
|
#
|
2048
2300
|
# (Optional) To override the generated value, you can specify a
|
2049
|
-
# value for the
|
2301
|
+
# value for the `MessageDeduplicationId` parameter for the
|
2050
2302
|
# `Publish` action.
|
2051
2303
|
#
|
2052
2304
|
#
|
@@ -2123,8 +2375,7 @@ module Aws::SNS
|
|
2123
2375
|
# * `application` – delivery of JSON-encoded message to an EndpointArn
|
2124
2376
|
# for a mobile app and device
|
2125
2377
|
#
|
2126
|
-
# * `lambda` – delivery of JSON-encoded message to an
|
2127
|
-
# function
|
2378
|
+
# * `lambda` – delivery of JSON-encoded message to an Lambda function
|
2128
2379
|
#
|
2129
2380
|
# * `firehose` – delivery of JSON-encoded message to an Amazon Kinesis
|
2130
2381
|
# Data Firehose delivery stream.
|
@@ -2153,8 +2404,8 @@ module Aws::SNS
|
|
2153
2404
|
# * For the `application` protocol, the endpoint is the EndpointArn of
|
2154
2405
|
# a mobile app and device.
|
2155
2406
|
#
|
2156
|
-
# * For the `lambda` protocol, the endpoint is the ARN of an
|
2157
|
-
#
|
2407
|
+
# * For the `lambda` protocol, the endpoint is the ARN of an Lambda
|
2408
|
+
# function.
|
2158
2409
|
#
|
2159
2410
|
# * For the `firehose` protocol, the endpoint is the ARN of an Amazon
|
2160
2411
|
# Kinesis Data Firehose delivery stream.
|
@@ -2164,8 +2415,7 @@ module Aws::SNS
|
|
2164
2415
|
# A map of attributes with their corresponding values.
|
2165
2416
|
#
|
2166
2417
|
# The following lists the names, descriptions, and values of the
|
2167
|
-
# special request parameters that the `
|
2168
|
-
# uses:
|
2418
|
+
# special request parameters that the `Subscribe` action uses:
|
2169
2419
|
#
|
2170
2420
|
# * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
|
2171
2421
|
# failed deliveries to HTTP/S endpoints.
|
@@ -2204,7 +2454,7 @@ module Aws::SNS
|
|
2204
2454
|
#
|
2205
2455
|
#
|
2206
2456
|
#
|
2207
|
-
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-
|
2457
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
|
2208
2458
|
# @return [Hash<String,String>]
|
2209
2459
|
#
|
2210
2460
|
# @!attribute [rw] return_subscription_arn
|
@@ -2485,5 +2735,83 @@ module Aws::SNS
|
|
2485
2735
|
#
|
2486
2736
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
2487
2737
|
|
2738
|
+
# Indicates that a request parameter does not comply with the associated
|
2739
|
+
# constraints.
|
2740
|
+
#
|
2741
|
+
# @!attribute [rw] message
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/UserErrorException AWS API Documentation
|
2745
|
+
#
|
2746
|
+
class UserErrorException < Struct.new(
|
2747
|
+
:message)
|
2748
|
+
SENSITIVE = []
|
2749
|
+
include Aws::Structure
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Indicates that a parameter in the request is invalid.
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] message
|
2755
|
+
# @return [String]
|
2756
|
+
#
|
2757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ValidationException AWS API Documentation
|
2758
|
+
#
|
2759
|
+
class ValidationException < Struct.new(
|
2760
|
+
:message)
|
2761
|
+
SENSITIVE = []
|
2762
|
+
include Aws::Structure
|
2763
|
+
end
|
2764
|
+
|
2765
|
+
# Indicates that the one-time password (OTP) used for verification is
|
2766
|
+
# invalid.
|
2767
|
+
#
|
2768
|
+
# @!attribute [rw] message
|
2769
|
+
# @return [String]
|
2770
|
+
#
|
2771
|
+
# @!attribute [rw] status
|
2772
|
+
# The status of the verification error.
|
2773
|
+
# @return [String]
|
2774
|
+
#
|
2775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerificationException AWS API Documentation
|
2776
|
+
#
|
2777
|
+
class VerificationException < Struct.new(
|
2778
|
+
:message,
|
2779
|
+
:status)
|
2780
|
+
SENSITIVE = []
|
2781
|
+
include Aws::Structure
|
2782
|
+
end
|
2783
|
+
|
2784
|
+
# @note When making an API call, you may pass VerifySMSSandboxPhoneNumberInput
|
2785
|
+
# data as a hash:
|
2786
|
+
#
|
2787
|
+
# {
|
2788
|
+
# phone_number: "PhoneNumberString", # required
|
2789
|
+
# one_time_password: "OTPCode", # required
|
2790
|
+
# }
|
2791
|
+
#
|
2792
|
+
# @!attribute [rw] phone_number
|
2793
|
+
# The destination phone number to verify.
|
2794
|
+
# @return [String]
|
2795
|
+
#
|
2796
|
+
# @!attribute [rw] one_time_password
|
2797
|
+
# The OTP sent to the destination number from the
|
2798
|
+
# `CreateSMSSandBoxPhoneNumber` call.
|
2799
|
+
# @return [String]
|
2800
|
+
#
|
2801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerifySMSSandboxPhoneNumberInput AWS API Documentation
|
2802
|
+
#
|
2803
|
+
class VerifySMSSandboxPhoneNumberInput < Struct.new(
|
2804
|
+
:phone_number,
|
2805
|
+
:one_time_password)
|
2806
|
+
SENSITIVE = []
|
2807
|
+
include Aws::Structure
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# The destination phone number's verification status.
|
2811
|
+
#
|
2812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/VerifySMSSandboxPhoneNumberResult AWS API Documentation
|
2813
|
+
#
|
2814
|
+
class VerifySMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
|
2815
|
+
|
2488
2816
|
end
|
2489
2817
|
end
|
data/lib/aws-sdk-sns.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-sns/customizations'
|
|
52
52
|
# @!group service
|
53
53
|
module Aws::SNS
|
54
54
|
|
55
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.46.0'
|
56
56
|
|
57
57
|
end
|