aws-sdk-sns 1.20.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6d539f4d965d04cd205768922cd1d01135f398b8
4
- data.tar.gz: 926b0559a6ad58d57fb633142d3aebe815ef0d18
3
+ metadata.gz: 541eb2adf00510177c2300c5afb1648418676703
4
+ data.tar.gz: 73117df68dd3cbf7118e0b6da2d365f0f6f43d41
5
5
  SHA512:
6
- metadata.gz: 92f9bbb2fa5236e75709fc85036134ec075949c817262bc76866af8ff732e91aacb86a85cc7eb81c167e685a8b6d9438376f5b1c7e4efd5536b74b550f2c98de
7
- data.tar.gz: e92f654b6108b6f4f407c5e7157d30a3ad137da139ff1834f80c8057eb6e34d6996822a93a930e887af150175b7922c1c6bb22c40bc97b13ad3af4cc1bebe0e3
6
+ metadata.gz: 800b75598c1cef889268fd2e1076b4f479af38b209b03830c18f600a06c78c11f36c2f126d8c7f18c6ab38b6843a245188b5dd95888ae46384ef6b32fe59d8d4
7
+ data.tar.gz: 3b202f06d57f96536c0c84ba6562e2af0b139e73fd9ca571ccac85bb257ed1c16aba482639ec3188bfb9c6c600c5d77f8e79dbeba43147ad23c0c37336067a44
@@ -46,6 +46,6 @@ require_relative 'aws-sdk-sns/customizations'
46
46
  # @service
47
47
  module Aws::SNS
48
48
 
49
- GEM_VERSION = '1.20.0'
49
+ GEM_VERSION = '1.21.0'
50
50
 
51
51
  end
@@ -271,7 +271,7 @@ module Aws::SNS
271
271
  # @option params [required, Array<String>] :action_name
272
272
  # The action you want to allow for the specified principal(s).
273
273
  #
274
- # Valid values: any Amazon SNS action name.
274
+ # Valid values: Any Amazon SNS action name, for example `Publish`.
275
275
  #
276
276
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
277
277
  #
@@ -376,7 +376,7 @@ module Aws::SNS
376
376
  # PlatformCredential attributes when using the
377
377
  # `CreatePlatformApplication` action. The PlatformPrincipal is received
378
378
  # from the notification service. For APNS/APNS\_SANDBOX,
379
- # PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal
379
+ # PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal
380
380
  # is not applicable. For ADM, PlatformPrincipal is "client id". The
381
381
  # PlatformCredential is also received from the notification service. For
382
382
  # WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
@@ -384,30 +384,12 @@ module Aws::SNS
384
384
  # is "API key".
385
385
  #
386
386
  # For APNS/APNS\_SANDBOX, PlatformCredential is "private key". For
387
- # GCM, PlatformCredential is "API key". For ADM, PlatformCredential is
387
+ # FCM, PlatformCredential is "API key". For ADM, PlatformCredential is
388
388
  # "client secret". For WNS, PlatformCredential is "secret key". For
389
389
  # MPNS, PlatformCredential is "private key". For Baidu,
390
390
  # PlatformCredential is "secret key". The PlatformApplicationArn that
391
391
  # is returned when using `CreatePlatformApplication` is then used as an
392
- # attribute for the `CreatePlatformEndpoint` action. For more
393
- # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
394
- # more information about obtaining the PlatformPrincipal and
395
- # PlatformCredential for each of the supported push notification
396
- # services, see [Getting Started with Apple Push Notification
397
- # Service][2], [Getting Started with Amazon Device Messaging][3],
398
- # [Getting Started with Baidu Cloud Push][4], [Getting Started with
399
- # Google Cloud Messaging for Android][5], [Getting Started with
400
- # MPNS][6], or [Getting Started with WNS][7].
401
- #
402
- #
403
- #
404
- # [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
405
- # [2]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-apns.html
406
- # [3]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-adm.html
407
- # [4]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-baidu.html
408
- # [5]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-gcm.html
409
- # [6]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-mpns.html
410
- # [7]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-wns.html
392
+ # attribute for the `CreatePlatformEndpoint` action.
411
393
  #
412
394
  # @option params [required, String] :name
413
395
  # Application names must be made up of only uppercase and lowercase
@@ -416,8 +398,8 @@ module Aws::SNS
416
398
  #
417
399
  # @option params [required, String] :platform
418
400
  # The following platforms are supported: ADM (Amazon Device Messaging),
419
- # APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
420
- # Cloud Messaging).
401
+ # APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
402
+ # (Firebase Cloud Messaging).
421
403
  #
422
404
  # @option params [required, Hash<String,String>] :attributes
423
405
  # For a list of attributes, see [SetPlatformApplicationAttributes][1]
@@ -454,7 +436,7 @@ module Aws::SNS
454
436
  end
455
437
 
456
438
  # Creates an endpoint for a device and mobile app on one of the
457
- # supported push notification services, such as GCM and APNS.
439
+ # supported push notification services, such as FCM and APNS.
458
440
  # `CreatePlatformEndpoint` requires the PlatformApplicationArn that is
459
441
  # returned from `CreatePlatformApplication`. The EndpointArn that is
