aws-sdk-sns 1.34.0 → 1.39.0

Sign up to get free protection for your applications and to get access to all the features.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.39.0
data/lib/aws-sdk-sns.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-sns/customizations'
52
52
  # @!group service
53
53
  module Aws::SNS
54
54
 
55
- GEM_VERSION = '1.34.0'
55
+ GEM_VERSION = '1.39.0'
56
56
 
57
57
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -637,25 +637,33 @@ module Aws::SNS
637
637
  #
638
638
  # ^
639
639
  #
640
- # The following attribute applies only to FIFO topics:
640
+ # The following attributes apply only to [FIFO topics][4]\:
641
641
  #
642
- # * `ContentBasedDeduplication` – Enables content-based deduplication.
643
- # Amazon SNS uses a SHA-256 hash to generate the
644
- # `MessageDeduplicationId` using the body of the message (but not the
645
- # attributes of the message).
642
+ # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
646
643
  #
647
- # * When `ContentBasedDeduplication` is in effect, messages with
648
- # identical content sent within the deduplication interval are treated
649
- # as duplicates and only one copy of the message is delivered.
644
+ # * `ContentBasedDeduplication` Enables content-based deduplication
645
+ # for FIFO topics.
650
646
  #
651
- # * If the queue has `ContentBasedDeduplication` set, your
652
- # `MessageDeduplicationId` overrides the generated one.
647
+ # * By default, `ContentBasedDeduplication` is set to `false`. If you
648
+ # create a FIFO topic and this attribute is `false`, you must
649
+ # specify a value for the `MessageDeduplicationId` parameter for the
650
+ # [Publish][5] action.
651
+ #
652
+ # * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
653
+ # uses a SHA-256 hash to generate the `MessageDeduplicationId` using
654
+ # the body of the message (but not the attributes of the message).
655
+ #
656
+ # (Optional) To override the generated value, you can specify a
657
+ # value for the the `MessageDeduplicationId` parameter for the
658
+ # `Publish` action.
653
659
  #
654
660
  #
655
661
  #
656
662
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
657
663
  # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
658
664
  # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
665
+ # [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
666
+ # [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
659
667
  #
660
668
  # @option params [Array<Types::Tag>] :tags
661
669
  # The list of tags to add to a new topic.
@@ -1642,8 +1650,14 @@ module Aws::SNS
1642
1650
  #
1643
1651
  # You can override some of these settings for a single message when you
1644
1652
  # use the `Publish` action with the `MessageAttributes.entry.N`
1645
- # parameter. For more information, see [Sending an SMS Message][1] in
1646
- # the *Amazon SNS Developer Guide*.
1653
+ # parameter. For more information, see [Publishing to a mobile phone][1]
1654
+ # in the *Amazon SNS Developer Guide*.
1655
+ #
1656
+ # <note markdown="1"> To use this operation, you must grant the Amazon SNS service principal
1657
+ # (`sns.amazonaws.com`) permission to perform the `s3:ListBucket`
1658
+ # action.
1659
+ #
1660
+ # </note>
1647
1661
  #
1648
1662
  #
1649
1663
  #
@@ -1762,7 +1776,7 @@ module Aws::SNS
1762
1776
  # A map of attributes with their corresponding values.
1763
1777
  #
1764
1778
  # The following lists the names, descriptions, and values of the special
1765
- # request parameters that the `SetTopicAttributes` action uses:
1779
+ # request parameters that this action uses:
1766
1780
  #
1767
1781
  # * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
1768
1782
  # failed deliveries to HTTP/S endpoints.
@@ -1783,6 +1797,25 @@ module Aws::SNS
1783
1797
  # service that powers the subscribed endpoint becomes unavailable) are
1784
1798
  # held in the dead-letter queue for further analysis or reprocessing.
1785
1799
  #
1800
+ # The following attribute applies only to Amazon Kinesis Data Firehose
1801
+ # delivery stream subscriptions:
1802
+ #
1803
+ # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
1804
+ # following:
1805
+ #
1806
+ # * Permission to write to the Kinesis Data Firehose delivery stream
1807
+ #
1808
+ # * Amazon SNS listed as a trusted entity
1809
+ #
1810
+ # Specifying a valid ARN for this attribute is required for Kinesis
1811
+ # Data Firehose delivery stream subscriptions. For more information,
1812
+ # see [Fanout to Kinesis Data Firehose delivery streams][1] in the
1813
+ # *Amazon SNS Developer Guide*.
1814
+ #
1815
+ #
1816
+ #
1817
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
1818
+ #
1786
1819
  # @option params [String] :attribute_value
