aws-sdk-sns 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sns.rb +1 -1
- data/lib/aws-sdk-sns/client.rb +78 -20
- data/lib/aws-sdk-sns/client_api.rb +5 -0
- data/lib/aws-sdk-sns/platform_endpoint.rb +20 -8
- data/lib/aws-sdk-sns/subscription.rb +24 -11
- data/lib/aws-sdk-sns/topic.rb +42 -8
- data/lib/aws-sdk-sns/types.rb +86 -29
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3e52d411de1a9d172ce7196d4ffe7b95d7e215e0
|
4
|
+
data.tar.gz: d88aba2790baad66c9e09b8a34de83299b2e4aab
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e61e4f527093683ab6bb0e481a6c29ccf5ecac23342cf6864ba3fe106af7a5aef0efd34c4e747fe35992afe35819619ccbe9787afabc359045a0d6f63d4212cb
|
7
|
+
data.tar.gz: 246935eee50df48455129477c7df24150d8d6f971e8acf2ae90c9e3515bd04868cd8e275f3de2f3662913a282a05f073aa4ad8b7c03e852c669daced5fd162b1
|
data/lib/aws-sdk-sns.rb
CHANGED
data/lib/aws-sdk-sns/client.rb
CHANGED
@@ -722,6 +722,8 @@ module Aws::SNS
|
|
722
722
|
# return, NextToken will be null. For more information, see [Using
|
723
723
|
# Amazon SNS Mobile Push Notifications][1].
|
724
724
|
#
|
725
|
+
# This action is throttled at 30 transactions per second (TPS).
|
726
|
+
#
|
725
727
|
#
|
726
728
|
#
|
727
729
|
# [1]: http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
@@ -816,6 +818,8 @@ module Aws::SNS
|
|
816
818
|
# more records to return, NextToken will be null. For more information,
|
817
819
|
# see [Using Amazon SNS Mobile Push Notifications][1].
|
818
820
|
#
|
821
|
+
# This action is throttled at 15 transactions per second (TPS).
|
822
|
+
#
|
819
823
|
#
|
820
824
|
#
|
821
825
|
# [1]: http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
@@ -858,6 +862,8 @@ module Aws::SNS
|
|
858
862
|
# subscriptions, a `NextToken` is also returned. Use the `NextToken`
|
859
863
|
# parameter in a new `ListSubscriptions` call to get further results.
|
860
864
|
#
|
865
|
+
# This action is throttled at 30 transactions per second (TPS).
|
866
|
+
#
|
861
867
|
# @option params [String] :next_token
|
862
868
|
# Token returned by the previous `ListSubscriptions` request.
|
863
869
|
#
|
@@ -897,6 +903,8 @@ module Aws::SNS
|
|
897
903
|
# parameter in a new `ListSubscriptionsByTopic` call to get further
|
898
904
|
# results.
|
899
905
|
#
|
906
|
+
# This action is throttled at 30 transactions per second (TPS).
|
907
|
+
#
|
900
908
|
# @option params [required, String] :topic_arn
|
901
909
|
# The ARN of the topic for which you wish to find subscriptions.
|
902
910
|
#
|
@@ -939,6 +947,8 @@ module Aws::SNS
|
|
939
947
|
# also returned. Use the `NextToken` parameter in a new `ListTopics`
|
940
948
|
# call to get further results.
|
941
949
|
#
|
950
|
+
# This action is throttled at 30 transactions per second (TPS).
|
951
|
+
#
|
942
952
|
# @option params [String] :next_token
|
943
953
|
# Token returned by the previous `ListTopics` request.
|
944
954
|
#
|
@@ -993,11 +1003,16 @@ module Aws::SNS
|
|
993
1003
|
req.send_request(options)
|
994
1004
|
end
|
995
1005
|
|
996
|
-
# Sends a message to
|
997
|
-
#
|
998
|
-
#
|
999
|
-
#
|
1000
|
-
# the
|
1006
|
+
# Sends a message to an Amazon SNS topic or sends a text message (SMS
|
1007
|
+
# message) directly to a phone number.
|
1008
|
+
#
|
1009
|
+
# If you send a message to a topic, Amazon SNS delivers the message to
|
1010
|
+
# each endpoint that is subscribed to the topic. The format of the
|
1011
|
+
# message depends on the notification protocol for each subscribed
|
1012
|
+
# endpoint.
|
1013
|
+
#
|
1014
|
+
# When a `messageId` is returned, the message has been saved and Amazon
|
1015
|
+
# SNS will attempt to deliver it shortly.
|
1001
1016
|
#
|
1002
1017
|
# To use the `Publish` action for sending a message to a mobile
|
1003
1018
|
# endpoint, such as an app on a Kindle device or mobile phone, you must
|
@@ -1032,17 +1047,29 @@ module Aws::SNS
|
|
1032
1047
|
# must specify a value for the `TargetArn` or `TopicArn` parameters.
|
1033
1048
|
#
|
1034
1049
|
# @option params [required, String] :message
|
1035
|
-
# The message you want to send
|
1050
|
+
# The message you want to send.
|
1051
|
+
#
|
1052
|
+
# If you are publishing to a topic and you want to send the same message
|
1053
|
+
# to all transport protocols, include the text of the message as a
|
1054
|
+
# String value. If you want to send different messages for each
|
1055
|
+
# transport protocol, set the value of the `MessageStructure` parameter
|
1056
|
+
# to `json` and use a JSON object for the `Message` parameter.
|
1057
|
+
#
|
1058
|
+
#
|
1036
1059
|
#
|
1037
|
-
#
|
1038
|
-
# include the text of the message as a String value.
|
1060
|
+
# Constraints:
|
1039
1061
|
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
# JSON object for the `Message` parameter.
|
1062
|
+
# * With the exception of SMS, messages must be UTF-8 encoded strings
|
1063
|
+
# and at most 256 KB in size (262144 bytes, not 262144 characters).
|
1043
1064
|
#
|
1044
|
-
#
|
1045
|
-
#
|
1065
|
+
# * For SMS, each message can contain up to 140 bytes, and the character
|
1066
|
+
# limit depends on the encoding scheme. For example, an SMS message
|
1067
|
+
# can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2
|
1068
|
+
# characters. If you publish a message that exceeds the size limit,
|
1069
|
+
# Amazon SNS sends it as multiple messages, each fitting within the
|
1070
|
+
# size limit. Messages are not cut off in the middle of a word but on
|
1071
|
+
# whole-word boundaries. The total size limit for a single SMS publish
|
1072
|
+
# action is 1600 bytes.
|
1046
1073
|
#
|
1047
1074
|
# JSON-specific constraints:
|
1048
1075
|
#
|
@@ -1316,8 +1343,10 @@ module Aws::SNS
|
|
1316
1343
|
# messages, you will incur costs that exceed your limit.
|
1317
1344
|
#
|
1318
1345
|
# By default, the spend limit is set to the maximum allowed by Amazon
|
1319
|
-
# SNS. If you want to
|
1320
|
-
#
|
1346
|
+
# SNS. If you want to raise the limit, submit an [SNS Limit Increase
|
1347
|
+
# case][1]. For **New limit value**, enter your desired monthly spend
|
1348
|
+
# limit. In the **Use Case Description** field, explain that you are
|
1349
|
+
# requesting an SMS monthly spend limit increase.
|
1321
1350
|
#
|
1322
1351
|
# `DeliveryStatusIAMRole` – The ARN of the IAM role that allows Amazon
|
1323
1352
|
# SNS to write logs about SMS deliveries in CloudWatch Logs. For each
|
@@ -1381,7 +1410,7 @@ module Aws::SNS
|
|
1381
1410
|
#
|
1382
1411
|
#
|
1383
1412
|
#
|
1384
|
-
# [1]: https://aws.amazon.com/
|
1413
|
+
# [1]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns
|
1385
1414
|
# [2]: http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html
|
1386
1415
|
#
|
1387
1416
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -1403,8 +1432,8 @@ module Aws::SNS
|
|
1403
1432
|
req.send_request(options)
|
1404
1433
|
end
|
1405
1434
|
|
1406
|
-
# Allows a subscription owner to set an attribute of the
|
1407
|
-
# value.
|
1435
|
+
# Allows a subscription owner to set an attribute of the subscription to
|
1436
|
+
# a new value.
|
1408
1437
|
#
|
1409
1438
|
# @option params [required, String] :subscription_arn
|
1410
1439
|
# The ARN of the subscription to modify.
|
@@ -1413,7 +1442,8 @@ module Aws::SNS
|
|
1413
1442
|
# The name of the attribute you want to set. Only a subset of the
|
1414
1443
|
# subscriptions attributes are mutable.
|
1415
1444
|
#
|
1416
|
-
# Valid values: `DeliveryPolicy` \| `
|
1445
|
+
# Valid values: `DeliveryPolicy` \| `FilterPolicy` \|
|
1446
|
+
# `RawMessageDelivery`
|
1417
1447
|
#
|
1418
1448
|
# @option params [String] :attribute_value
|
1419
1449
|
# The new value for the attribute in JSON format.
|
@@ -1476,6 +1506,8 @@ module Aws::SNS
|
|
1476
1506
|
# the confirmation message. Confirmation tokens are valid for three
|
1477
1507
|
# days.
|
1478
1508
|
#
|
1509
|
+
# This action is throttled at 100 transactions per second (TPS).
|
1510
|
+
#
|
1479
1511
|
# @option params [required, String] :topic_arn
|
1480
1512
|
# The ARN of the topic you want to subscribe to.
|
1481
1513
|
#
|
@@ -1526,6 +1558,26 @@ module Aws::SNS
|
|
1526
1558
|
# * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
|
1527
1559
|
# function.
|
1528
1560
|
#
|
1561
|
+
# @option params [Hash<String,String>] :attributes
|
1562
|
+
# Assigns attributes to the subscription as a map of key-value pairs.
|
1563
|
+
# You can assign any attribute that is supported by the
|
1564
|
+
# `SetSubscriptionAttributes` action.
|
1565
|
+
#
|
1566
|
+
# @option params [Boolean] :return_subscription_arn
|
1567
|
+
# Sets whether the response from the `Subscribe` request includes the
|
1568
|
+
# subscription ARN, even if the subscription is not yet confirmed.
|
1569
|
+
#
|
1570
|
+
# If you set this parameter to `false`, the response includes the ARN
|
1571
|
+
# for confirmed subscriptions, but it includes an ARN value of "pending
|
1572
|
+
# subscription" for subscriptions that are not yet confirmed. A
|
1573
|
+
# subscription becomes confirmed when the subscriber calls the
|
1574
|
+
# `ConfirmSubscription` action with a confirmation token.
|
1575
|
+
#
|
1576
|
+
# If you set this parameter to `true`, the response includes the ARN in
|
1577
|
+
# all cases, even if the subscription is not yet confirmed.
|
1578
|
+
#
|
1579
|
+
# The default value is `false`.
|
1580
|
+
#
|
1529
1581
|
# @return [Types::SubscribeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1530
1582
|
#
|
1531
1583
|
# * {Types::SubscribeResponse#subscription_arn #subscription_arn} => String
|
@@ -1536,6 +1588,10 @@ module Aws::SNS
|
|
1536
1588
|
# topic_arn: "topicARN", # required
|
1537
1589
|
# protocol: "protocol", # required
|
1538
1590
|
# endpoint: "endpoint",
|
1591
|
+
# attributes: {
|
1592
|
+
# "attributeName" => "attributeValue",
|
1593
|
+
# },
|
1594
|
+
# return_subscription_arn: false,
|
1539
1595
|
# })
|
1540
1596
|
#
|
1541
1597
|
# @example Response structure
|
@@ -1559,6 +1615,8 @@ module Aws::SNS
|
|
1559
1615
|
# delivered to the endpoint, so that the endpoint owner can easily
|
1560
1616
|
# resubscribe to the topic if the `Unsubscribe` request was unintended.
|
1561
1617
|
#
|
1618
|
+
# This action is throttled at 100 transactions per second (TPS).
|
1619
|
+
#
|
1562
1620
|
# @option params [required, String] :subscription_arn
|
1563
1621
|
# The ARN of the subscription to be deleted.
|
1564
1622
|
#
|
@@ -1592,7 +1650,7 @@ module Aws::SNS
|
|
1592
1650
|
params: params,
|
1593
1651
|
config: config)
|
1594
1652
|
context[:gem_name] = 'aws-sdk-sns'
|
1595
|
-
context[:gem_version] = '1.
|
1653
|
+
context[:gem_version] = '1.2.0'
|
1596
1654
|
Seahorse::Client::Request.new(handlers, context)
|
1597
1655
|
end
|
1598
1656
|
|
@@ -31,6 +31,7 @@ module Aws::SNS
|
|
31
31
|
DeleteTopicInput = Shapes::StructureShape.new(name: 'DeleteTopicInput')
|
32
32
|
Endpoint = Shapes::StructureShape.new(name: 'Endpoint')
|
33
33
|
EndpointDisabledException = Shapes::StructureShape.new(name: 'EndpointDisabledException')
|
34
|
+
FilterPolicyLimitExceededException = Shapes::StructureShape.new(name: 'FilterPolicyLimitExceededException')
|
34
35
|
GetEndpointAttributesInput = Shapes::StructureShape.new(name: 'GetEndpointAttributesInput')
|
35
36
|
GetEndpointAttributesResponse = Shapes::StructureShape.new(name: 'GetEndpointAttributesResponse')
|
36
37
|
GetPlatformApplicationAttributesInput = Shapes::StructureShape.new(name: 'GetPlatformApplicationAttributesInput')
|
@@ -316,6 +317,8 @@ module Aws::SNS
|
|
316
317
|
SubscribeInput.add_member(:topic_arn, Shapes::ShapeRef.new(shape: topicARN, required: true, location_name: "TopicArn"))
|
317
318
|
SubscribeInput.add_member(:protocol, Shapes::ShapeRef.new(shape: protocol, required: true, location_name: "Protocol"))
|
318
319
|
SubscribeInput.add_member(:endpoint, Shapes::ShapeRef.new(shape: endpoint, location_name: "Endpoint"))
|
320
|
+
SubscribeInput.add_member(:attributes, Shapes::ShapeRef.new(shape: SubscriptionAttributesMap, location_name: "Attributes"))
|
321
|
+
SubscribeInput.add_member(:return_subscription_arn, Shapes::ShapeRef.new(shape: boolean, location_name: "ReturnSubscriptionArn"))
|
319
322
|
SubscribeInput.struct_class = Types::SubscribeInput
|
320
323
|
|
321
324
|
SubscribeResponse.add_member(:subscription_arn, Shapes::ShapeRef.new(shape: subscriptionARN, location_name: "SubscriptionArn"))
|
@@ -700,6 +703,7 @@ module Aws::SNS
|
|
700
703
|
o.input = Shapes::ShapeRef.new(shape: SetSubscriptionAttributesInput)
|
701
704
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
702
705
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
706
|
+
o.errors << Shapes::ShapeRef.new(shape: FilterPolicyLimitExceededException)
|
703
707
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
704
708
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
705
709
|
o.errors << Shapes::ShapeRef.new(shape: AuthorizationErrorException)
|
@@ -724,6 +728,7 @@ module Aws::SNS
|
|
724
728
|
o.input = Shapes::ShapeRef.new(shape: SubscribeInput)
|
725
729
|
o.output = Shapes::ShapeRef.new(shape: SubscribeResponse)
|
726
730
|
o.errors << Shapes::ShapeRef.new(shape: SubscriptionLimitExceededException)
|
731
|
+
o.errors << Shapes::ShapeRef.new(shape: FilterPolicyLimitExceededException)
|
727
732
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
728
733
|
o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
|
729
734
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
@@ -127,17 +127,29 @@ module Aws::SNS
|
|
127
127
|
# If you don't specify a value for the `PhoneNumber` parameter, you
|
128
128
|
# must specify a value for the `TargetArn` or `TopicArn` parameters.
|
129
129
|
# @option options [required, String] :message
|
130
|
-
# The message you want to send
|
130
|
+
# The message you want to send.
|
131
131
|
#
|
132
|
-
# If you want to send the same message
|
133
|
-
# include the text of the message as a
|
132
|
+
# If you are publishing to a topic and you want to send the same message
|
133
|
+
# to all transport protocols, include the text of the message as a
|
134
|
+
# String value. If you want to send different messages for each
|
135
|
+
# transport protocol, set the value of the `MessageStructure` parameter
|
136
|
+
# to `json` and use a JSON object for the `Message` parameter.
|
134
137
|
#
|
135
|
-
# If you want to send different messages for each transport protocol,
|
136
|
-
# set the value of the `MessageStructure` parameter to `json` and use a
|
137
|
-
# JSON object for the `Message` parameter.
|
138
138
|
#
|
139
|
-
#
|
140
|
-
#
|
139
|
+
#
|
140
|
+
# Constraints:
|
141
|
+
#
|
142
|
+
# * With the exception of SMS, messages must be UTF-8 encoded strings
|
143
|
+
# and at most 256 KB in size (262144 bytes, not 262144 characters).
|
144
|
+
#
|
145
|
+
# * For SMS, each message can contain up to 140 bytes, and the character
|
146
|
+
# limit depends on the encoding scheme. For example, an SMS message
|
147
|
+
# can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2
|
148
|
+
# characters. If you publish a message that exceeds the size limit,
|
149
|
+
# Amazon SNS sends it as multiple messages, each fitting within the
|
150
|
+
# size limit. Messages are not cut off in the middle of a word but on
|
151
|
+
# whole-word boundaries. The total size limit for a single SMS publish
|
152
|
+
# action is 1600 bytes.
|
141
153
|
#
|
142
154
|
# JSON-specific constraints:
|
143
155
|
#
|
@@ -33,21 +33,33 @@ module Aws::SNS
|
|
33
33
|
# A map of the subscription's attributes. Attributes in this map
|
34
34
|
# include the following:
|
35
35
|
#
|
36
|
-
# * `
|
36
|
+
# * `ConfirmationWasAuthenticated` -- `true` if the subscription
|
37
|
+
# confirmation request was authenticated.
|
37
38
|
#
|
38
|
-
# * `
|
39
|
+
# * `DeliveryPolicy` -- The JSON serialization of the subscription's
|
40
|
+
# delivery policy.
|
39
41
|
#
|
40
|
-
# * `
|
42
|
+
# * `EffectiveDeliveryPolicy` -- The JSON serialization of the effective
|
43
|
+
# delivery policy that takes into account the topic delivery policy
|
44
|
+
# and account system defaults.
|
41
45
|
#
|
42
|
-
# * `
|
43
|
-
#
|
46
|
+
# * `FilterPolicy` -- The filter policy JSON that is assigned to the
|
47
|
+
# subscription.
|
44
48
|
#
|
45
|
-
# * `
|
46
|
-
# delivery policy
|
49
|
+
# * `Owner` -- The AWS account ID of the subscription's owner.
|
47
50
|
#
|
48
|
-
# * `
|
49
|
-
#
|
50
|
-
#
|
51
|
+
# * `PendingConfirmation` -- `true` if the subscription hasn't been
|
52
|
+
# confirmed. To confirm a pending subscription, call the
|
53
|
+
# `ConfirmSubscription` action with a confirmation token.
|
54
|
+
#
|
55
|
+
# * `RawMessageDelivery` -- `true` if raw message delivery is enabled
|
56
|
+
# for the subscription. Raw messages are free of JSON formatting and
|
57
|
+
# can be sent to HTTP/S and Amazon SQS endpoints.
|
58
|
+
#
|
59
|
+
# * `SubscriptionArn` -- The subscription's ARN.
|
60
|
+
#
|
61
|
+
# * `TopicArn` -- The topic ARN that the subscription is associated
|
62
|
+
# with.
|
51
63
|
# @return [Hash<String,String>]
|
52
64
|
def attributes
|
53
65
|
data[:attributes]
|
@@ -112,7 +124,8 @@ module Aws::SNS
|
|
112
124
|
# The name of the attribute you want to set. Only a subset of the
|
113
125
|
# subscriptions attributes are mutable.
|
114
126
|
#
|
115
|
-
# Valid values: `DeliveryPolicy` \| `
|
127
|
+
# Valid values: `DeliveryPolicy` \| `FilterPolicy` \|
|
128
|
+
# `RawMessageDelivery`
|
116
129
|
# @option options [String] :attribute_value
|
117
130
|
# The new value for the attribute in JSON format.
|
118
131
|
# @return [EmptyStructure]
|
data/lib/aws-sdk-sns/topic.rb
CHANGED
@@ -189,17 +189,29 @@ module Aws::SNS
|
|
189
189
|
# If you don't specify a value for the `PhoneNumber` parameter, you
|
190
190
|
# must specify a value for the `TargetArn` or `TopicArn` parameters.
|
191
191
|
# @option options [required, String] :message
|
192
|
-
# The message you want to send
|
192
|
+
# The message you want to send.
|
193
193
|
#
|
194
|
-
# If you want to send the same message
|
195
|
-
# include the text of the message as a
|
194
|
+
# If you are publishing to a topic and you want to send the same message
|
195
|
+
# to all transport protocols, include the text of the message as a
|
196
|
+
# String value. If you want to send different messages for each
|
197
|
+
# transport protocol, set the value of the `MessageStructure` parameter
|
198
|
+
# to `json` and use a JSON object for the `Message` parameter.
|
196
199
|
#
|
197
|
-
# If you want to send different messages for each transport protocol,
|
198
|
-
# set the value of the `MessageStructure` parameter to `json` and use a
|
199
|
-
# JSON object for the `Message` parameter.
|
200
200
|
#
|
201
|
-
#
|
202
|
-
#
|
201
|
+
#
|
202
|
+
# Constraints:
|
203
|
+
#
|
204
|
+
# * With the exception of SMS, messages must be UTF-8 encoded strings
|
205
|
+
# and at most 256 KB in size (262144 bytes, not 262144 characters).
|
206
|
+
#
|
207
|
+
# * For SMS, each message can contain up to 140 bytes, and the character
|
208
|
+
# limit depends on the encoding scheme. For example, an SMS message
|
209
|
+
# can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2
|
210
|
+
# characters. If you publish a message that exceeds the size limit,
|
211
|
+
# Amazon SNS sends it as multiple messages, each fitting within the
|
212
|
+
# size limit. Messages are not cut off in the middle of a word but on
|
213
|
+
# whole-word boundaries. The total size limit for a single SMS publish
|
214
|
+
# action is 1600 bytes.
|
203
215
|
#
|
204
216
|
# JSON-specific constraints:
|
205
217
|
#
|
@@ -310,6 +322,10 @@ module Aws::SNS
|
|
310
322
|
# subscription = topic.subscribe({
|
311
323
|
# protocol: "protocol", # required
|
312
324
|
# endpoint: "endpoint",
|
325
|
+
# attributes: {
|
326
|
+
# "attributeName" => "attributeValue",
|
327
|
+
# },
|
328
|
+
# return_subscription_arn: false,
|
313
329
|
# })
|
314
330
|
# @param [Hash] options ({})
|
315
331
|
# @option options [required, String] :protocol
|
@@ -357,6 +373,24 @@ module Aws::SNS
|
|
357
373
|
#
|
358
374
|
# * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
|
359
375
|
# function.
|
376
|
+
# @option options [Hash<String,String>] :attributes
|
377
|
+
# Assigns attributes to the subscription as a map of key-value pairs.
|
378
|
+
# You can assign any attribute that is supported by the
|
379
|
+
# `SetSubscriptionAttributes` action.
|
380
|
+
# @option options [Boolean] :return_subscription_arn
|
381
|
+
# Sets whether the response from the `Subscribe` request includes the
|
382
|
+
# subscription ARN, even if the subscription is not yet confirmed.
|
383
|
+
#
|
384
|
+
# If you set this parameter to `false`, the response includes the ARN
|
385
|
+
# for confirmed subscriptions, but it includes an ARN value of "pending
|
386
|
+
# subscription" for subscriptions that are not yet confirmed. A
|
387
|
+
# subscription becomes confirmed when the subscriber calls the
|
388
|
+
# `ConfirmSubscription` action with a confirmation token.
|
389
|
+
#
|
390
|
+
# If you set this parameter to `true`, the response includes the ARN in
|
391
|
+
# all cases, even if the subscription is not yet confirmed.
|
392
|
+
#
|
393
|
+
# The default value is `false`.
|
360
394
|
# @return [Subscription]
|
361
395
|
def subscribe(options = {})
|
362
396
|
options = options.merge(topic_arn: @arn)
|
data/lib/aws-sdk-sns/types.rb
CHANGED
@@ -531,22 +531,33 @@ module Aws::SNS
|
|
531
531
|
# A map of the subscription's attributes. Attributes in this map
|
532
532
|
# include the following:
|
533
533
|
#
|
534
|
-
# * `
|
534
|
+
# * `ConfirmationWasAuthenticated` -- `true` if the subscription
|
535
|
+
# confirmation request was authenticated.
|
535
536
|
#
|
536
|
-
# * `
|
537
|
-
#
|
537
|
+
# * `DeliveryPolicy` -- The JSON serialization of the subscription's
|
538
|
+
# delivery policy.
|
538
539
|
#
|
539
|
-
# * `
|
540
|
+
# * `EffectiveDeliveryPolicy` -- The JSON serialization of the
|
541
|
+
# effective delivery policy that takes into account the topic
|
542
|
+
# delivery policy and account system defaults.
|
540
543
|
#
|
541
|
-
# * `
|
542
|
-
#
|
544
|
+
# * `FilterPolicy` -- The filter policy JSON that is assigned to the
|
545
|
+
# subscription.
|
543
546
|
#
|
544
|
-
# * `
|
545
|
-
# delivery policy
|
547
|
+
# * `Owner` -- The AWS account ID of the subscription's owner.
|
546
548
|
#
|
547
|
-
# * `
|
548
|
-
#
|
549
|
-
#
|
549
|
+
# * `PendingConfirmation` -- `true` if the subscription hasn't been
|
550
|
+
# confirmed. To confirm a pending subscription, call the
|
551
|
+
# `ConfirmSubscription` action with a confirmation token.
|
552
|
+
#
|
553
|
+
# * `RawMessageDelivery` -- `true` if raw message delivery is enabled
|
554
|
+
# for the subscription. Raw messages are free of JSON formatting and
|
555
|
+
# can be sent to HTTP/S and Amazon SQS endpoints.
|
556
|
+
#
|
557
|
+
# * `SubscriptionArn` -- The subscription's ARN.
|
558
|
+
#
|
559
|
+
# * `TopicArn` -- The topic ARN that the subscription is associated
|
560
|
+
# with.
|
550
561
|
# @return [Hash<String,String>]
|
551
562
|
#
|
552
563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
|
@@ -899,8 +910,8 @@ module Aws::SNS
|
|
899
910
|
#
|
900
911
|
# @!attribute [rw] data_type
|
901
912
|
# Amazon SNS supports the following logical data types: String,
|
902
|
-
# Number, and Binary. For more information, see [Message
|
903
|
-
# Data Types][1].
|
913
|
+
# String.Array, Number, and Binary. For more information, see [Message
|
914
|
+
# Attribute Data Types][1].
|
904
915
|
#
|
905
916
|
#
|
906
917
|
#
|
@@ -1019,17 +1030,30 @@ module Aws::SNS
|
|
1019
1030
|
# @return [String]
|
1020
1031
|
#
|
1021
1032
|
# @!attribute [rw] message
|
1022
|
-
# The message you want to send
|
1033
|
+
# The message you want to send.
|
1034
|
+
#
|
1035
|
+
# If you are publishing to a topic and you want to send the same
|
1036
|
+
# message to all transport protocols, include the text of the message
|
1037
|
+
# as a String value. If you want to send different messages for each
|
1038
|
+
# transport protocol, set the value of the `MessageStructure`
|
1039
|
+
# parameter to `json` and use a JSON object for the `Message`
|
1040
|
+
# parameter.
|
1041
|
+
#
|
1023
1042
|
#
|
1024
|
-
# If you want to send the same message to all transport protocols,
|
1025
|
-
# include the text of the message as a String value.
|
1026
1043
|
#
|
1027
|
-
#
|
1028
|
-
# set the value of the `MessageStructure` parameter to `json` and use
|
1029
|
-
# a JSON object for the `Message` parameter.
|
1044
|
+
# Constraints:
|
1030
1045
|
#
|
1031
|
-
#
|
1032
|
-
#
|
1046
|
+
# * With the exception of SMS, messages must be UTF-8 encoded strings
|
1047
|
+
# and at most 256 KB in size (262144 bytes, not 262144 characters).
|
1048
|
+
#
|
1049
|
+
# * For SMS, each message can contain up to 140 bytes, and the
|
1050
|
+
# character limit depends on the encoding scheme. For example, an
|
1051
|
+
# SMS message can contain 160 GSM characters, 140 ASCII characters,
|
1052
|
+
# or 70 UCS-2 characters. If you publish a message that exceeds the
|
1053
|
+
# size limit, Amazon SNS sends it as multiple messages, each fitting
|
1054
|
+
# within the size limit. Messages are not cut off in the middle of a
|
1055
|
+
# word but on whole-word boundaries. The total size limit for a
|
1056
|
+
# single SMS publish action is 1600 bytes.
|
1033
1057
|
#
|
1034
1058
|
# JSON-specific constraints:
|
1035
1059
|
#
|
@@ -1284,8 +1308,10 @@ module Aws::SNS
|
|
1284
1308
|
# messages, you will incur costs that exceed your limit.
|
1285
1309
|
#
|
1286
1310
|
# By default, the spend limit is set to the maximum allowed by Amazon
|
1287
|
-
# SNS. If you want to
|
1288
|
-
#
|
1311
|
+
# SNS. If you want to raise the limit, submit an [SNS Limit Increase
|
1312
|
+
# case][1]. For **New limit value**, enter your desired monthly spend
|
1313
|
+
# limit. In the **Use Case Description** field, explain that you are
|
1314
|
+
# requesting an SMS monthly spend limit increase.
|
1289
1315
|
#
|
1290
1316
|
# `DeliveryStatusIAMRole` – The ARN of the IAM role that allows Amazon
|
1291
1317
|
# SNS to write logs about SMS deliveries in CloudWatch Logs. For each
|
@@ -1349,7 +1375,7 @@ module Aws::SNS
|
|
1349
1375
|
#
|
1350
1376
|
#
|
1351
1377
|
#
|
1352
|
-
# [1]: https://aws.amazon.com/
|
1378
|
+
# [1]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sns
|
1353
1379
|
# [2]: http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html
|
1354
1380
|
# @return [Hash<String,String>]
|
1355
1381
|
#
|
@@ -1385,7 +1411,8 @@ module Aws::SNS
|
|
1385
1411
|
# The name of the attribute you want to set. Only a subset of the
|
1386
1412
|
# subscriptions attributes are mutable.
|
1387
1413
|
#
|
1388
|
-
# Valid values: `DeliveryPolicy` \| `
|
1414
|
+
# Valid values: `DeliveryPolicy` \| `FilterPolicy` \|
|
1415
|
+
# `RawMessageDelivery`
|
1389
1416
|
# @return [String]
|
1390
1417
|
#
|
1391
1418
|
# @!attribute [rw] attribute_value
|
@@ -1445,6 +1472,10 @@ module Aws::SNS
|
|
1445
1472
|
# topic_arn: "topicARN", # required
|
1446
1473
|
# protocol: "protocol", # required
|
1447
1474
|
# endpoint: "endpoint",
|
1475
|
+
# attributes: {
|
1476
|
+
# "attributeName" => "attributeValue",
|
1477
|
+
# },
|
1478
|
+
# return_subscription_arn: false,
|
1448
1479
|
# }
|
1449
1480
|
#
|
1450
1481
|
# @!attribute [rw] topic_arn
|
@@ -1500,21 +1531,47 @@ module Aws::SNS
|
|
1500
1531
|
# Lambda function.
|
1501
1532
|
# @return [String]
|
1502
1533
|
#
|
1534
|
+
# @!attribute [rw] attributes
|
1535
|
+
# Assigns attributes to the subscription as a map of key-value pairs.
|
1536
|
+
# You can assign any attribute that is supported by the
|
1537
|
+
# `SetSubscriptionAttributes` action.
|
1538
|
+
# @return [Hash<String,String>]
|
1539
|
+
#
|
1540
|
+
# @!attribute [rw] return_subscription_arn
|
1541
|
+
# Sets whether the response from the `Subscribe` request includes the
|
1542
|
+
# subscription ARN, even if the subscription is not yet confirmed.
|
1543
|
+
#
|
1544
|
+
# If you set this parameter to `false`, the response includes the ARN
|
1545
|
+
# for confirmed subscriptions, but it includes an ARN value of
|
1546
|
+
# "pending subscription" for subscriptions that are not yet
|
1547
|
+
# confirmed. A subscription becomes confirmed when the subscriber
|
1548
|
+
# calls the `ConfirmSubscription` action with a confirmation token.
|
1549
|
+
#
|
1550
|
+
# If you set this parameter to `true`, the response includes the ARN
|
1551
|
+
# in all cases, even if the subscription is not yet confirmed.
|
1552
|
+
#
|
1553
|
+
# The default value is `false`.
|
1554
|
+
# @return [Boolean]
|
1555
|
+
#
|
1503
1556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeInput AWS API Documentation
|
1504
1557
|
#
|
1505
1558
|
class SubscribeInput < Struct.new(
|
1506
1559
|
:topic_arn,
|
1507
1560
|
:protocol,
|
1508
|
-
:endpoint
|
1561
|
+
:endpoint,
|
1562
|
+
:attributes,
|
1563
|
+
:return_subscription_arn)
|
1509
1564
|
include Aws::Structure
|
1510
1565
|
end
|
1511
1566
|
|
1512
1567
|
# Response for Subscribe action.
|
1513
1568
|
#
|
1514
1569
|
# @!attribute [rw] subscription_arn
|
1515
|
-
# The ARN of the subscription
|
1516
|
-
#
|
1517
|
-
#
|
1570
|
+
# The ARN of the subscription if it is confirmed, or the string
|
1571
|
+
# "pending confirmation" if the subscription requires confirmation.
|
1572
|
+
# However, if the API request parameter `ReturnSubscriptionArn` is
|
1573
|
+
# true, then the value is always the subscription ARN, even if the
|
1574
|
+
# subscription requires confirmation.
|
1518
1575
|
# @return [String]
|
1519
1576
|
#
|
1520
1577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeResponse AWS API Documentation
|
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.
|
4
|
+
version: 1.2.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:
|
11
|
+
date: 2018-06-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
80
80
|
version: '0'
|
81
81
|
requirements: []
|
82
82
|
rubyforge_project:
|
83
|
-
rubygems_version: 2.5.
|
83
|
+
rubygems_version: 2.5.2.3
|
84
84
|
signing_key:
|
85
85
|
specification_version: 4
|
86
86
|
summary: AWS SDK for Ruby - Amazon SNS
|