460
442
  # returned when using `CreatePlatformEndpoint` can then be used by the
@@ -484,7 +466,7 @@ module Aws::SNS
484
466
  # device. The specific name for Token will vary, depending on which
485
467
  # notification service is being used. For example, when using APNS as
486
468
  # the notification service, you need the device token. Alternatively,
487
- # when using GCM or ADM, the device token equivalent is called the
469
+ # when using FCM or ADM, the device token equivalent is called the
488
470
  # registration ID.
489
471
  #
490
472
  # @option params [String] :custom_user_data
@@ -576,6 +558,11 @@ module Aws::SNS
576
558
  # @option params [Array<Types::Tag>] :tags
577
559
  # The list of tags to add to a new topic.
578
560
  #
561
+ # <note markdown="1"> To be able to tag a topic on creation, you must have the
562
+ # `sns:CreateTopic` and `sns:TagResource` permissions.
563
+ #
564
+ # </note>
565
+ #
579
566
  # @return [Types::CreateTopicResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
580
567
  #
581
568
  # * {Types::CreateTopicResponse#topic_arn #topic_arn} => String
@@ -640,7 +627,7 @@ module Aws::SNS
640
627
  end
641
628
 
642
629
  # Deletes a platform application object for one of the supported push
643
- # notification services, such as APNS and GCM. For more information, see
630
+ # notification services, such as APNS and FCM. For more information, see
644
631
  # [Using Amazon SNS Mobile Push Notifications][1].
645
632
  #
646
633
  #
@@ -693,7 +680,7 @@ module Aws::SNS
693
680
  end
694
681
 
695
682
  # Retrieves the endpoint attributes for a device on one of the supported
696
- # push notification services, such as GCM and APNS. For more
683
+ # push notification services, such as FCM and APNS. For more
697
684
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
698
685
  #
699
686
  #
@@ -728,7 +715,7 @@ module Aws::SNS
728
715
  end
729
716
 
730
717
  # Retrieves the attributes of the platform application object for the
731
- # supported push notification services, such as APNS and GCM. For more
718
+ # supported push notification services, such as APNS and FCM. For more
732
719
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
733
720
  #
734
721
  #
@@ -863,7 +850,7 @@ module Aws::SNS
863
850
  end
864
851
 
865
852
  # Lists the endpoints and endpoint attributes for devices in a supported
866
- # push notification service, such as GCM and APNS. The results for
853
+ # push notification service, such as FCM and APNS. The results for
867
854
  # `ListEndpointsByPlatformApplication` are paginated and return a
868
855
  # limited list of endpoints, up to 100. If additional records are
869
856
  # available after the first page results, then a NextToken string will
@@ -960,7 +947,7 @@ module Aws::SNS
960
947
  end
961
948
 
962
949
  # Lists the platform application objects for the supported push
963
- # notification services, such as APNS and GCM. The results for
950
+ # notification services, such as APNS and FCM. The results for
964
951
  # `ListPlatformApplications` are paginated and return a limited list of
965
952
  # applications, up to 100. If additional records are available after the
966
953
  # first page results, then a NextToken string will be returned. To
@@ -1234,10 +1221,6 @@ module Aws::SNS
1234
1221
  # @option params [required, String] :message
1235
1222
  # The message you want to send.
1236
1223
  #
1237
- # The `Message` parameter is always a string. If you set
1238
- # `MessageStructure` to `json`, you must string-encode the `Message`
1239
- # parameter.
1240
- #
1241
1224
  # If you are publishing to a topic and you want to send the same message
1242
1225
  # to all transport protocols, include the text of the message as a
1243
1226
  # String value. If you want to send different messages for each
@@ -1315,17 +1298,8 @@ module Aws::SNS
1315
1298
  # You can define other top-level keys that define the message you want
1316
1299
  # to send to a specific transport protocol (e.g., "http").
1317
1300
  #
1318
- # For information about sending different messages for each protocol
1319
- # using the AWS Management Console, go to [Create Different Messages for
1320
- # Each Protocol][1] in the *Amazon Simple Notification Service Getting
1321
- # Started Guide*.
1322
- #
1323
1301
  # Valid value: `json`
1324
1302
  #
1325
- #
1326
- #
1327
- # [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
1328
- #
1329
1303
  # @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
1330
1304
  # Message attributes for Publish action.
1331
1305
  #
@@ -1391,7 +1365,7 @@ module Aws::SNS
1391
1365
  end
1392
1366
 
1393
1367
  # Sets the attributes for an endpoint for a device on one of the
1394
- # supported push notification services, such as GCM and APNS. For more
1368
+ # supported push notification services, such as FCM and APNS. For more
1395
1369
  # information, see [Using Amazon SNS Mobile Push Notifications][1].
1396
1370
  #
1397
1371
  #
@@ -1440,7 +1414,7 @@ module Aws::SNS
1440
1414
  end
1441
1415
 
1442
1416
  # Sets the attributes of the platform application object for the
1443
- # supported push notification services, such as APNS and GCM. For more
1417
+ # supported push notification services, such as APNS and FCM. For more
1444
1418
  # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
1445
1419
  # information on configuring attributes for message delivery status, see