1787
1820
  # The new value for the attribute in JSON format.
1788
1821
  #
@@ -1834,25 +1867,31 @@ module Aws::SNS
1834
1867
  #
1835
1868
  # ^
1836
1869
  #
1837
- # The following attribute applies only to FIFO topics:
1870
+ # The following attribute applies only to [FIFO topics][4]\:
1871
+ #
1872
+ # * `ContentBasedDeduplication` – Enables content-based deduplication
1873
+ # for FIFO topics.
1838
1874
  #
1839
- # * `ContentBasedDeduplication` Enables content-based deduplication.
1840
- # Amazon SNS uses a SHA-256 hash to generate the
1841
- # `MessageDeduplicationId` using the body of the message (but not the
1842
- # attributes of the message).
1875
+ # * By default, `ContentBasedDeduplication` is set to `false`. If you
1876
+ # create a FIFO topic and this attribute is `false`, you must
1877
+ # specify a value for the `MessageDeduplicationId` parameter for the
1878
+ # [Publish][5] action.
1843
1879
  #
1844
- # * When `ContentBasedDeduplication` is in effect, messages with
1845
- # identical content sent within the deduplication interval are treated
1846
- # as duplicates and only one copy of the message is delivered.
1880
+ # * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
1881
+ # uses a SHA-256 hash to generate the `MessageDeduplicationId` using
1882
+ # the body of the message (but not the attributes of the message).
1847
1883
  #
1848
- # * If the queue has `ContentBasedDeduplication` set, your
1849
- # `MessageDeduplicationId` overrides the generated one.
1884
+ # (Optional) To override the generated value, you can specify a
1885
+ # value for the the `MessageDeduplicationId` parameter for the
1886
+ # `Publish` action.
1850
1887
  #
1851
1888
  #
1852
1889
  #
1853
1890
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
1854
1891
  # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
1855
1892
  # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
1893
+ # [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
1894
+ # [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
1856
1895
  #
1857
1896
  # @option params [String] :attribute_value
1858
1897
  # The new value for the attribute.
@@ -1878,8 +1917,8 @@ module Aws::SNS
1878
1917
 
1879
1918
  # Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
1880
1919
  # HTTP/S or email, or if the endpoint and the topic are not in the same
1881
- # AWS account, the endpoint owner must the `ConfirmSubscription` action
1882
- # to confirm the subscription.
1920
+ # AWS account, the endpoint owner must run the `ConfirmSubscription`
1921
+ # action to confirm the subscription.
1883
1922
  #
1884
1923
  # You call the `ConfirmSubscription` action with the token from the
1885
1924
  # subscription response. Confirmation tokens are valid for three days.
@@ -1890,7 +1929,7 @@ module Aws::SNS
1890
1929
  # The ARN of the topic you want to subscribe to.
1891
1930
  #
1892
1931
  # @option params [required, String] :protocol
1893
- # The protocol you want to use. Supported protocols include:
1932
+ # The protocol that you want to use. Supported protocols include:
1894
1933
  #
1895
1934
  # * `http` – delivery of JSON-encoded message via HTTP POST
1896
1935
  #
@@ -1905,36 +1944,42 @@ module Aws::SNS
1905
1944
  # * `sqs` – delivery of JSON-encoded message to an Amazon SQS queue
1906
1945
  #
1907
1946
  # * `application` – delivery of JSON-encoded message to an EndpointArn
1908
- # for a mobile app and device.
1947
+ # for a mobile app and device
1909
1948
  #
1910
- # * `lambda` – delivery of JSON-encoded message to an Amazon Lambda
1911
- # function.
1949
+ # * `lambda` – delivery of JSON-encoded message to an AWS Lambda
1950
+ # function
1951
+ #
1952
+ # * `firehose` – delivery of JSON-encoded message to an Amazon Kinesis
1953
+ # Data Firehose delivery stream.
1912
1954
  #
1913
1955
  # @option params [String] :endpoint
1914
1956
  # The endpoint that you want to receive notifications. Endpoints vary by
1915
1957
  # protocol:
1916
1958
  #
1917
1959
  # * For the `http` protocol, the (public) endpoint is a URL beginning
