aws-sdk-sns 1.55.0 → 1.60.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
372
+ # will vend X-Ray segment data to topic owner account if the sampled
373
+ # flag in the tracing header is true. This is only supported on
374
+ # standard 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,32 @@ 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 signature version corresponds to the
893
+ # hashing algorithm used while creating the signature of the
894
+ # notifications, subscription confirmations, or unsubscribe
895
+ # confirmation messages sent by Amazon SNS.
896
+ #
897
+ # * By default, `SignatureVersion` is set to **1**. The signature is
898
+ # a Base64-encoded **SHA1withRSA** signature.
899
+ #
900
+ # * When you set `SignatureVersion` to **2**. Amazon SNS uses a
901
+ # Base64-encoded **SHA256withRSA** signature.
902
+ #
903
+ # <note markdown="1"> If the API response does not include the `SignatureVersion`
904
+ # attribute, it means that the `SignatureVersion` for the topic
905
+ # has value **1**.
906
+ #
907
+ # </note>
908
+ #
1011
909
  # * `SubscriptionsConfirmed` – The number of confirmed subscriptions
1012
910
  # for the topic.
1013
911
  #
@@ -1019,8 +917,13 @@ module Aws::SNS
1019
917
  #
1020
918
  # * `TopicArn` – The topic's ARN.
1021
919
  #
1022
- # * `EffectiveDeliveryPolicy` – The JSON serialization of the
1023
- # effective delivery policy, taking system defaults into account.
920
+ # * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
921
+ # `TracingConfig` is set to `PassThrough`, and the topic passes
922
+ # through the tracing header it receives from an Amazon SNS
923
+ # publisher to its subscriptions. If set to `Active`, Amazon SNS
924
+ # will vend X-Ray segment data to topic owner account if the sampled
925
+ # flag in the tracing header is true. This is only supported on
926
+ # standard topics.
1024
927
  #
1025
928
  # The following attribute applies only to
1026
929
  # [server-side-encryption][1]\:
@@ -1238,14 +1141,6 @@ module Aws::SNS
1238
1141
 
1239
1142
  # Input for ListEndpointsByPlatformApplication action.
1240
1143
  #
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
1144
  # @!attribute [rw] platform_application_arn
1250
1145
  # PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
1251
1146
  # action.
@@ -1287,14 +1182,6 @@ module Aws::SNS
1287
1182
  include Aws::Structure
1288
1183
  end
1289
1184
 
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
1185
  # @!attribute [rw] next_token
1299
1186
  # Token that the previous `ListOriginationNumbers` request returns.
1300
1187
  # @return [String]
@@ -1334,13 +1221,6 @@ module Aws::SNS
1334
1221
 
1335
1222
  # The input for the `ListPhoneNumbersOptedOut` action.
1336
1223
  #
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
1224
  # @!attribute [rw] next_token
1345
1225
  # A `NextToken` string is used when you call the
1346
1226
  # `ListPhoneNumbersOptedOut` action to retrieve additional records
@@ -1380,13 +1260,6 @@ module Aws::SNS
1380
1260
 
1381
1261
  # Input for ListPlatformApplications action.
1382
1262
  #
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
1263
  # @!attribute [rw] next_token
1391
1264
  # NextToken string is used when calling ListPlatformApplications
1392
1265
  # action to retrieve additional records that are available after the
@@ -1423,14 +1296,6 @@ module Aws::SNS
1423
1296
  include Aws::Structure
1424
1297
  end
1425
1298
 
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
1299
  # @!attribute [rw] next_token
1435
1300
  # Token that the previous `ListSMSSandboxPhoneNumbersInput` request
1436
1301
  # returns.
@@ -1470,14 +1335,6 @@ module Aws::SNS
1470
1335
 
1471
1336
  # Input for ListSubscriptionsByTopic action.
1472
1337
  #
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
1338
  # @!attribute [rw] topic_arn
1482
1339
  # The ARN of the topic for which you wish to find subscriptions.
1483
1340
  # @return [String]
@@ -1518,13 +1375,6 @@ module Aws::SNS
1518
1375
 