1446
1420
  # [Using Amazon SNS Application Attributes for Message Delivery
@@ -1460,12 +1434,12 @@ module Aws::SNS
1460
1434
  #
1461
1435
  # * `PlatformCredential` – The credential received from the notification
1462
1436
  # service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
1463
- # For GCM, PlatformCredential is "API key". For ADM,
1437
+ # For FCM, PlatformCredential is "API key". For ADM,
1464
1438
  # PlatformCredential is "client secret".
1465
1439
  #
1466
1440
  # * `PlatformPrincipal` – The principal received from the notification
1467
1441
  # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
1468
- # certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
1442
+ # certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
1469
1443
  # PlatformPrincipal is "client id".
1470
1444
  #
1471
1445
  # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
@@ -1649,6 +1623,13 @@ module Aws::SNS
1649
1623
  # for the endpoints to process JSON formatting, which is otherwise
1650
1624
  # created for Amazon SNS metadata.
1651
1625
  #
1626
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1627
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
1628
+ # delivered due to client errors (for example, when the subscribed
1629
+ # endpoint is unreachable) or server errors (for example, when the
1630
+ # service that powers the subscribed endpoint becomes unavailable) are
1631
+ # held in the dead-letter queue for further analysis or reprocessing.
1632
+ #
1652
1633
  # @option params [String] :attribute_value
1653
1634
  # The new value for the attribute in JSON format.
1654
1635
  #
@@ -1757,7 +1738,7 @@ module Aws::SNS
1757
1738
  # * `application` – delivery of JSON-encoded message to an EndpointArn
1758
1739
  # for a mobile app and device.
1759
1740
  #
1760
- # * `lambda` – delivery of JSON-encoded message to an AWS Lambda
1741
+ # * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
1761
1742
  # function.
1762
1743
  #
1763
1744
  # @option params [String] :endpoint
@@ -1765,10 +1746,10 @@ module Aws::SNS
1765
1746
  # protocol:
1766
1747
  #
1767
1748
  # * For the `http` protocol, the endpoint is an URL beginning with
1768
- # "https://"
1749
+ # `http://`
1769
1750
  #
1770
1751
  # * For the `https` protocol, the endpoint is a URL beginning with
1771
- # "https://"
1752
+ # `https://`
1772
1753
  #
1773
1754
  # * For the `email` protocol, the endpoint is an email address
1774
1755
  #
@@ -1783,8 +1764,8 @@ module Aws::SNS
1783
1764
  # * For the `application` protocol, the endpoint is the EndpointArn of a
1784
1765
  # mobile app and device.
1785
1766
  #
1786
- # * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
1787
- # function.
1767
+ # * For the `lambda` protocol, the endpoint is the ARN of an Amazon
1768
+ # Lambda function.
1788
1769
  #
1789
1770
  # @option params [Hash<String,String>] :attributes
1790
1771
  # A map of attributes with their corresponding values.
@@ -1804,18 +1785,27 @@ module Aws::SNS
1804
1785
  # for the endpoints to process JSON formatting, which is otherwise
1805
1786
  # created for Amazon SNS metadata.
1806
1787
  #
1788
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1789
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
1790
+ # delivered due to client errors (for example, when the subscribed
1791
+ # endpoint is unreachable) or server errors (for example, when the
1792
+ # service that powers the subscribed endpoint becomes unavailable) are
1793
+ # held in the dead-letter queue for further analysis or reprocessing.
1794
+ #
1807
1795
  # @option params [Boolean] :return_subscription_arn
1808
1796
  # Sets whether the response from the `Subscribe` request includes the
1809
1797
  # subscription ARN, even if the subscription is not yet confirmed.
1810
1798
  #
1811
- # If you set this parameter to `false`, the response includes the ARN
1812
- # for confirmed subscriptions, but it includes an ARN value of "pending
1813
- # subscription" for subscriptions that are not yet confirmed. A
1814
- # subscription becomes confirmed when the subscriber calls the
1815
- # `ConfirmSubscription` action with a confirmation token.
1799
+ # * If you have the subscription ARN returned, the response includes the
1800
+ # ARN in all cases, even if the subscription is not yet confirmed.
1816
1801
  #
1817
- # If you set this parameter to `true`, the response includes the ARN in
1818
- # all cases, even if the subscription is not yet confirmed.
1802
+ # * If you don't have the subscription ARN returned, in addition to the
1803
+ # ARN for confirmed subscriptions, the response also includes the
1804
+ # `pending subscription` ARN value for subscriptions that aren't yet
1805
+ # confirmed. A subscription becomes confirmed when the subscriber
1806
+ # calls the `ConfirmSubscription` action with a confirmation token.
1807
+ #
1808
+ # If you set this parameter to `true`, .
1819
1809
  #
1820
1810
  # The default value is `false`.
1821
1811
  #
@@ -1863,18 +1853,14 @@ module Aws::SNS
1863
1853
  # * A new tag with a key identical to that of an existing tag overwrites
1864
1854
  # the existing tag.
1865
1855
  #
