aws-sdk-sns 1.19.0 → 1.24.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.
@@ -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.19.0
4
+ version: 1.24.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-07-25 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.61.1
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.61.1
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
86
86
  version: '0'
87
87
  requirements: []
88
88
  rubyforge_project:
89
- rubygems_version: 2.5.2.3
89
+ rubygems_version: 2.7.6.2
90
90
  signing_key:
91
91
  specification_version: 4
92
92
  summary: AWS SDK for Ruby - Amazon SNS