1519
1376
  # Input for ListSubscriptions action.
1520
1377
  #
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
1378
  # @!attribute [rw] next_token
1529
1379
  # Token returned by the previous `ListSubscriptions` request.
1530
1380
  # @return [String]
@@ -1557,13 +1407,6 @@ module Aws::SNS
1557
1407
  include Aws::Structure
1558
1408
  end
1559
1409
 
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
1410
  # @!attribute [rw] resource_arn
1568
1411
  # The ARN of the topic for which to list tags.
1569
1412
  # @return [String]
@@ -1588,13 +1431,6 @@ module Aws::SNS
1588
1431
  include Aws::Structure
1589
1432
  end
1590
1433
 
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
1434
  # @!attribute [rw] next_token
1599
1435
  # Token returned by the previous `ListTopics` request.
1600
1436
  # @return [String]
@@ -1644,15 +1480,6 @@ module Aws::SNS
1644
1480
  # [2]: https://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
1645
1481
  # [3]: https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html
1646
1482
  #
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
1483
  # @!attribute [rw] data_type
1657
1484
  # Amazon SNS supports the following logical data types: String,
1658
1485
  # String.Array, Number, and Binary. For more information, see [Message
@@ -1702,13 +1529,6 @@ module Aws::SNS
1702
1529
 
1703
1530
  # Input for the OptInPhoneNumber action.
1704
1531
  #
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
1532
  # @!attribute [rw] phone_number
1713
1533
  # The phone number to opt in. Use E.164 format.
1714
1534
  # @return [String]
@@ -1815,30 +1635,6 @@ module Aws::SNS
1815
1635
  include Aws::Structure
1816
1636
  end
1817
1637
 
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
1638
  # @!attribute [rw] topic_arn
1843
1639
  # The Amazon resource name (ARN) of the topic you want to batch
1844
1640
  # publish to.
@@ -1861,25 +1657,6 @@ module Aws::SNS
1861
1657
  # Contains the details of a single Amazon SNS message along with an `Id`
1862
1658
  # that identifies a message within the batch.
1863
1659
  #
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
1660
  # @!attribute [rw] id
1884
1661
  # An identifier for the message in this batch.
1885
1662
  #
@@ -2071,27 +1848,6 @@ module Aws::SNS
2071
1848
 
2072
1849
  # Input for Publish action.
2073
1850
  #
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
1851
  # @!attribute [rw] topic_arn
2096
1852
  # The topic you want to publish to.
2097
1853
  #
@@ -2277,14 +2033,6 @@ module Aws::SNS
2277
2033
  include Aws::Structure
2278
2034
  end
2279
2035
 
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
2036
  # @!attribute [rw] resource_arn
2289
2037
  # The ARN of the topic whose `DataProtectionPolicy` you want to add or
2290
2038
  # update.
@@ -2316,14 +2064,6 @@ module Aws::SNS
2316
2064
 
2317
2065
  # Input for RemovePermission action.
2318
2066
  #
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
2067
  # @!attribute [rw] topic_arn
2328
2068
  # The ARN of the topic whose access control policy you wish to modify.
2329
2069
  # @return [String]
@@ -2390,16 +2130,6 @@ module Aws::SNS
2390
2130
 
2391
2131
  # Input for SetEndpointAttributes action.
2392
2132
  #
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
2133
  # @!attribute [rw] endpoint_arn
2404
2134
  # EndpointArn used for SetEndpointAttributes action.
2405
2135
  # @return [String]
@@ -2434,16 +2164,6 @@ module Aws::SNS
2434
2164
 
2435
2165
  # Input for SetPlatformApplicationAttributes action.
2436
2166
  #
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
2167
  # @!attribute [rw] platform_application_arn
2448
2168
  # PlatformApplicationArn for SetPlatformApplicationAttributes action.
2449
2169
  # @return [String]
@@ -2525,15 +2245,6 @@ module Aws::SNS
2525
2245
 
2526
2246
  # The input for the SetSMSAttributes action.
2527
2247
  #
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
2248
  # @!attribute [rw] attributes