1866
- # * Tagging actions are limited to 10 TPS per AWS account. If your
1867
- # application requires a higher throughput, file a [technical support
1868
- # request][2].
1869
- #
1870
- # For a full list of tag restrictions, see [Limits Related to Topics][3]
1871
- # in the *Amazon SNS Developer Guide*.
1856
+ # * Tagging actions are limited to 10 TPS per AWS account, per AWS
1857
+ # region. If your application requires a higher throughput, file a
1858
+ # [technical support request][2].
1872
1859
  #
1873
1860
  #
1874
1861
  #
1875
1862
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html
1876
1863
  # [2]: https://console.aws.amazon.com/support/home#/case/create?issueType=technical
1877
- # [3]: https://docs.aws.amazon.com/sns/latest/dg/sns-limits.html#limits-topics
1878
1864
  #
1879
1865
  # @option params [required, String] :resource_arn
1880
1866
  # The ARN of the topic to which to add tags.
@@ -1980,7 +1966,7 @@ module Aws::SNS
1980
1966
  params: params,
1981
1967
  config: config)
1982
1968
  context[:gem_name] = 'aws-sdk-sns'
1983
- context[:gem_version] = '1.20.0'
1969
+ context[:gem_version] = '1.21.0'
1984
1970
  Seahorse::Client::Request.new(handlers, context)
1985
1971
  end
1986
1972
 
@@ -101,7 +101,7 @@ module Aws::SNS
101
101
  # device. The specific name for Token will vary, depending on which
102
102
  # notification service is being used. For example, when using APNS as
103
103
  # the notification service, you need the device token. Alternatively,
104
- # when using GCM or ADM, the device token equivalent is called the
104
+ # when using FCM or ADM, the device token equivalent is called the
105
105
  # registration ID.
106
106
  # @option options [String] :custom_user_data
107
107
  # Arbitrary user data to associate with the endpoint. Amazon SNS does
@@ -147,12 +147,12 @@ module Aws::SNS
147
147
  #
148
148
  # * `PlatformCredential` – The credential received from the notification
149
149
  # service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
150
- # For GCM, PlatformCredential is "API key". For ADM,
150
+ # For FCM, PlatformCredential is "API key". For ADM,
151
151
  # PlatformCredential is "client secret".
152
152
  #
153
153
  # * `PlatformPrincipal` – The principal received from the notification
154
154
  # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
155
- # certificate. For GCM, PlatformPrincipal is not applicable. For ADM,
155
+ # certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
156
156
  # PlatformPrincipal is "client id".
157
157
  #
158
158
  # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
@@ -45,6 +45,10 @@ module Aws::SNS
45
45
  # an app and mobile device. This is returned from the notification
46
46
  # service when an app and mobile device are registered with the
47
47
  # notification service.
48
+ #
49
+ # <note markdown="1"> The device token for the iOS platform is returned in lowercase.
50
+ #
51
+ # </note>
48
52
  # @return [Hash<String,String>]
49
53
  def attributes
50
54
  data[:attributes]
@@ -129,10 +133,6 @@ module Aws::SNS
129
133
  # @option options [required, String] :message
130
134
  # The message you want to send.
131
135
  #
132
- # The `Message` parameter is always a string. If you set
133
- # `MessageStructure` to `json`, you must string-encode the `Message`
134
- # parameter.
135
- #
136
136
  # If you are publishing to a topic and you want to send the same message
137
137
  # to all transport protocols, include the text of the message as a
138
138
  # String value. If you want to send different messages for each
@@ -208,16 +208,7 @@ module Aws::SNS
208
208
  # You can define other top-level keys that define the message you want
209
209
  # to send to a specific transport protocol (e.g., "http").
210
210
  #
211
- # For information about sending different messages for each protocol
212
- # using the AWS Management Console, go to [Create Different Messages for
213
- # Each Protocol][1] in the *Amazon Simple Notification Service Getting
214
- # Started Guide*.
215
- #
216
211
  # Valid value: `json`
217
- #
218
- #
219
- #
220
- # [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
221
212
  # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
222
213
  # Message attributes for Publish action.
223
214
  # @return [Types::PublishResponse]
@@ -37,8 +37,8 @@ module Aws::SNS
37
37
  # between 1 and 256 characters long.
38
38
  # @option options [required, String] :platform
39
39
  # The following platforms are supported: ADM (Amazon Device Messaging),
40
- # APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
41
- # Cloud Messaging).
40
+ # APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
41
+ # (Firebase Cloud Messaging).
42
42
  # @option options [required, Hash<String,String>] :attributes
43
43
  # For a list of attributes, see [SetPlatformApplicationAttributes][1]
44
44
  #
@@ -106,6 +106,11 @@ module Aws::SNS
106
106
  # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
107
107
  # @option options [Array<Types::Tag>] :tags
108
108
  # The list of tags to add to a new topic.
109
+ #
110
+ # <note markdown="1"> To be able to tag a topic on creation, you must have the
111
+ # `sns:CreateTopic` and `sns:TagResource` permissions.
112
+ #
113
+ # </note>
109
114
  # @return [Topic]
110
115
  def create_topic(options = {})
111
116
  resp = @client.create_topic(options)
@@ -56,6 +56,13 @@ module Aws::SNS
56
56
  # the subscription. Raw messages are free of JSON formatting and can
57
57
  # be sent to HTTP/S and Amazon SQS endpoints.