1918
- # with `http://`
1960
+ # with `http://`.
1919
1961
  #
1920
1962
  # * For the `https` protocol, the (public) endpoint is a URL beginning
1921
- # with `https://`
1963
+ # with `https://`.
1922
1964
  #
1923
- # * For the `email` protocol, the endpoint is an email address
1965
+ # * For the `email` protocol, the endpoint is an email address.
1924
1966
  #
1925
- # * For the `email-json` protocol, the endpoint is an email address
1967
+ # * For the `email-json` protocol, the endpoint is an email address.
1926
1968
  #
1927
1969
  # * For the `sms` protocol, the endpoint is a phone number of an
1928
- # SMS-enabled device
1970
+ # SMS-enabled device.
1929
1971
  #
1930
1972
  # * For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS
1931
- # queue
1973
+ # queue.
1932
1974
  #
1933
1975
  # * For the `application` protocol, the endpoint is the EndpointArn of a
1934
1976
  # mobile app and device.
1935
1977
  #
1936
- # * For the `lambda` protocol, the endpoint is the ARN of an Amazon
1937
- # Lambda function.
1978
+ # * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
1979
+ # function.
1980
+ #
1981
+ # * For the `firehose` protocol, the endpoint is the ARN of an Amazon
1982
+ # Kinesis Data Firehose delivery stream.
1938
1983
  #
1939
1984
  # @option params [Hash<String,String>] :attributes
1940
1985
  # A map of attributes with their corresponding values.
@@ -1961,19 +2006,35 @@ module Aws::SNS
1961
2006
  # service that powers the subscribed endpoint becomes unavailable) are
1962
2007
  # held in the dead-letter queue for further analysis or reprocessing.
1963
2008
  #
2009
+ # The following attribute applies only to Amazon Kinesis Data Firehose
2010
+ # delivery stream subscriptions:
2011
+ #
2012
+ # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
2013
+ # following:
2014
+ #
2015
+ # * Permission to write to the Kinesis Data Firehose delivery stream
2016
+ #
2017
+ # * Amazon SNS listed as a trusted entity
2018
+ #
2019
+ # Specifying a valid ARN for this attribute is required for Kinesis
2020
+ # Data Firehose delivery stream subscriptions. For more information,
2021
+ # see [Fanout to Kinesis Data Firehose delivery streams][1] in the
2022
+ # *Amazon SNS Developer Guide*.
2023
+ #
2024
+ #
2025
+ #
2026
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
2027
+ #
1964
2028
  # @option params [Boolean] :return_subscription_arn
1965
2029
  # Sets whether the response from the `Subscribe` request includes the
1966
2030
  # subscription ARN, even if the subscription is not yet confirmed.
1967
2031
  #
1968
- # * If you set this parameter to `true`, the response includes the ARN
1969
- # in all cases, even if the subscription is not yet confirmed. In
1970
- # addition to the ARN for confirmed subscriptions, the response also
1971
- # includes the `pending subscription` ARN value for subscriptions that
1972
- # aren't yet confirmed. A subscription becomes confirmed when the
1973
- # subscriber calls the `ConfirmSubscription` action with a
1974
- # confirmation token.
1975
- #
1976
- # ^
2032
+ # If you set this parameter to `true`, the response includes the ARN in
2033
+ # all cases, even if the subscription is not yet confirmed. In addition
2034
+ # to the ARN for confirmed subscriptions, the response also includes the
2035
+ # `pending subscription` ARN value for subscriptions that aren't yet
2036
+ # confirmed. A subscription becomes confirmed when the subscriber calls
2037
+ # the `ConfirmSubscription` action with a confirmation token.
1977
2038
  #
1978
2039
  #
1979
2040
  #
@@ -2136,7 +2197,7 @@ module Aws::SNS
2136
2197
  params: params,
2137
2198
  config: config)
2138
2199
  context[:gem_name] = 'aws-sdk-sns'
2139
- context[:gem_version] = '1.34.0'
2200
+ context[:gem_version] = '1.39.0'
2140
2201
  Seahorse::Client::Request.new(handlers, context)
2141
2202
  end
2142
2203
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -118,25 +118,33 @@ module Aws::SNS
118
118
  #
119
119
  # ^
120
120
  #
121
- # The following attribute applies only to FIFO topics:
121
+ # The following attributes apply only to [FIFO topics][4]\:
122
122
  #