2538
2249
  # The default settings for sending SMS messages from your Amazon Web
2539
2250
  # Services account. You can set values for the following attribute
@@ -2636,15 +2347,6 @@ module Aws::SNS
2636
2347
 
2637
2348
  # Input for SetSubscriptionAttributes action.
2638
2349
  #
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
2350
  # @!attribute [rw] subscription_arn
2649
2351
  # The ARN of the subscription to modify.
2650
2352
  # @return [String]
@@ -2662,6 +2364,14 @@ module Aws::SNS
2662
2364
  # receive only a subset of messages, rather than receiving every
2663
2365
  # message published to the topic.
2664
2366
  #
2367
+ # * `FilterPolicyScope` – This attribute lets you choose the filtering
2368
+ # scope by using one of the following string value types:
2369
+ #
2370
+ # * `MessageAttributes` (default) – The filter is applied on the
2371
+ # message attributes.
2372
+ #
2373
+ # * `MessageBody` – The filter is applied on the message body.
2374
+ #
2665
2375
  # * `RawMessageDelivery` – When set to `true`, enables raw message
2666
2376
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2667
2377
  # need for the endpoints to process JSON formatting, which is
@@ -2711,15 +2421,6 @@ module Aws::SNS
2711
2421
 
2712
2422
  # Input for SetTopicAttributes action.
2713
2423
  #
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
2424
  # @!attribute [rw] topic_arn
2724
2425
  # The ARN of the topic to modify.
2725
2426
  # @return [String]
@@ -2731,6 +2432,10 @@ module Aws::SNS
2731
2432
  # special request parameters that the `SetTopicAttributes` action
2732
2433
  # uses:
2733
2434
  #
2435
+ # * `ApplicationSuccessFeedbackRoleArn` – Indicates failed message
2436
+ # delivery status for an Amazon SNS topic that is subscribed to a
2437
+ # platform application endpoint.
2438
+ #
2734
2439
  # * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
2735
2440
  # failed deliveries to HTTP/S endpoints.
2736
2441
  #
@@ -2741,17 +2446,121 @@ module Aws::SNS
2741
2446
  # default, only the topic owner can publish or subscribe to the
2742
2447
  # topic.
2743
2448
  #