58
58
  #
59
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
60
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
61
+ # delivered due to client errors (for example, when the subscribed
62
+ # endpoint is unreachable) or server errors (for example, when the
63
+ # service that powers the subscribed endpoint becomes unavailable) are
64
+ # held in the dead-letter queue for further analysis or reprocessing.
65
+ #
59
66
  # * `SubscriptionArn` – The subscription's ARN.
60
67
  #
61
68
  # * `TopicArn` – The topic ARN that the subscription is associated with.
@@ -136,6 +143,13 @@ module Aws::SNS
136
143
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
137
144
  # for the endpoints to process JSON formatting, which is otherwise
138
145
  # created for Amazon SNS metadata.
146
+ #
147
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
148
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
149
+ # delivered due to client errors (for example, when the subscribed
150
+ # endpoint is unreachable) or server errors (for example, when the
151
+ # service that powers the subscribed endpoint becomes unavailable) are
152
+ # held in the dead-letter queue for further analysis or reprocessing.
139
153
  # @option options [String] :attribute_value
140
154
  # The new value for the attribute in JSON format.
141
155
  # @return [EmptyStructure]
@@ -33,30 +33,45 @@ module Aws::SNS
33
33
  # A map of the topic's attributes. Attributes in this map include the
34
34
  # following:
35
35
  #
36
- # * `TopicArn` – the topic's ARN
36
+ # * `DeliveryPolicy` – The JSON serialization of the topic's delivery
37
+ # policy.
37
38
  #
38
- # * `Owner` – the AWS account ID of the topic's owner
39
+ # * `DisplayName` – The human-readable name used in the `From` field for
40
+ # notifications to `email` and `email-json` endpoints.
39
41
  #
40
- # * `Policy` – the JSON serialization of the topic's access control
41
- # policy
42
+ # * `Owner` – The AWS account ID of the topic's owner.
42
43
  #
43
- # * `DisplayName` – the human-readable name used in the "From" field
44
- # for notifications to email and email-json endpoints
44
+ # * `Policy` – The JSON serialization of the topic's access control
45
+ # policy.
45
46
  #
46
- # * `SubscriptionsPending` – the number of subscriptions pending
47
- # confirmation on this topic
47
+ # * `SubscriptionsConfirmed` – The number of confirmed subscriptions for
48
+ # the topic.
48
49
  #
49
- # * `SubscriptionsConfirmed` – the number of confirmed subscriptions on
50
- # this topic
50
+ # * `SubscriptionsDeleted` – The number of deleted subscriptions for the
51
+ # topic.
51
52
  #
52
- # * `SubscriptionsDeleted` – the number of deleted subscriptions on this
53
- # topic
53
+ # * `SubscriptionsPending` – The number of subscriptions pending
54
+ # confirmation for the topic.
54
55
  #
55
- # * `DeliveryPolicy` – the JSON serialization of the topic's delivery
56
- # policy
56
+ # * `TopicArn` – The topic's ARN.
57
57
  #
58
- # * `EffectiveDeliveryPolicy` – the JSON serialization of the effective
59
- # delivery policy that takes into account system defaults
58
+ # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the effective
59
+ # delivery policy, taking system defaults into account.
60
+ #
61
+ # The following attribute applies only to [server-side-encryption][1]\:
62
+ #
63
+ # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
64
+ # (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
65
+ # Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
66
+ # Management Service API Reference*.
67
+ #
68
+ # ^
69
+ #
70
+ #
71
+ #
72
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
73
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
74
+ # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
60
75
  # @return [Hash<String,String>]
61
76
  def attributes
62
77
  data[:attributes]
@@ -116,7 +131,7 @@ module Aws::SNS
116
131
  # @option options [required, Array<String>] :action_name
117
132
  # The action you want to allow for the specified principal(s).
118
133
  #
119
- # Valid values: any Amazon SNS action name.
134
+ # Valid values: Any Amazon SNS action name, for example `Publish`.
120
135
  # @return [EmptyStructure]
121
136
  def add_permission(options = {})
122
137
  options = options.merge(topic_arn: @arn)
@@ -189,10 +204,6 @@ module Aws::SNS
189
204
  # @option options [required, String] :message
190
205
  # The message you want to send.
191
206
  #
192
- # The `Message` parameter is always a string. If you set
193
- # `MessageStructure` to `json`, you must string-encode the `Message`
194
- # parameter.
195
- #
196
207
  # If you are publishing to a topic and you want to send the same message
197
208
  # to all transport protocols, include the text of the message as a
198
209
  # String value. If you want to send different messages for each
@@ -268,16 +279,7 @@ module Aws::SNS
268
279
  # You can define other top-level keys that define the message you want
269
280
  # to send to a specific transport protocol (e.g., "http").
270
281
  #
271
- # For information about sending different messages for each protocol
272
- # using the AWS Management Console, go to [Create Different Messages for
273
- # Each Protocol][1] in the *Amazon Simple Notification Service Getting
274
- # Started Guide*.
275
- #
276
282
  # Valid value: `json`
277
- #
278
- #
279
- #
280
- # [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
281
283
  # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
282
284
  # Message attributes for Publish action.
