aws-sdk-sns 1.55.0 → 1.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sns/client.rb +84 -4
- data/lib/aws-sdk-sns/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-sns/endpoint_provider.rb +119 -0
- data/lib/aws-sdk-sns/endpoints.rb +603 -0
- data/lib/aws-sdk-sns/plugins/endpoints.rb +152 -0
- data/lib/aws-sdk-sns/resource.rb +13 -0
- data/lib/aws-sdk-sns/subscription.rb +16 -0
- data/lib/aws-sdk-sns/topic.rb +43 -3
- data/lib/aws-sdk-sns/types.rb +75 -414
- data/lib/aws-sdk-sns.rb +5 -1
- metadata +8 -4
data/lib/aws-sdk-sns/types.rb
CHANGED
@@ -10,16 +10,6 @@
|
|
10
10
|
module Aws::SNS
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# @note When making an API call, you may pass AddPermissionInput
|
14
|
-
# data as a hash:
|
15
|
-
#
|
16
|
-
# {
|
17
|
-
# topic_arn: "topicARN", # required
|
18
|
-
# label: "label", # required
|
19
|
-
# aws_account_id: ["delegate"], # required
|
20
|
-
# action_name: ["action"], # required
|
21
|
-
# }
|
22
|
-
#
|
23
13
|
# @!attribute [rw] topic_arn
|
24
14
|
# The ARN of the topic whose access control policy you wish to modify.
|
25
15
|
# @return [String]
|
@@ -125,13 +115,6 @@ module Aws::SNS
|
|
125
115
|
|
126
116
|
# The input for the `CheckIfPhoneNumberIsOptedOut` action.
|
127
117
|
#
|
128
|
-
# @note When making an API call, you may pass CheckIfPhoneNumberIsOptedOutInput
|
129
|
-
# data as a hash:
|
130
|
-
#
|
131
|
-
# {
|
132
|
-
# phone_number: "PhoneNumber", # required
|
133
|
-
# }
|
134
|
-
#
|
135
118
|
# @!attribute [rw] phone_number
|
136
119
|
# The phone number for which you want to check the opt out status.
|
137
120
|
# @return [String]
|
@@ -180,15 +163,6 @@ module Aws::SNS
|
|
180
163
|
|
181
164
|
# Input for ConfirmSubscription action.
|
182
165
|
#
|
183
|
-
# @note When making an API call, you may pass ConfirmSubscriptionInput
|
184
|
-
# data as a hash:
|
185
|
-
#
|
186
|
-
# {
|
187
|
-
# topic_arn: "topicARN", # required
|
188
|
-
# token: "token", # required
|
189
|
-
# authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
|
190
|
-
# }
|
191
|
-
#
|
192
166
|
# @!attribute [rw] topic_arn
|
193
167
|
# The ARN of the topic for which you wish to confirm a subscription.
|
194
168
|
# @return [String]
|
@@ -245,17 +219,6 @@ module Aws::SNS
|
|
245
219
|
|
246
220
|
# Input for CreatePlatformApplication action.
|
247
221
|
#
|
248
|
-
# @note When making an API call, you may pass CreatePlatformApplicationInput
|
249
|
-
# data as a hash:
|
250
|
-
#
|
251
|
-
# {
|
252
|
-
# name: "String", # required
|
253
|
-
# platform: "String", # required
|
254
|
-
# attributes: { # required
|
255
|
-
# "String" => "String",
|
256
|
-
# },
|
257
|
-
# }
|
258
|
-
#
|
259
222
|
# @!attribute [rw] name
|
260
223
|
# Application names must be made up of only uppercase and lowercase
|
261
224
|
# ASCII letters, numbers, underscores, hyphens, and periods, and must
|
@@ -302,18 +265,6 @@ module Aws::SNS
|
|
302
265
|
|
303
266
|
# Input for CreatePlatformEndpoint action.
|
304
267
|
#
|
305
|
-
# @note When making an API call, you may pass CreatePlatformEndpointInput
|
306
|
-
# data as a hash:
|
307
|
-
#
|
308
|
-
# {
|
309
|
-
# platform_application_arn: "String", # required
|
310
|
-
# token: "String", # required
|
311
|
-
# custom_user_data: "String",
|
312
|
-
# attributes: {
|
313
|
-
# "String" => "String",
|
314
|
-
# },
|
315
|
-
# }
|
316
|
-
#
|
317
268
|
# @!attribute [rw] platform_application_arn
|
318
269
|
# PlatformApplicationArn returned from CreatePlatformApplication is
|
319
270
|
# used to create a an endpoint.
|
@@ -353,14 +304,6 @@ module Aws::SNS
|
|
353
304
|
include Aws::Structure
|
354
305
|
end
|
355
306
|
|
356
|
-
# @note When making an API call, you may pass CreateSMSSandboxPhoneNumberInput
|
357
|
-
# data as a hash:
|
358
|
-
#
|
359
|
-
# {
|
360
|
-
# phone_number: "PhoneNumberString", # required
|
361
|
-
# 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
|
362
|
-
# }
|
363
|
-
#
|
364
307
|
# @!attribute [rw] phone_number
|
365
308
|
# The destination phone number to verify. On verification, Amazon SNS
|
366
309
|
# adds this phone number to the list of verified phone numbers that
|
@@ -387,23 +330,6 @@ module Aws::SNS
|
|
387
330
|
|
388
331
|
# Input for CreateTopic action.
|
389
332
|
#
|
390
|
-
# @note When making an API call, you may pass CreateTopicInput
|
391
|
-
# data as a hash:
|
392
|
-
#
|
393
|
-
# {
|
394
|
-
# name: "topicName", # required
|
395
|
-
# attributes: {
|
396
|
-
# "attributeName" => "attributeValue",
|
397
|
-
# },
|
398
|
-
# tags: [
|
399
|
-
# {
|
400
|
-
# key: "TagKey", # required
|
401
|
-
# value: "TagValue", # required
|
402
|
-
# },
|
403
|
-
# ],
|
404
|
-
# data_protection_policy: "attributeValue",
|
405
|
-
# }
|
406
|
-
#
|
407
333
|
# @!attribute [rw] name
|
408
334
|
# The name of the topic you want to create.
|
409
335
|
#
|
@@ -433,6 +359,20 @@ module Aws::SNS
|
|
433
359
|
# default, only the topic owner can publish or subscribe to the
|
434
360
|
# topic.
|
435
361
|
#
|
362
|
+
# * `SignatureVersion` – The signature version corresponds to the
|
363
|
+
# hashing algorithm used while creating the signature of the
|
364
|
+
# notifications, subscription confirmations, or unsubscribe
|
365
|
+
# confirmation messages sent by Amazon SNS. By default,
|
366
|
+
# `SignatureVersion` is set to 1.
|
367
|
+
#
|
368
|
+
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
369
|
+
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
370
|
+
# through the tracing header it receives from an Amazon SNS
|
371
|
+
# publisher to its subscriptions. If set to Active, Amazon SNS will
|
372
|
+
# vend X-Ray segment data to topic owner account if the sampled flag
|
373
|
+
# in the tracing header is true. This is only supported on standard
|
374
|
+
# topics.
|
375
|
+
#
|
436
376
|
# The following attribute applies only to [server-side
|
437
377
|
# encryption][1]\:
|
438
378
|
#
|
@@ -519,13 +459,6 @@ module Aws::SNS
|
|
519
459
|
|
520
460
|
# Input for DeleteEndpoint action.
|
521
461
|
#
|
522
|
-
# @note When making an API call, you may pass DeleteEndpointInput
|
523
|
-
# data as a hash:
|
524
|
-
#
|
525
|
-
# {
|
526
|
-
# endpoint_arn: "String", # required
|
527
|
-
# }
|
528
|
-
#
|
529
462
|
# @!attribute [rw] endpoint_arn
|
530
463
|
# EndpointArn of endpoint to delete.
|
531
464
|
# @return [String]
|
@@ -540,13 +473,6 @@ module Aws::SNS
|
|
540
473
|
|
541
474
|
# Input for DeletePlatformApplication action.
|
542
475
|
#
|
543
|
-
# @note When making an API call, you may pass DeletePlatformApplicationInput
|
544
|
-
# data as a hash:
|
545
|
-
#
|
546
|
-
# {
|
547
|
-
# platform_application_arn: "String", # required
|
548
|
-
# }
|
549
|
-
#
|
550
476
|
# @!attribute [rw] platform_application_arn
|
551
477
|
# PlatformApplicationArn of platform application object to delete.
|
552
478
|
# @return [String]
|
@@ -559,13 +485,6 @@ module Aws::SNS
|
|
559
485
|
include Aws::Structure
|
560
486
|
end
|
561
487
|
|
562
|
-
# @note When making an API call, you may pass DeleteSMSSandboxPhoneNumberInput
|
563
|
-
# data as a hash:
|
564
|
-
#
|
565
|
-
# {
|
566
|
-
# phone_number: "PhoneNumberString", # required
|
567
|
-
# }
|
568
|
-
#
|
569
488
|
# @!attribute [rw] phone_number
|
570
489
|
# The destination phone number to delete.
|
571
490
|
# @return [String]
|
@@ -582,13 +501,6 @@ module Aws::SNS
|
|
582
501
|
#
|
583
502
|
class DeleteSMSSandboxPhoneNumberResult < Aws::EmptyStructure; end
|
584
503
|
|
585
|
-
# @note When making an API call, you may pass DeleteTopicInput
|
586
|
-
# data as a hash:
|
587
|
-
#
|
588
|
-
# {
|
589
|
-
# topic_arn: "topicARN", # required
|
590
|
-
# }
|
591
|
-
#
|
592
504
|
# @!attribute [rw] topic_arn
|
593
505
|
# The ARN of the topic you want to delete.
|
594
506
|
# @return [String]
|
@@ -663,13 +575,6 @@ module Aws::SNS
|
|
663
575
|
include Aws::Structure
|
664
576
|
end
|
665
577
|
|
666
|
-
# @note When making an API call, you may pass GetDataProtectionPolicyInput
|
667
|
-
# data as a hash:
|
668
|
-
#
|
669
|
-
# {
|
670
|
-
# resource_arn: "topicARN", # required
|
671
|
-
# }
|
672
|
-
#
|
673
578
|
# @!attribute [rw] resource_arn
|
674
579
|
# The ARN of the topic whose `DataProtectionPolicy` you want to get.
|
675
580
|
#
|
@@ -703,13 +608,6 @@ module Aws::SNS
|
|
703
608
|
|
704
609
|
# Input for GetEndpointAttributes action.
|
705
610
|
#
|
706
|
-
# @note When making an API call, you may pass GetEndpointAttributesInput
|
707
|
-
# data as a hash:
|
708
|
-
#
|
709
|
-
# {
|
710
|
-
# endpoint_arn: "String", # required
|
711
|
-
# }
|
712
|
-
#
|
713
611
|
# @!attribute [rw] endpoint_arn
|
714
612
|
# EndpointArn for GetEndpointAttributes input.
|
715
613
|
# @return [String]
|
@@ -756,13 +654,6 @@ module Aws::SNS
|
|
756
654
|
|
757
655
|
# Input for GetPlatformApplicationAttributes action.
|
758
656
|
#
|
759
|
-
# @note When making an API call, you may pass GetPlatformApplicationAttributesInput
|
760
|
-
# data as a hash:
|
761
|
-
#
|
762
|
-
# {
|
763
|
-
# platform_application_arn: "String", # required
|
764
|
-
# }
|
765
|
-
#
|
766
657
|
# @!attribute [rw] platform_application_arn
|
767
658
|
# PlatformApplicationArn for GetPlatformApplicationAttributesInput.
|
768
659
|
# @return [String]
|
@@ -813,13 +704,6 @@ module Aws::SNS
|
|
813
704
|
|
814
705
|
# The input for the `GetSMSAttributes` request.
|
815
706
|
#
|
816
|
-
# @note When making an API call, you may pass GetSMSAttributesInput
|
817
|
-
# data as a hash:
|
818
|
-
#
|
819
|
-
# {
|
820
|
-
# attributes: ["String"],
|
821
|
-
# }
|
822
|
-
#
|
823
707
|
# @!attribute [rw] attributes
|
824
708
|
# A list of the individual attribute names, such as
|
825
709
|
# `MonthlySpendLimit`, for which you want values.
|
@@ -877,13 +761,6 @@ module Aws::SNS
|
|
877
761
|
|
878
762
|
# Input for GetSubscriptionAttributes.
|
879
763
|
#
|
880
|
-
# @note When making an API call, you may pass GetSubscriptionAttributesInput
|
881
|
-
# data as a hash:
|
882
|
-
#
|
883
|
-
# {
|
884
|
-
# subscription_arn: "subscriptionARN", # required
|
885
|
-
# }
|
886
|
-
#
|
887
764
|
# @!attribute [rw] subscription_arn
|
888
765
|
# The ARN of the subscription whose properties you want to get.
|
889
766
|
# @return [String]
|
@@ -916,6 +793,14 @@ module Aws::SNS
|
|
916
793
|
# subscription. For more information, see [Amazon SNS Message
|
917
794
|
# Filtering][1] in the *Amazon SNS Developer Guide*.
|
918
795
|
#
|
796
|
+
# * `FilterPolicyScope` – This attribute lets you choose the filtering
|
797
|
+
# scope by using one of the following string value types:
|
798
|
+
#
|
799
|
+
# * `MessageAttributes` (default) – The filter is applied on the
|
800
|
+
# message attributes.
|
801
|
+
#
|
802
|
+
# * `MessageBody` – The filter is applied on the message body.
|
803
|
+
#
|
919
804
|
# * `Owner` – The Amazon Web Services account ID of the
|
920
805
|
# subscription's owner.
|
921
806
|
#
|
@@ -971,13 +856,6 @@ module Aws::SNS
|
|
971
856
|
|
972
857
|
# Input for GetTopicAttributes action.
|
973
858
|
#
|
974
|
-
# @note When making an API call, you may pass GetTopicAttributesInput
|
975
|
-
# data as a hash:
|
976
|
-
#
|
977
|
-
# {
|
978
|
-
# topic_arn: "topicARN", # required
|
979
|
-
# }
|
980
|
-
#
|
981
859
|
# @!attribute [rw] topic_arn
|
982
860
|
# The ARN of the topic whose properties you want to get.
|
983
861
|
# @return [String]
|
@@ -1002,12 +880,30 @@ module Aws::SNS
|
|
1002
880
|
# * `DisplayName` – The human-readable name used in the `From` field
|
1003
881
|
# for notifications to `email` and `email-json` endpoints.
|
1004
882
|
#
|
883
|
+
# * `EffectiveDeliveryPolicy` – The JSON serialization of the
|
884
|
+
# effective delivery policy, taking system defaults into account.
|
885
|
+
#
|
1005
886
|
# * `Owner` – The Amazon Web Services account ID of the topic's
|
1006
887
|
# owner.
|
1007
888
|
#
|
1008
889
|
# * `Policy` – The JSON serialization of the topic's access control
|
1009
890
|
# policy.
|
1010
891
|
#
|
892
|
+
# * `SignatureVersion` – The version of the Amazon SNS signature used
|
893
|
+
# for the topic.
|
894
|
+
#
|
895
|
+
# * By default, `SignatureVersion` is set to **1**. The signature is
|
896
|
+
# a Base64-encoded **SHA1withRSA** signature.
|
897
|
+
#
|
898
|
+
# * When you set `SignatureVersion` to **2**. Amazon SNS uses a
|
899
|
+
# Base64-encoded **SHA256withRSA** signature.
|
900
|
+
#
|
901
|
+
# <note markdown="1"> If the API response does not include the `SignatureVersion`
|
902
|
+
# attribute, it means that the `SignatureVersion` for the topic
|
903
|
+
# has value **1**.
|
904
|
+
#
|
905
|
+
# </note>
|
906
|
+
#
|
1011
907
|
# * `SubscriptionsConfirmed` – The number of confirmed subscriptions
|
1012
908
|
# for the topic.
|
1013
909
|
#
|
@@ -1019,8 +915,13 @@ module Aws::SNS
|
|
1019
915
|
#
|
1020
916
|
# * `TopicArn` – The topic's ARN.
|
1021
917
|
#
|
1022
|
-
# * `
|
1023
|
-
#
|
918
|
+
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
919
|
+
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
920
|
+
# through the tracing header it receives from an Amazon SNS
|
921
|
+
# publisher to its subscriptions. If set to Active, Amazon SNS will
|
922
|
+
# vend X-Ray segment data to topic owner account if the sampled flag
|
923
|
+
# in the tracing header is true. This is only supported on standard
|
924
|
+
# topics.
|
1024
925
|
#
|
1025
926
|
# The following attribute applies only to
|
1026
927
|
# [server-side-encryption][1]\:
|
@@ -1238,14 +1139,6 @@ module Aws::SNS
|
|
1238
1139
|
|
1239
1140
|
# Input for ListEndpointsByPlatformApplication action.
|
1240
1141
|
#
|
1241
|
-
# @note When making an API call, you may pass ListEndpointsByPlatformApplicationInput
|
1242
|
-
# data as a hash:
|
1243
|
-
#
|
1244
|
-
# {
|
1245
|
-
# platform_application_arn: "String", # required
|
1246
|
-
# next_token: "String",
|
1247
|
-
# }
|
1248
|
-
#
|
1249
1142
|
# @!attribute [rw] platform_application_arn
|
1250
1143
|
# PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
|
1251
1144
|
# action.
|
@@ -1287,14 +1180,6 @@ module Aws::SNS
|
|
1287
1180
|
include Aws::Structure
|
1288
1181
|
end
|
1289
1182
|
|
1290
|
-
# @note When making an API call, you may pass ListOriginationNumbersRequest
|
1291
|
-
# data as a hash:
|
1292
|
-
#
|
1293
|
-
# {
|
1294
|
-
# next_token: "nextToken",
|
1295
|
-
# max_results: 1,
|
1296
|
-
# }
|
1297
|
-
#
|
1298
1183
|
# @!attribute [rw] next_token
|
1299
1184
|
# Token that the previous `ListOriginationNumbers` request returns.
|
1300
1185
|
# @return [String]
|
@@ -1334,13 +1219,6 @@ module Aws::SNS
|
|
1334
1219
|
|
1335
1220
|
# The input for the `ListPhoneNumbersOptedOut` action.
|
1336
1221
|
#
|
1337
|
-
# @note When making an API call, you may pass ListPhoneNumbersOptedOutInput
|
1338
|
-
# data as a hash:
|
1339
|
-
#
|
1340
|
-
# {
|
1341
|
-
# next_token: "string",
|
1342
|
-
# }
|
1343
|
-
#
|
1344
1222
|
# @!attribute [rw] next_token
|
1345
1223
|
# A `NextToken` string is used when you call the
|
1346
1224
|
# `ListPhoneNumbersOptedOut` action to retrieve additional records
|
@@ -1380,13 +1258,6 @@ module Aws::SNS
|
|
1380
1258
|
|
1381
1259
|
# Input for ListPlatformApplications action.
|
1382
1260
|
#
|
1383
|
-
# @note When making an API call, you may pass ListPlatformApplicationsInput
|
1384
|
-
# data as a hash:
|
1385
|
-
#
|
1386
|
-
# {
|
1387
|
-
# next_token: "String",
|
1388
|
-
# }
|
1389
|
-
#
|
1390
1261
|
# @!attribute [rw] next_token
|
1391
1262
|
# NextToken string is used when calling ListPlatformApplications
|
1392
1263
|
# action to retrieve additional records that are available after the
|
@@ -1423,14 +1294,6 @@ module Aws::SNS
|
|
1423
1294
|
include Aws::Structure
|
1424
1295
|
end
|
1425
1296
|
|
1426
|
-
# @note When making an API call, you may pass ListSMSSandboxPhoneNumbersInput
|
1427
|
-
# data as a hash:
|
1428
|
-
#
|
1429
|
-
# {
|
1430
|
-
# next_token: "nextToken",
|
1431
|
-
# max_results: 1,
|
1432
|
-
# }
|
1433
|
-
#
|
1434
1297
|
# @!attribute [rw] next_token
|
1435
1298
|
# Token that the previous `ListSMSSandboxPhoneNumbersInput` request
|
1436
1299
|
# returns.
|
@@ -1470,14 +1333,6 @@ module Aws::SNS
|
|
1470
1333
|
|
1471
1334
|
# Input for ListSubscriptionsByTopic action.
|
1472
1335
|
#
|
1473
|
-
# @note When making an API call, you may pass ListSubscriptionsByTopicInput
|
1474
|
-
# data as a hash:
|
1475
|
-
#
|
1476
|
-
# {
|
1477
|
-
# topic_arn: "topicARN", # required
|
1478
|
-
# next_token: "nextToken",
|
1479
|
-
# }
|
1480
|
-
#
|
1481
1336
|
# @!attribute [rw] topic_arn
|
1482
1337
|
# The ARN of the topic for which you wish to find subscriptions.
|
1483
1338
|
# @return [String]
|
@@ -1518,13 +1373,6 @@ module Aws::SNS
|
|
1518
1373
|
|
1519
1374
|
# Input for ListSubscriptions action.
|
1520
1375
|
#
|
1521
|
-
# @note When making an API call, you may pass ListSubscriptionsInput
|
1522
|
-
# data as a hash:
|
1523
|
-
#
|
1524
|
-
# {
|
1525
|
-
# next_token: "nextToken",
|
1526
|
-
# }
|
1527
|
-
#
|
1528
1376
|
# @!attribute [rw] next_token
|
1529
1377
|
# Token returned by the previous `ListSubscriptions` request.
|
1530
1378
|
# @return [String]
|
@@ -1557,13 +1405,6 @@ module Aws::SNS
|
|
1557
1405
|
include Aws::Structure
|
1558
1406
|
end
|
1559
1407
|
|
1560
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1561
|
-
# data as a hash:
|
1562
|
-
#
|
1563
|
-
# {
|
1564
|
-
# resource_arn: "AmazonResourceName", # required
|
1565
|
-
# }
|
1566
|
-
#
|
1567
1408
|
# @!attribute [rw] resource_arn
|
1568
1409
|
# The ARN of the topic for which to list tags.
|
1569
1410
|
# @return [String]
|
@@ -1588,13 +1429,6 @@ module Aws::SNS
|
|
1588
1429
|
include Aws::Structure
|
1589
1430
|
end
|
1590
1431
|
|
1591
|
-
# @note When making an API call, you may pass ListTopicsInput
|
1592
|
-
# data as a hash:
|
1593
|
-
#
|
1594
|
-
# {
|
1595
|
-
# next_token: "nextToken",
|
1596
|
-
# }
|
1597
|
-
#
|
1598
1432
|
# @!attribute [rw] next_token
|
1599
1433
|
# Token returned by the previous `ListTopics` request.
|
1600
1434
|
# @return [String]
|
@@ -1644,15 +1478,6 @@ module Aws::SNS
|
|
1644
1478
|
# [2]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
|
1645
1479
|
# [3]: https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html
|
1646
1480
|
#
|
1647
|
-
# @note When making an API call, you may pass MessageAttributeValue
|
1648
|
-
# data as a hash:
|
1649
|
-
#
|
1650
|
-
# {
|
1651
|
-
# data_type: "String", # required
|
1652
|
-
# string_value: "String",
|
1653
|
-
# binary_value: "data",
|
1654
|
-
# }
|
1655
|
-
#
|
1656
1481
|
# @!attribute [rw] data_type
|
1657
1482
|
# Amazon SNS supports the following logical data types: String,
|
1658
1483
|
# String.Array, Number, and Binary. For more information, see [Message
|
@@ -1702,13 +1527,6 @@ module Aws::SNS
|
|
1702
1527
|
|
1703
1528
|
# Input for the OptInPhoneNumber action.
|
1704
1529
|
#
|
1705
|
-
# @note When making an API call, you may pass OptInPhoneNumberInput
|
1706
|
-
# data as a hash:
|
1707
|
-
#
|
1708
|
-
# {
|
1709
|
-
# phone_number: "PhoneNumber", # required
|
1710
|
-
# }
|
1711
|
-
#
|
1712
1530
|
# @!attribute [rw] phone_number
|
1713
1531
|
# The phone number to opt in. Use E.164 format.
|
1714
1532
|
# @return [String]
|
@@ -1815,30 +1633,6 @@ module Aws::SNS
|
|
1815
1633
|
include Aws::Structure
|
1816
1634
|
end
|
1817
1635
|
|
1818
|
-
# @note When making an API call, you may pass PublishBatchInput
|
1819
|
-
# data as a hash:
|
1820
|
-
#
|
1821
|
-
# {
|
1822
|
-
# topic_arn: "topicARN", # required
|
1823
|
-
# publish_batch_request_entries: [ # required
|
1824
|
-
# {
|
1825
|
-
# id: "String", # required
|
1826
|
-
# message: "message", # required
|
1827
|
-
# subject: "subject",
|
1828
|
-
# message_structure: "messageStructure",
|
1829
|
-
# message_attributes: {
|
1830
|
-
# "String" => {
|
1831
|
-
# data_type: "String", # required
|
1832
|
-
# string_value: "String",
|
1833
|
-
# binary_value: "data",
|
1834
|
-
# },
|
1835
|
-
# },
|
1836
|
-
# message_deduplication_id: "String",
|
1837
|
-
# message_group_id: "String",
|
1838
|
-
# },
|
1839
|
-
# ],
|
1840
|
-
# }
|
1841
|
-
#
|
1842
1636
|
# @!attribute [rw] topic_arn
|
1843
1637
|
# The Amazon resource name (ARN) of the topic you want to batch
|
1844
1638
|
# publish to.
|
@@ -1861,25 +1655,6 @@ module Aws::SNS
|
|
1861
1655
|
# Contains the details of a single Amazon SNS message along with an `Id`
|
1862
1656
|
# that identifies a message within the batch.
|
1863
1657
|
#
|
1864
|
-
# @note When making an API call, you may pass PublishBatchRequestEntry
|
1865
|
-
# data as a hash:
|
1866
|
-
#
|
1867
|
-
# {
|
1868
|
-
# id: "String", # required
|
1869
|
-
# message: "message", # required
|
1870
|
-
# subject: "subject",
|
1871
|
-
# message_structure: "messageStructure",
|
1872
|
-
# message_attributes: {
|
1873
|
-
# "String" => {
|
1874
|
-
# data_type: "String", # required
|
1875
|
-
# string_value: "String",
|
1876
|
-
# binary_value: "data",
|
1877
|
-
# },
|
1878
|
-
# },
|
1879
|
-
# message_deduplication_id: "String",
|
1880
|
-
# message_group_id: "String",
|
1881
|
-
# }
|
1882
|
-
#
|
1883
1658
|
# @!attribute [rw] id
|
1884
1659
|
# An identifier for the message in this batch.
|
1885
1660
|
#
|
@@ -2071,27 +1846,6 @@ module Aws::SNS
|
|
2071
1846
|
|
2072
1847
|
# Input for Publish action.
|
2073
1848
|
#
|
2074
|
-
# @note When making an API call, you may pass PublishInput
|
2075
|
-
# data as a hash:
|
2076
|
-
#
|
2077
|
-
# {
|
2078
|
-
# topic_arn: "topicARN",
|
2079
|
-
# target_arn: "String",
|
2080
|
-
# phone_number: "String",
|
2081
|
-
# message: "message", # required
|
2082
|
-
# subject: "subject",
|
2083
|
-
# message_structure: "messageStructure",
|
2084
|
-
# message_attributes: {
|
2085
|
-
# "String" => {
|
2086
|
-
# data_type: "String", # required
|
2087
|
-
# string_value: "String",
|
2088
|
-
# binary_value: "data",
|
2089
|
-
# },
|
2090
|
-
# },
|
2091
|
-
# message_deduplication_id: "String",
|
2092
|
-
# message_group_id: "String",
|
2093
|
-
# }
|
2094
|
-
#
|
2095
1849
|
# @!attribute [rw] topic_arn
|
2096
1850
|
# The topic you want to publish to.
|
2097
1851
|
#
|
@@ -2277,14 +2031,6 @@ module Aws::SNS
|
|
2277
2031
|
include Aws::Structure
|
2278
2032
|
end
|
2279
2033
|
|
2280
|
-
# @note When making an API call, you may pass PutDataProtectionPolicyInput
|
2281
|
-
# data as a hash:
|
2282
|
-
#
|
2283
|
-
# {
|
2284
|
-
# resource_arn: "topicARN", # required
|
2285
|
-
# data_protection_policy: "attributeValue", # required
|
2286
|
-
# }
|
2287
|
-
#
|
2288
2034
|
# @!attribute [rw] resource_arn
|
2289
2035
|
# The ARN of the topic whose `DataProtectionPolicy` you want to add or
|
2290
2036
|
# update.
|
@@ -2316,14 +2062,6 @@ module Aws::SNS
|
|
2316
2062
|
|
2317
2063
|
# Input for RemovePermission action.
|
2318
2064
|
#
|
2319
|
-
# @note When making an API call, you may pass RemovePermissionInput
|
2320
|
-
# data as a hash:
|
2321
|
-
#
|
2322
|
-
# {
|
2323
|
-
# topic_arn: "topicARN", # required
|
2324
|
-
# label: "label", # required
|
2325
|
-
# }
|
2326
|
-
#
|
2327
2065
|
# @!attribute [rw] topic_arn
|
2328
2066
|
# The ARN of the topic whose access control policy you wish to modify.
|
2329
2067
|
# @return [String]
|
@@ -2390,16 +2128,6 @@ module Aws::SNS
|
|
2390
2128
|
|
2391
2129
|
# Input for SetEndpointAttributes action.
|
2392
2130
|
#
|
2393
|
-
# @note When making an API call, you may pass SetEndpointAttributesInput
|
2394
|
-
# data as a hash:
|
2395
|
-
#
|
2396
|
-
# {
|
2397
|
-
# endpoint_arn: "String", # required
|
2398
|
-
# attributes: { # required
|
2399
|
-
# "String" => "String",
|
2400
|
-
# },
|
2401
|
-
# }
|
2402
|
-
#
|
2403
2131
|
# @!attribute [rw] endpoint_arn
|
2404
2132
|
# EndpointArn used for SetEndpointAttributes action.
|
2405
2133
|
# @return [String]
|
@@ -2434,16 +2162,6 @@ module Aws::SNS
|
|
2434
2162
|
|
2435
2163
|
# Input for SetPlatformApplicationAttributes action.
|
2436
2164
|
#
|
2437
|
-
# @note When making an API call, you may pass SetPlatformApplicationAttributesInput
|
2438
|
-
# data as a hash:
|
2439
|
-
#
|
2440
|
-
# {
|
2441
|
-
# platform_application_arn: "String", # required
|
2442
|
-
# attributes: { # required
|
2443
|
-
# "String" => "String",
|
2444
|
-
# },
|
2445
|
-
# }
|
2446
|
-
#
|
2447
2165
|
# @!attribute [rw] platform_application_arn
|
2448
2166
|
# PlatformApplicationArn for SetPlatformApplicationAttributes action.
|
2449
2167
|
# @return [String]
|
@@ -2525,15 +2243,6 @@ module Aws::SNS
|
|
2525
2243
|
|
2526
2244
|
# The input for the SetSMSAttributes action.
|
2527
2245
|
#
|
2528
|
-
# @note When making an API call, you may pass SetSMSAttributesInput
|
2529
|
-
# data as a hash:
|
2530
|
-
#
|
2531
|
-
# {
|
2532
|
-
# attributes: { # required
|
2533
|
-
# "String" => "String",
|
2534
|
-
# },
|
2535
|
-
# }
|
2536
|
-
#
|
2537
2246
|
# @!attribute [rw] attributes
|
2538
2247
|
# The default settings for sending SMS messages from your Amazon Web
|
2539
2248
|
# Services account. You can set values for the following attribute
|
@@ -2636,15 +2345,6 @@ module Aws::SNS
|
|
2636
2345
|
|
2637
2346
|
# Input for SetSubscriptionAttributes action.
|
2638
2347
|
#
|
2639
|
-
# @note When making an API call, you may pass SetSubscriptionAttributesInput
|
2640
|
-
# data as a hash:
|
2641
|
-
#
|
2642
|
-
# {
|
2643
|
-
# subscription_arn: "subscriptionARN", # required
|
2644
|
-
# attribute_name: "attributeName", # required
|
2645
|
-
# attribute_value: "attributeValue",
|
2646
|
-
# }
|
2647
|
-
#
|
2648
2348
|
# @!attribute [rw] subscription_arn
|
2649
2349
|
# The ARN of the subscription to modify.
|
2650
2350
|
# @return [String]
|
@@ -2662,6 +2362,14 @@ module Aws::SNS
|
|
2662
2362
|
# receive only a subset of messages, rather than receiving every
|
2663
2363
|
# message published to the topic.
|
2664
2364
|
#
|
2365
|
+
# * `FilterPolicyScope` – This attribute lets you choose the filtering
|
2366
|
+
# scope by using one of the following string value types:
|
2367
|
+
#
|
2368
|
+
# * `MessageAttributes` (default) – The filter is applied on the
|
2369
|
+
# message attributes.
|
2370
|
+
#
|
2371
|
+
# * `MessageBody` – The filter is applied on the message body.
|
2372
|
+
#
|
2665
2373
|
# * `RawMessageDelivery` – When set to `true`, enables raw message
|
2666
2374
|
# delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
|
2667
2375
|
# need for the endpoints to process JSON formatting, which is
|
@@ -2711,15 +2419,6 @@ module Aws::SNS
|
|
2711
2419
|
|
2712
2420
|
# Input for SetTopicAttributes action.
|
2713
2421
|
#
|
2714
|
-
# @note When making an API call, you may pass SetTopicAttributesInput
|
2715
|
-
# data as a hash:
|
2716
|
-
#
|
2717
|
-
# {
|
2718
|
-
# topic_arn: "topicARN", # required
|
2719
|
-
# attribute_name: "attributeName", # required
|
2720
|
-
# attribute_value: "attributeValue",
|
2721
|
-
# }
|
2722
|
-
#
|
2723
2422
|
# @!attribute [rw] topic_arn
|
2724
2423
|
# The ARN of the topic to modify.
|
2725
2424
|
# @return [String]
|
@@ -2741,6 +2440,14 @@ module Aws::SNS
|
|
2741
2440
|
# default, only the topic owner can publish or subscribe to the
|
2742
2441
|
# topic.
|
2743
2442
|
#
|
2443
|
+
# * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
|
2444
|
+
# `TracingConfig` is set to `PassThrough`, and the topic passes
|
2445
|
+
# through the tracing header it receives from an Amazon SNS
|
2446
|
+
# publisher to its subscriptions. If set to Active, Amazon SNS will
|
2447
|
+
# vend X-Ray segment data to topic owner account if the sampled flag
|
2448
|
+
# in the tracing header is true. This is only supported on standard
|
2449
|
+
# topics.
|
2450
|
+
#
|
2744
2451
|
# The following attribute applies only to
|
2745
2452
|
# [server-side-encryption][1]\:
|
2746
2453
|
#
|
@@ -2749,7 +2456,10 @@ module Aws::SNS
|
|
2749
2456
|
# information, see [Key Terms][2]. For more examples, see [KeyId][3]
|
2750
2457
|
# in the *Key Management Service API Reference*.
|
2751
2458
|
#
|
2752
|
-
#
|
2459
|
+
# * `SignatureVersion` – The signature version corresponds to the
|
2460
|
+
# hashing algorithm used while creating the signature of the
|
2461
|
+
# notifications, subscription confirmations, or unsubscribe
|
2462
|
+
# confirmation messages sent by Amazon SNS.
|
2753
2463
|
#
|
2754
2464
|
# The following attribute applies only to [FIFO topics][4]\:
|
2755
2465
|
#
|
@@ -2809,19 +2519,6 @@ module Aws::SNS
|
|
2809
2519
|
|
2810
2520
|
# Input for Subscribe action.
|
2811
2521
|
#
|
2812
|
-
# @note When making an API call, you may pass SubscribeInput
|
2813
|
-
# data as a hash:
|
2814
|
-
#
|
2815
|
-
# {
|
2816
|
-
# topic_arn: "topicARN", # required
|
2817
|
-
# protocol: "protocol", # required
|
2818
|
-
# endpoint: "endpoint",
|
2819
|
-
# attributes: {
|
2820
|
-
# "attributeName" => "attributeValue",
|
2821
|
-
# },
|
2822
|
-
# return_subscription_arn: false,
|
2823
|
-
# }
|
2824
|
-
#
|
2825
2522
|
# @!attribute [rw] topic_arn
|
2826
2523
|
# The ARN of the topic you want to subscribe to.
|
2827
2524
|
# @return [String]
|
@@ -2893,6 +2590,14 @@ module Aws::SNS
|
|
2893
2590
|
# receive only a subset of messages, rather than receiving every
|
2894
2591
|
# message published to the topic.
|
2895
2592
|
#
|
2593
|
+
# * `FilterPolicyScope` – This attribute lets you choose the filtering
|
2594
|
+
# scope by using one of the following string value types:
|
2595
|
+
#
|
2596
|
+
# * `MessageAttributes` (default) – The filter is applied on the
|
2597
|
+
# message attributes.
|
2598
|
+
#
|
2599
|
+
# * `MessageBody` – The filter is applied on the message body.
|
2600
|
+
#
|
2896
2601
|
# * `RawMessageDelivery` – When set to `true`, enables raw message
|
2897
2602
|
# delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
|
2898
2603
|
# need for the endpoints to process JSON formatting, which is
|
@@ -3023,14 +2728,6 @@ module Aws::SNS
|
|
3023
2728
|
|
3024
2729
|
# The list of tags to be added to the specified topic.
|
3025
2730
|
#
|
3026
|
-
# @note When making an API call, you may pass Tag
|
3027
|
-
# data as a hash:
|
3028
|
-
#
|
3029
|
-
# {
|
3030
|
-
# key: "TagKey", # required
|
3031
|
-
# value: "TagValue", # required
|
3032
|
-
# }
|
3033
|
-
#
|
3034
2731
|
# @!attribute [rw] key
|
3035
2732
|
# The required key portion of the tag.
|
3036
2733
|
# @return [String]
|
@@ -3075,19 +2772,6 @@ module Aws::SNS
|
|
3075
2772
|
include Aws::Structure
|
3076
2773
|
end
|
3077
2774
|
|
3078
|
-
# @note When making an API call, you may pass TagResourceRequest
|
3079
|
-
# data as a hash:
|
3080
|
-
#
|
3081
|
-
# {
|
3082
|
-
# resource_arn: "AmazonResourceName", # required
|
3083
|
-
# tags: [ # required
|
3084
|
-
# {
|
3085
|
-
# key: "TagKey", # required
|
3086
|
-
# value: "TagValue", # required
|
3087
|
-
# },
|
3088
|
-
# ],
|
3089
|
-
# }
|
3090
|
-
#
|
3091
2775
|
# @!attribute [rw] resource_arn
|
3092
2776
|
# The ARN of the topic to which to add tags.
|
3093
2777
|
# @return [String]
|
@@ -3169,13 +2853,6 @@ module Aws::SNS
|
|
3169
2853
|
|
3170
2854
|
# Input for Unsubscribe action.
|
3171
2855
|
#
|
3172
|
-
# @note When making an API call, you may pass UnsubscribeInput
|
3173
|
-
# data as a hash:
|
3174
|
-
#
|
3175
|
-
# {
|
3176
|
-
# subscription_arn: "subscriptionARN", # required
|
3177
|
-
# }
|
3178
|
-
#
|
3179
2856
|
# @!attribute [rw] subscription_arn
|
3180
2857
|
# The ARN of the subscription to be deleted.
|
3181
2858
|
# @return [String]
|
@@ -3188,14 +2865,6 @@ module Aws::SNS
|
|
3188
2865
|
include Aws::Structure
|
3189
2866
|
end
|
3190
2867
|
|
3191
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
3192
|
-
# data as a hash:
|
3193
|
-
#
|
3194
|
-
# {
|
3195
|
-
# resource_arn: "AmazonResourceName", # required
|
3196
|
-
# tag_keys: ["TagKey"], # required
|
3197
|
-
# }
|
3198
|
-
#
|
3199
2868
|
# @!attribute [rw] resource_arn
|
3200
2869
|
# The ARN of the topic from which to remove tags.
|
3201
2870
|
# @return [String]
|
@@ -3263,14 +2932,6 @@ module Aws::SNS
|
|
3263
2932
|
include Aws::Structure
|
3264
2933
|
end
|
3265
2934
|
|
3266
|
-
# @note When making an API call, you may pass VerifySMSSandboxPhoneNumberInput
|
3267
|
-
# data as a hash:
|
3268
|
-
#
|
3269
|
-
# {
|
3270
|
-
# phone_number: "PhoneNumberString", # required
|
3271
|
-
# one_time_password: "OTPCode", # required
|
3272
|
-
# }
|
3273
|
-
#
|
3274
2935
|
# @!attribute [rw] phone_number
|
3275
2936
|
# The destination phone number to verify.
|
3276
2937
|
# @return [String]
|