2449
+ # * `TracingConfig` – Tracing mode of an Amazon SNS topic. By default
2450
+ # `TracingConfig` is set to `PassThrough`, and the topic passes
2451
+ # through the tracing header it receives from an Amazon SNS
2452
+ # publisher to its subscriptions. If set to `Active`, Amazon SNS
2453
+ # will vend X-Ray segment data to topic owner account if the sampled
2454
+ # flag in the tracing header is true. This is only supported on
2455
+ # standard topics.
2456
+ #
2457
+ # * HTTP
2458
+ #
2459
+ # * `HTTPSuccessFeedbackRoleArn` – Indicates successful message
2460
+ # delivery status for an Amazon SNS topic that is subscribed to an
2461
+ # HTTP endpoint.
2462
+ #
2463
+ # * `HTTPSuccessFeedbackSampleRate` – Indicates percentage of
2464
+ # successful messages to sample for an Amazon SNS topic that is
2465
+ # subscribed to an HTTP endpoint.
2466
+ #
2467
+ # * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
2468
+ # status for an Amazon SNS topic that is subscribed to an HTTP
2469
+ # endpoint.
2470
+ #
2471
+ # * Amazon Kinesis Data Firehose
2472
+ #
2473
+ # * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
2474
+ # delivery status for an Amazon SNS topic that is subscribed to an
2475
+ # Amazon Kinesis Data Firehose endpoint.
2476
+ #
2477
+ # * `FirehoseSuccessFeedbackSampleRate` – Indicates percentage of
2478
+ # successful messages to sample for an Amazon SNS topic that is
2479
+ # subscribed to an Amazon Kinesis Data Firehose endpoint.
2480
+ #
2481
+ # * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
2482
+ # delivery status for an Amazon SNS topic that is subscribed to an
2483
+ # Amazon Kinesis Data Firehose endpoint.
2484
+ #
2485
+ # * Lambda
2486
+ #
2487
+ # * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
2488
+ # delivery status for an Amazon SNS topic that is subscribed to an
2489
+ # Lambda endpoint.
2490
+ #
2491
+ # * `LambdaSuccessFeedbackSampleRate` – Indicates percentage of
2492
+ # successful messages to sample for an Amazon SNS topic that is
2493
+ # subscribed to an Lambda endpoint.
2494
+ #
2495
+ # * `LambdaFailureFeedbackRoleArn` – Indicates failed message
2496
+ # delivery status for an Amazon SNS topic that is subscribed to an
2497
+ # Lambda endpoint.
2498
+ #
2499
+ # * Platform application endpoint
2500
+ #
2501
+ # * `ApplicationSuccessFeedbackRoleArn` – Indicates successful
2502
+ # message delivery status for an Amazon SNS topic that is
2503
+ # subscribed to an Amazon Web Services application endpoint.
2504
+ #
2505
+ # * `ApplicationSuccessFeedbackSampleRate` – Indicates percentage of
2506
+ # successful messages to sample for an Amazon SNS topic that is
2507
+ # subscribed to an Amazon Web Services application endpoint.
2508
+ #
2509
+ # * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
2510
+ # delivery status for an Amazon SNS topic that is subscribed to an
2511
+ # Amazon Web Services application endpoint.
2512
+ #
2513
+ # <note markdown="1"> In addition to being able to configure topic attributes for
2514
+ # message delivery status of notification messages sent to Amazon
2515
+ # SNS application endpoints, you can also configure application
2516
+ # attributes for the delivery status of push notification messages
2517
+ # sent to push notification services.
2518
+ #
2519
+ # For example, For more information, see [Using Amazon SNS
2520
+ # Application Attributes for Message Delivery Status][1].
2521
+ #
2522
+ # </note>
2523
+ #
2524
+ # * Amazon SQS
2525
+ #
2526
+ # * `SQSSuccessFeedbackRoleArn` – Indicates successful message
2527
+ # delivery status for an Amazon SNS topic that is subscribed to an
2528
+ # Amazon SQS endpoint.
2529
+ #
2530
+ # * `SQSSuccessFeedbackSampleRate` – Indicates percentage of
2531
+ # successful messages to sample for an Amazon SNS topic that is
2532
+ # subscribed to an Amazon SQS endpoint.
2533
+ #
2534
+ # * `SQSFailureFeedbackRoleArn` – Indicates failed message delivery
2535
+ # status for an Amazon SNS topic that is subscribed to an Amazon
2536
+ # SQS endpoint.
2537
+ #
2538
+ # <note markdown="1"> The &lt;ENDPOINT&gt;SuccessFeedbackRoleArn and
2539
+ # &lt;ENDPOINT&gt;FailureFeedbackRoleArn attributes are used to give
2540
+ # Amazon SNS write access to use CloudWatch Logs on your behalf. The
2541
+ # &lt;ENDPOINT&gt;SuccessFeedbackSampleRate attribute is for
2542
+ # specifying the sample rate percentage (0-100) of successfully
2543
+ # delivered messages. After you configure the
2544
+ # &lt;ENDPOINT&gt;FailureFeedbackRoleArn attribute, then all failed
2545
+ # message deliveries generate CloudWatch Logs.
2546
+ #
2547
+ # </note>
2548
+ #
2744
2549
  # The following attribute applies only to
2745
- # [server-side-encryption][1]\:
2550
+ # [server-side-encryption][2]\:
2746
2551
  #
2747
2552
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
2748
2553
  # customer master key (CMK) for Amazon SNS or a custom CMK. For more
2749
- # information, see [Key Terms][2]. For more examples, see [KeyId][3]
2554
+ # information, see [Key Terms][3]. For more examples, see [KeyId][4]
2750
2555
  # in the *Key Management Service API Reference*.
2751
2556
  #