283
285
  # @return [Types::PublishResponse]
@@ -376,17 +378,17 @@ module Aws::SNS
376
378
  # * `application` – delivery of JSON-encoded message to an EndpointArn
377
379
  # for a mobile app and device.
378
380
  #
379
- # * `lambda` – delivery of JSON-encoded message to an AWS Lambda
381
+ # * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
380
382
  # function.
381
383
  # @option options [String] :endpoint
382
384
  # The endpoint that you want to receive notifications. Endpoints vary by
383
385
  # protocol:
384
386
  #
385
387
  # * For the `http` protocol, the endpoint is an URL beginning with
386
- # "https://"
388
+ # `http://`
387
389
  #
388
390
  # * For the `https` protocol, the endpoint is a URL beginning with
389
- # "https://"
391
+ # `https://`
390
392
  #
391
393
  # * For the `email` protocol, the endpoint is an email address
392
394
  #
@@ -401,8 +403,8 @@ module Aws::SNS
401
403
  # * For the `application` protocol, the endpoint is the EndpointArn of a
402
404
  # mobile app and device.
403
405
  #
404
- # * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
405
- # function.
406
+ # * For the `lambda` protocol, the endpoint is the ARN of an Amazon
407
+ # Lambda function.
406
408
  # @option options [Hash<String,String>] :attributes
407
409
  # A map of attributes with their corresponding values.
408
410
  #
@@ -420,18 +422,27 @@ module Aws::SNS
420
422
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
421
423
  # for the endpoints to process JSON formatting, which is otherwise
422
424
  # created for Amazon SNS metadata.
425
+ #
426
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
427
+ # the specified Amazon SQS dead-letter queue. Messages that can't be
428
+ # delivered due to client errors (for example, when the subscribed
429
+ # endpoint is unreachable) or server errors (for example, when the
430
+ # service that powers the subscribed endpoint becomes unavailable) are
431
+ # held in the dead-letter queue for further analysis or reprocessing.
423
432
  # @option options [Boolean] :return_subscription_arn
424
433
  # Sets whether the response from the `Subscribe` request includes the
425
434
  # subscription ARN, even if the subscription is not yet confirmed.
426
435
  #
427
- # If you set this parameter to `false`, the response includes the ARN
428
- # for confirmed subscriptions, but it includes an ARN value of "pending
429
- # subscription" for subscriptions that are not yet confirmed. A
430
- # subscription becomes confirmed when the subscriber calls the
431
- # `ConfirmSubscription` action with a confirmation token.
436
+ # * If you have the subscription ARN returned, the response includes the
437
+ # ARN in all cases, even if the subscription is not yet confirmed.
438
+ #
439
+ # * If you don't have the subscription ARN returned, in addition to the
440
+ # ARN for confirmed subscriptions, the response also includes the
441
+ # `pending subscription` ARN value for subscriptions that aren't yet
442
+ # confirmed. A subscription becomes confirmed when the subscriber
443
+ # calls the `ConfirmSubscription` action with a confirmation token.
432
444
  #
433
- # If you set this parameter to `true`, the response includes the ARN in
434
- # all cases, even if the subscription is not yet confirmed.
445
+ # If you set this parameter to `true`, .
435
446
  #
436
447
  # The default value is `false`.
437
448
  # @return [Subscription]
@@ -35,7 +35,7 @@ module Aws::SNS
35
35
  # @!attribute [rw] action_name
36
36
  # The action you want to allow for the specified principal(s).
37
37
  #
38
- # Valid values: any Amazon SNS action name.
38
+ # Valid values: Any Amazon SNS action name, for example `Publish`.
39
39
  # @return [Array<String>]
40
40
  #
41
41
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermissionInput AWS API Documentation
@@ -197,7 +197,7 @@ module Aws::SNS
197
197
  # @!attribute [rw] platform
198
198
  # The following platforms are supported: ADM (Amazon Device
199
199
  # Messaging), APNS (Apple Push Notification Service), APNS\_SANDBOX,
200
- # and GCM (Google Cloud Messaging).
200
+ # and FCM (Firebase Cloud Messaging).
201
201
  # @return [String]
202
202
  #
203
203
  # @!attribute [rw] attributes
@@ -254,7 +254,7 @@ module Aws::SNS
254
254
  # a device. The specific name for Token will vary, depending on which
255
255
  # notification service is being used. For example, when using APNS as
256
256
  # the notification service, you need the device token. Alternatively,
257
- # when using GCM or ADM, the device token equivalent is called the
257
+ # when using FCM or ADM, the device token equivalent is called the
258
258
  # registration ID.
259
259
  # @return [String]
260
260
  #
@@ -343,6 +343,11 @@ module Aws::SNS
343
343
  #
344
344
  # @!attribute [rw] tags
345
345
  # The list of tags to add to a new topic.
346
+ #
347
+ # <note markdown="1"> To be able to tag a topic on creation, you must have the
348
+ # `sns:CreateTopic` and `sns:TagResource` permissions.
349
+ #
350
+ # </note>
346
351
  # @return [Array<Types::Tag>]
347
352
  #
348
353
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopicInput AWS API Documentation
@@ -508,6 +513,10 @@ module Aws::SNS
508
513
  # an app and mobile device. This is returned from the notification