123
- # * `ContentBasedDeduplication` – Enables content-based deduplication.
124
- # Amazon SNS uses a SHA-256 hash to generate the
125
- # `MessageDeduplicationId` using the body of the message (but not the
126
- # attributes of the message).
123
+ # * `FifoTopic` – When this is set to `true`, a FIFO topic is created.
127
124
  #
128
- # * When `ContentBasedDeduplication` is in effect, messages with
129
- # identical content sent within the deduplication interval are treated
130
- # as duplicates and only one copy of the message is delivered.
125
+ # * `ContentBasedDeduplication` Enables content-based deduplication
126
+ # for FIFO topics.
131
127
  #
132
- # * If the queue has `ContentBasedDeduplication` set, your
133
- # `MessageDeduplicationId` overrides the generated one.
128
+ # * By default, `ContentBasedDeduplication` is set to `false`. If you
129
+ # create a FIFO topic and this attribute is `false`, you must
130
+ # specify a value for the `MessageDeduplicationId` parameter for the
131
+ # [Publish][5] action.
132
+ #
133
+ # * When you set `ContentBasedDeduplication` to `true`, Amazon SNS
134
+ # uses a SHA-256 hash to generate the `MessageDeduplicationId` using
135
+ # the body of the message (but not the attributes of the message).
136
+ #
137
+ # (Optional) To override the generated value, you can specify a
138
+ # value for the the `MessageDeduplicationId` parameter for the
139
+ # `Publish` action.
134
140
  #
135
141
  #
136
142
  #
137
143
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
138
144
  # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms
139
145
  # [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
146
+ # [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
147
+ # [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
140
148
  # @option options [Array<Types::Tag>] :tags
141
149
  # The list of tags to add to a new topic.
142
150
  #
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -72,9 +72,25 @@ module Aws::SNS
72
72
  #
73
73
  # * `TopicArn` – The topic ARN that the subscription is associated with.
74
74
  #
75
+ # The following attribute applies only to Amazon Kinesis Data Firehose
76
+ # delivery stream subscriptions:
77
+ #
78
+ # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
79
+ # following:
80
+ #
81
+ # * Permission to write to the Kinesis Data Firehose delivery stream
82
+ #
83
+ # * Amazon SNS listed as a trusted entity
84
+ #
85
+ # Specifying a valid ARN for this attribute is required for Kinesis
86
+ # Data Firehose delivery stream subscriptions. For more information,
87
+ # see [Fanout to Kinesis Data Firehose delivery streams][2] in the
88
+ # *Amazon SNS Developer Guide*.
89
+ #
75
90
  #
76
91
  #
77
92
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
93
+ # [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
78
94
  # @return [Hash<String,String>]
79
95
  def attributes
80
96
  data[:attributes]
@@ -139,7 +155,7 @@ module Aws::SNS
139
155
  # A map of attributes with their corresponding values.
140
156
  #
141
157
  # The following lists the names, descriptions, and values of the special
142
- # request parameters that the `SetTopicAttributes` action uses:
158
+ # request parameters that this action uses:
143
159
  #
144
160
  # * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
145
161
  # failed deliveries to HTTP/S endpoints.
@@ -159,6 +175,25 @@ module Aws::SNS
159
175
  # endpoint is unreachable) or server errors (for example, when the
160
176
  # service that powers the subscribed endpoint becomes unavailable) are
161
177
  # held in the dead-letter queue for further analysis or reprocessing.
178
+ #
179
+ # The following attribute applies only to Amazon Kinesis Data Firehose
180
+ # delivery stream subscriptions:
181
+ #
182
+ # * `SubscriptionRoleArn` – The ARN of the IAM role that has the
183
+ # following:
184
+ #
185
+ # * Permission to write to the Kinesis Data Firehose delivery stream
186
+ #
187
+ # * Amazon SNS listed as a trusted entity
188
+ #
189
+ # Specifying a valid ARN for this attribute is required for Kinesis
190
+ # Data Firehose delivery stream subscriptions. For more information,
191
+ # see [Fanout to Kinesis Data Firehose delivery streams][1] in the
192
+ # *Amazon SNS Developer Guide*.
193
+ #
194
+ #
195
+ #
196
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-kinesis-subscriber.html
162
197
  # @option options [String] :attribute_value
163
198
  # The new value for the attribute in JSON format.
164
199
  # @return [EmptyStructure]