2752
- # ^
2557
+ # * `SignatureVersion` – The signature version corresponds to the
2558
+ # hashing algorithm used while creating the signature of the
2559
+ # notifications, subscription confirmations, or unsubscribe
2560
+ # confirmation messages sent by Amazon SNS. By default,
2561
+ # `SignatureVersion` is set to `1`.
2753
2562
  #
2754
- # The following attribute applies only to [FIFO topics][4]\:
2563
+ # The following attribute applies only to [FIFO topics][5]\:
2755
2564
  #
2756
2565
  # * `ContentBasedDeduplication` – Enables content-based deduplication
2757
2566
  # for FIFO topics.
@@ -2759,7 +2568,7 @@ module Aws::SNS
2759
2568
  # * By default, `ContentBasedDeduplication` is set to `false`. If
2760
2569
  # you create a FIFO topic and this attribute is `false`, you must
2761
2570
  # specify a value for the `MessageDeduplicationId` parameter for
2762
- # the [Publish][5] action.
2571
+ # the [Publish][6] action.
2763
2572
  #
2764
2573
  # * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
2765
2574
  # uses a SHA-256 hash to generate the `MessageDeduplicationId`
@@ -2772,11 +2581,12 @@ module Aws::SNS
2772
2581
  #
2773
2582
  #
2774
2583
  #
2775
- # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
2776
- # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
2777
- # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
2778
- # [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
2779
- # [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
2584
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
2585
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
2586
+ # [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
2587
+ # [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
2588
+ # [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
2589
+ # [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
2780
2590
  # @return [String]
2781
2591
  #
2782
2592
  # @!attribute [rw] attribute_value
@@ -2809,19 +2619,6 @@ module Aws::SNS
2809
2619
 
2810
2620
  # Input for Subscribe action.
2811
2621
  #
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
2622
  # @!attribute [rw] topic_arn
2826
2623
  # The ARN of the topic you want to subscribe to.
2827
2624
  # @return [String]
@@ -2893,6 +2690,14 @@ module Aws::SNS
2893
2690
  # receive only a subset of messages, rather than receiving every
2894
2691
  # message published to the topic.
2895
2692
  #
2693
+ # * `FilterPolicyScope` – This attribute lets you choose the filtering
2694
+ # scope by using one of the following string value types:
2695
+ #
2696
+ # * `MessageAttributes` (default) – The filter is applied on the
2697
+ # message attributes.
2698
+ #
2699
+ # * `MessageBody` – The filter is applied on the message body.
2700
+ #
2896
2701
  # * `RawMessageDelivery` – When set to `true`, enables raw message
2897
2702
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
2898
2703
  # need for the endpoints to process JSON formatting, which is
@@ -3023,14 +2828,6 @@ module Aws::SNS
3023
2828
 
3024
2829
  # The list of tags to be added to the specified topic.
3025
2830
  #
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
2831
  # @!attribute [rw] key
3035
2832
  # The required key portion of the tag.
3036
2833
  # @return [String]
@@ -3075,19 +2872,6 @@ module Aws::SNS
3075
2872
  include Aws::Structure
3076
2873
  end
3077
2874
 
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
2875
  # @!attribute [rw] resource_arn
3092
2876
  # The ARN of the topic to which to add tags.
3093
2877
  # @return [String]
@@ -3169,13 +2953,6 @@ module Aws::SNS
3169
2953
 
3170
2954
  # Input for Unsubscribe action.
3171
2955
  #
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
2956
  # @!attribute [rw] subscription_arn
3180
2957
  # The ARN of the subscription to be deleted.
3181
2958
  # @return [String]
@@ -3188,14 +2965,6 @@ module Aws::SNS
3188
2965
  include Aws::Structure
3189
2966
  end
3190
2967
 
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
2968
  # @!attribute [rw] resource_arn
3200
2969
  # The ARN of the topic from which to remove tags.
3201
2970
  # @return [String]
@@ -3263,14 +3032,6 @@ module Aws::SNS
3263
3032
  include Aws::Structure
3264
3033
  end
3265
3034
 
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
3035
  # @!attribute [rw] phone_number
3275
3036
  # The destination phone number to verify.
3276
3037
  # @return [String]