509
514
  # service when an app and mobile device are registered with the
510
515
  # notification service.
516
+ #
517
+ # <note markdown="1"> The device token for the iOS platform is returned in lowercase.
518
+ #
519
+ # </note>
511
520
  # @return [Hash<String,String>]
512
521
  #
513
522
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesResponse AWS API Documentation
@@ -655,6 +664,14 @@ module Aws::SNS
655
664
  # for the subscription. Raw messages are free of JSON formatting and
656
665
  # can be sent to HTTP/S and Amazon SQS endpoints.
657
666
  #
667
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
668
+ # the specified Amazon SQS dead-letter queue. Messages that can't
669
+ # be delivered due to client errors (for example, when the
670
+ # subscribed endpoint is unreachable) or server errors (for example,
671
+ # when the service that powers the subscribed endpoint becomes
672
+ # unavailable) are held in the dead-letter queue for further
673
+ # analysis or reprocessing.
674
+ #
658
675
  # * `SubscriptionArn` – The subscription's ARN.
659
676
  #
660
677
  # * `TopicArn` – The topic ARN that the subscription is associated
@@ -694,30 +711,46 @@ module Aws::SNS
694
711
  # A map of the topic's attributes. Attributes in this map include the
695
712
  # following:
696
713
  #
697
- # * `TopicArn` – the topic's ARN
714
+ # * `DeliveryPolicy` – The JSON serialization of the topic's delivery
715
+ # policy.
716
+ #
717
+ # * `DisplayName` – The human-readable name used in the `From` field
718
+ # for notifications to `email` and `email-json` endpoints.
719
+ #
720
+ # * `Owner` – The AWS account ID of the topic's owner.
721
+ #
722
+ # * `Policy` – The JSON serialization of the topic's access control
723
+ # policy.
698
724
  #
699
- # * `Owner` – the AWS account ID of the topic's owner
725
+ # * `SubscriptionsConfirmed` – The number of confirmed subscriptions
726
+ # for the topic.
700
727
  #
701
- # * `Policy` – the JSON serialization of the topic's access control
702
- # policy
728
+ # * `SubscriptionsDeleted` – The number of deleted subscriptions for
729
+ # the topic.
703
730
  #
704
- # * `DisplayName` – the human-readable name used in the "From" field
705
- # for notifications to email and email-json endpoints
731
+ # * `SubscriptionsPending` – The number of subscriptions pending
732
+ # confirmation for the topic.
706
733
  #
707
- # * `SubscriptionsPending` – the number of subscriptions pending
708
- # confirmation on this topic
734
+ # * `TopicArn` – The topic's ARN.
735
+ #
736
+ # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the
737
+ # effective delivery policy, taking system defaults into account.
738
+ #
739
+ # The following attribute applies only to
740
+ # [server-side-encryption][1]\:
741
+ #
742
+ # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
743
+ # (CMK) for Amazon SNS or a custom CMK. For more information, see
744
+ # [Key Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
745
+ # Management Service API Reference*.
709
746
  #
710
- # * `SubscriptionsConfirmed` – the number of confirmed subscriptions
711
- # on this topic
747
+ # ^
712
748
  #
713
- # * `SubscriptionsDeleted` – the number of deleted subscriptions on
714
- # this topic
715
749
  #
716
- # * `DeliveryPolicy` – the JSON serialization of the topic's delivery
717
- # policy
718
750
  #
719
- # * `EffectiveDeliveryPolicy` – the JSON serialization of the
720
- # effective delivery policy that takes into account system defaults
751
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
752
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
753
+ # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
721
754
  # @return [Hash<String,String>]
722
755
  #
723
756
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesResponse AWS API Documentation
@@ -1324,10 +1357,6 @@ module Aws::SNS
1324
1357
  # @!attribute [rw] message
1325
1358
  # The message you want to send.
1326
1359
  #
1327
- # The `Message` parameter is always a string. If you set
1328
- # `MessageStructure` to `json`, you must string-encode the `Message`
1329
- # parameter.
1330
- #
1331
1360
  # If you are publishing to a topic and you want to send the same
1332
1361
  # message to all transport protocols, include the text of the message
1333
1362
  # as a String value. If you want to send different messages for each
@@ -1410,16 +1439,7 @@ module Aws::SNS
1410
1439
  # You can define other top-level keys that define the message you want
1411
1440
  # to send to a specific transport protocol (e.g., "http").
1412
1441
  #
1413
- # For information about sending different messages for each protocol
1414
- # using the AWS Management Console, go to [Create Different Messages
1415
- # for Each Protocol][1] in the *Amazon Simple Notification Service
1416
- # Getting Started Guide*.
1417
- #
1418
1442
  # Valid value: `json`
1419
- #
1420
- #
1421
- #
1422
- # [1]: https://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
1423
1443
  # @return [String]
1424
1444
  #
1425
1445
  # @!attribute [rw] message_attributes
@@ -1557,12 +1577,12 @@ module Aws::SNS
1557
1577
  #
1558
1578
  # * `PlatformCredential` – The credential received from the
1559
1579
  # notification service. For APNS/APNS\_SANDBOX, PlatformCredential
1560
- # is private key. For GCM, PlatformCredential is "API key". For
1580
+ # is private key. For FCM, PlatformCredential is "API key". For
1561
1581
  # ADM, PlatformCredential is "client secret".
1562
1582
  #
1563
1583
  # * `PlatformPrincipal` – The principal received from the notification
1564
1584
  # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
1565
- # certificate. For GCM, PlatformPrincipal is not applicable. For
1585
+ # certificate. For FCM, PlatformPrincipal is not applicable. For
1566
1586
  # ADM, PlatformPrincipal is "client id".
1567
1587
  #
1568
1588
  # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
@@ -1738,6 +1758,14 @@ module Aws::SNS
1738
1758
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
1739
1759
  # need for the endpoints to process JSON formatting, which is
1740
1760
  # otherwise created for Amazon SNS metadata.
1761
+ #
1762
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1763
+ # the specified Amazon SQS dead-letter queue. Messages that can't
1764
+ # be delivered due to client errors (for example, when the
1765
+ # subscribed endpoint is unreachable) or server errors (for example,
1766
+ # when the service that powers the subscribed endpoint becomes
1767
+ # unavailable) are held in the dead-letter queue for further
1768
+ # analysis or reprocessing.
1741
1769
  # @return [String]
1742
1770
  #
1743
1771
  # @!attribute [rw] attribute_value
@@ -1865,7 +1893,7 @@ module Aws::SNS
1865
1893
  # * `application` – delivery of JSON-encoded message to an EndpointArn
1866
1894
  # for a mobile app and device.
1867
1895
  #
1868
- # * `lambda` – delivery of JSON-encoded message to an AWS Lambda
1896
+ # * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
1869
1897
  # function.
1870
1898
  # @return [String]
1871
1899
  #
@@ -1874,10 +1902,10 @@ module Aws::SNS
1874
1902
  # by protocol:
1875
1903
  #
1876
1904
  # * For the `http` protocol, the endpoint is an URL beginning with
1877
- # "https://"
1905
+ # `http://`
1878
1906
  #
1879
1907
  # * For the `https` protocol, the endpoint is a URL beginning with
1880
- # "https://"
1908
+ # `https://`
1881
1909
  #
1882
1910
  # * For the `email` protocol, the endpoint is an email address
1883
1911
  #
@@ -1892,7 +1920,7 @@ module Aws::SNS
1892
1920
  # * For the `application` protocol, the endpoint is the EndpointArn of
1893
1921
  # a mobile app and device.
1894
1922
  #
1895
- # * For the `lambda` protocol, the endpoint is the ARN of an AWS
1923
+ # * For the `lambda` protocol, the endpoint is the ARN of an Amazon
1896
1924
  # Lambda function.
1897
1925
  # @return [String]
1898
1926
  #
@@ -1914,20 +1942,32 @@ module Aws::SNS
1914
1942
  # delivery to Amazon SQS or HTTP/S endpoints. This eliminates the
1915
1943
  # need for the endpoints to process JSON formatting, which is
1916
1944
  # otherwise created for Amazon SNS metadata.
1945
+ #
1946
+ # * `RedrivePolicy` – When specified, sends undeliverable messages to
1947
+ # the specified Amazon SQS dead-letter queue. Messages that can't
1948
+ # be delivered due to client errors (for example, when the
1949
+ # subscribed endpoint is unreachable) or server errors (for example,
1950
+ # when the service that powers the subscribed endpoint becomes
1951
+ # unavailable) are held in the dead-letter queue for further
1952
+ # analysis or reprocessing.
1917
1953
  # @return [Hash<String,String>]
1918
1954
  #
1919
1955
  # @!attribute [rw] return_subscription_arn
1920
1956
  # Sets whether the response from the `Subscribe` request includes the
1921
1957
  # subscription ARN, even if the subscription is not yet confirmed.
1922
1958
  #
1923
- # If you set this parameter to `false`, the response includes the ARN
1924
- # for confirmed subscriptions, but it includes an ARN value of
1925
- # "pending subscription" for subscriptions that are not yet
1926
- # confirmed. A subscription becomes confirmed when the subscriber
1927
- # calls the `ConfirmSubscription` action with a confirmation token.
1959
+ # * If you have the subscription ARN returned, the response includes
1960
+ # the ARN in all cases, even if the subscription is not yet
1961
+ # confirmed.
1962
+ #
1963
+ # * If you don't have the subscription ARN returned, in addition to
1964
+ # the ARN for confirmed subscriptions, the response also includes
1965
+ # the `pending subscription` ARN value for subscriptions that
1966
+ # aren't yet confirmed. A subscription becomes confirmed when the
1967
+ # subscriber calls the `ConfirmSubscription` action with a
1968
+ # confirmation token.
1928
1969
  #
1929
- # If you set this parameter to `true`, the response includes the ARN
1930
- # in all cases, even if the subscription is not yet confirmed.
1970
+ # If you set this parameter to `true`, .
1931
1971
  #
1932
1972
  # The default value is `false`.
1933
1973
  # @return [Boolean]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-sns
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.20.0
4
+ version: 1.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-23 00:00:00.000000000 Z
11
+ date: 2019-11-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core