aws-sdk 1.11.2 → 1.11.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,72 +25,112 @@ module AWS
25
25
  # @!method add_permission(options = {})
26
26
  # Calls the AddPermission API operation.
27
27
  # @param [Hash] options
28
- # * `:topic_arn` - *required* - (String) The ARN of the topic whose
29
- # access control policy you wish to modify.
30
- # * `:label` - *required* - (String) A unique identifier for the new
31
- # policy statement.
32
- # * `:aws_account_id` - *required* - (Array<String>) The AWS account
33
- # IDs of the users (principals) who will be given access to the
34
- # specified actions. The users must have AWS accounts, but do not
35
- # need to be signed up for this service.
36
- # * `:action_name` - *required* - (Array<String>) The action you want
37
- # to allow for the specified principal(s). Valid values: any Amazon
38
- # SNS action name.
28
+ #
29
+ # * `:topic_arn` - *required* - (String)
30
+ # * `:label` - *required* - (String)
31
+ # * `:aws_account_id` - *required* - (Array<String>)
32
+ # * `:action_name` - *required* - (Array<String>)
39
33
  # @return [Core::Response]
40
34
 
41
35
  # @!method confirm_subscription(options = {})
42
36
  # Calls the ConfirmSubscription API operation.
43
37
  # @param [Hash] options
44
- # * `:topic_arn` - *required* - (String) The ARN of the topic for which
45
- # you wish to confirm a subscription.
46
- # * `:token` - *required* - (String) Short-lived token sent to an
47
- # endpoint during the Subscribe action.
48
- # * `:authenticate_on_unsubscribe` - (String) Disallows unauthenticated
49
- # unsubscribes of the subscription. If the value of this parameter is
50
- # `true` and the request has an AWS signature, then only the topic
51
- # owner and the subscription owner can unsubscribe the endpoint. The
52
- # unsubscribe action will require AWS authentication.
38
+ #
39
+ # * `:topic_arn` - *required* - (String)
40
+ # * `:token` - *required* - (String)
41
+ # * `:authenticate_on_unsubscribe` - (String)
53
42
  # @return [Core::Response]
54
43
  # The #data method of the response object returns
55
44
  # a hash with the following structure:
56
45
  #
57
46
  # * `:subscription_arn` - (String)
58
47
 
48
+ # @!method create_platform_application(options = {})
49
+ # Calls the CreatePlatformApplication API operation.
50
+ # @param [Hash] options
51
+ #
52
+ # * `:name` - (String)
53
+ # * `:platform` - (String)
54
+ # * `:attributes` - (Hash<String,String>)
55
+ # @return [Core::Response]
56
+ # The #data method of the response object returns
57
+ # a hash with the following structure:
58
+ #
59
+ # * `:platform_application_arn` - (String)
60
+
61
+ # @!method create_platform_endpoint(options = {})
62
+ # Calls the CreatePlatformEndpoint API operation.
63
+ # @param [Hash] options
64
+ #
65
+ # * `:platform_application_arn` - (String)
66
+ # * `:token` - (String)
67
+ # * `:custom_user_data` - (String)
68
+ # * `:attributes` - (Hash<String,String>)
69
+ # @return [Core::Response]
70
+ # The #data method of the response object returns
71
+ # a hash with the following structure:
72
+ #
73
+ # * `:endpoint_arn` - (String)
74
+
59
75
  # @!method create_topic(options = {})
60
76
  # Calls the CreateTopic API operation.
61
77
  # @param [Hash] options
62
- # * `:name` - *required* - (String) The name of the topic you want to
63
- # create. Constraints: Topic names must be made up of only uppercase
64
- # and lowercase ASCII letters, numbers, and hyphens, and must be
65
- # between 1 and 256 characters long.
78
+ #
79
+ # * `:name` - *required* - (String)
66
80
  # @return [Core::Response]
67
81
  # The #data method of the response object returns
68
82
  # a hash with the following structure:
69
83
  #
70
84
  # * `:topic_arn` - (String)
71
85
 
86
+ # @!method delete_endpoint(options = {})
87
+ # Calls the DeleteEndpoint API operation.
88
+ # @param [Hash] options
89
+ #
90
+ # * `:endpoint_arn` - (String)
91
+ # @return [Core::Response]
92
+
93
+ # @!method delete_platform_application(options = {})
94
+ # Calls the DeletePlatformApplication API operation.
95
+ # @param [Hash] options
96
+ #
97
+ # * `:platform_application_arn` - (String)
98
+ # @return [Core::Response]
99
+
72
100
  # @!method delete_topic(options = {})
73
101
  # Calls the DeleteTopic API operation.
74
102
  # @param [Hash] options
75
- # * `:topic_arn` - *required* - (String) The ARN of the topic you want
76
- # to delete. http://sns.us-east-1.amazonaws.com/
77
- # ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic
78
- # &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256
79
- # &Timestamp=2010-03-31T12%3A00%3A00.000Z &AWSAccessKeyId=(AWS Access
80
- # Key ID)
81
- # &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D
82
- # <DeleteTopicResponse
83
- # xmlns="http://sns.amazonaws.com/doc/2010-03-31/">
84
- # <ResponseMetadata>
85
- # <RequestId>fba800b9-3765-11df-8cf3-c58c53254dfb</RequestId>
86
- # </ResponseMetadata> </DeleteTopicResponse>
103
+ #
104
+ # * `:topic_arn` - *required* - (String)
87
105
  # @return [Core::Response]
88
106
 
107
+ # @!method get_endpoint_attributes(options = {})
108
+ # Calls the GetEndpointAttributes API operation.
109
+ # @param [Hash] options
110
+ #
111
+ # * `:endpoint_arn` - (String)
112
+ # @return [Core::Response]
113
+ # The #data method of the response object returns
114
+ # a hash with the following structure:
115
+ #
116
+ # * `:attributes` - (Hash<String,String>)
117
+
118
+ # @!method get_platform_application_attributes(options = {})
119
+ # Calls the GetPlatformApplicationAttributes API operation.
120
+ # @param [Hash] options
121
+ #
122
+ # * `:platform_application_arn` - (String)
123
+ # @return [Core::Response]
124
+ # The #data method of the response object returns
125
+ # a hash with the following structure:
126
+ #
127
+ # * `:attributes` - (Hash<String,String>)
128
+
89
129
  # @!method get_subscription_attributes(options = {})
90
130
  # Calls the GetSubscriptionAttributes API operation.
91
131
  # @param [Hash] options
92
- # * `:subscription_arn` - *required* - (String) The ARN of the
93
- # subscription whose properties you want to get.
132
+ #
133
+ # * `:subscription_arn` - *required* - (String)
94
134
  # @return [Core::Response]
95
135
  # The #data method of the response object returns
96
136
  # a hash with the following structure:
@@ -100,19 +140,46 @@ module AWS
100
140
  # @!method get_topic_attributes(options = {})
101
141
  # Calls the GetTopicAttributes API operation.
102
142
  # @param [Hash] options
103
- # * `:topic_arn` - *required* - (String) The ARN of the topic whose
104
- # properties you want to get.
143
+ #
144
+ # * `:topic_arn` - *required* - (String)
105
145
  # @return [Core::Response]
106
146
  # The #data method of the response object returns
107
147
  # a hash with the following structure:
108
148
  #
109
149
  # * `:attributes` - (Hash<String,String>)
110
150
 
151
+ # @!method list_endpoints_by_platform_application(options = {})
152
+ # Calls the ListEndpointsByPlatformApplication API operation.
153
+ # @param [Hash] options
154
+ #
155
+ # * `:platform_application_arn` - (String)
156
+ # @return [Core::Response]
157
+ # The #data method of the response object returns
158
+ # a hash with the following structure:
159
+ #
160
+ # * `:endpoints` - (Array<Hash>)
161
+ # * `:endpoint_arn` - (String)
162
+ # * `:attributes` - (Hash<String,String>)
163
+ # * `:next_token` - (String)
164
+
165
+ # @!method list_platform_applications(options = {})
166
+ # Calls the ListPlatformApplications API operation.
167
+ # @param [Hash] options
168
+ #
169
+ # * `:next_token` - (String)
170
+ # @return [Core::Response]
171
+ # The #data method of the response object returns
172
+ # a hash with the following structure:
173
+ #
174
+ # * `:platform_applications` - (Array<Hash>)
175
+ # * `:platform_application_arn` - (String)
176
+ # * `:attributes` - (Hash<String,String>)
177
+
111
178
  # @!method list_subscriptions(options = {})
112
179
  # Calls the ListSubscriptions API operation.
113
180
  # @param [Hash] options
114
- # * `:next_token` - (String) Token returned by the previous
115
- # ListSubscriptions request.
181
+ #
182
+ # * `:next_token` - (String)
116
183
  # @return [Core::Response]
117
184
  # The #data method of the response object returns
118
185
  # a hash with the following structure:
@@ -128,10 +195,9 @@ module AWS
128
195
  # @!method list_subscriptions_by_topic(options = {})
129
196
  # Calls the ListSubscriptionsByTopic API operation.
130
197
  # @param [Hash] options
131
- # * `:topic_arn` - *required* - (String) The ARN of the topic for which
132
- # you wish to find subscriptions.
133
- # * `:next_token` - (String) Token returned by the previous
134
- # ListSubscriptionsByTopic request.
198
+ #
199
+ # * `:topic_arn` - *required* - (String)
200
+ # * `:next_token` - (String)
135
201
  # @return [Core::Response]
136
202
  # The #data method of the response object returns
137
203
  # a hash with the following structure:
@@ -147,8 +213,8 @@ module AWS
147
213
  # @!method list_topics(options = {})
148
214
  # Calls the ListTopics API operation.
149
215
  # @param [Hash] options
150
- # * `:next_token` - (String) Token returned by the previous ListTopics
151
- # request.
216
+ #
217
+ # * `:next_token` - (String)
152
218
  # @return [Core::Response]
153
219
  # The #data method of the response object returns
154
220
  # a hash with the following structure:
@@ -160,39 +226,13 @@ module AWS
160
226
  # @!method publish(options = {})
161
227
  # Calls the Publish API operation.
162
228
  # @param [Hash] options
163
- # * `:topic_arn` - *required* - (String) The topic you want to publish
164
- # to.
165
- # * `:message` - *required* - (String) The message you want to send to
166
- # the topic. Constraints: Messages must be UTF-8 encoded strings at
167
- # most 8 KB in size (8192 bytes, not 8192 characters).
168
- # * `:subject` - (String) Optional parameter to be used as the
169
- # "Subject" line of when the message is delivered to e-mail
170
- # endpoints. This field will also be included, if present, in the
171
- # standard JSON messages delivered to other endpoints. Constraints:
172
- # Subjects must be ASCII text that begins with a letter, number or
173
- # punctuation mark; must not include line breaks or control
174
- # characters; and must be less than 100 characters long.
175
- # * `:message_structure` - (String) Optional parameter. It will have
176
- # one valid value: "json". If this option, Message is present and set
177
- # to "json", the value of Message must: be a syntactically valid JSON
178
- # object. It must contain at least a top level JSON key of "default"
179
- # with a value that is a string. For any other top level key that
180
- # matches one of our transport protocols (e.g. "http"), then the
181
- # corresponding value (if it is a string) will be used for the
182
- # message published for that protocol Constraints: Keys in the JSON
183
- # object that correspond to supported transport protocols must have
184
- # simple JSON string values. The values will be parsed (unescaped)
185
- # before they are used in outgoing messages. Typically, outbound
186
- # notifications are JSON encoded (meaning, the characters will be
187
- # reescaped for sending). JSON strings are UTF-8. Values have a
188
- # minimum length of 0 (the empty string, "", is allowed). Values have
189
- # a maximum length bounded by the overall message size (so, including
190
- # multiple protocols may limit message sizes). Non-string values will
191
- # cause the key to be ignored. Keys that do not correspond to
192
- # supported transport protocols will be ignored. Duplicate keys are
193
- # not allowed. Failure to parse or validate any key or value in the
194
- # message will cause the Publish call to return an error (no partial
195
- # delivery).
229
+ #
230
+ # * `:topic_arn` - (String)
231
+ # * `:target_arn` - (String)
232
+ # * `:message` - *required* - (String)
233
+ # * `:subject` - (String)
234
+ # * `:message_structure` - (String)
235
+ # * `:attributes` - (Hash<String,String>)
196
236
  # @return [Core::Response]
197
237
  # The #data method of the response object returns
198
238
  # a hash with the following structure:
@@ -202,57 +242,52 @@ module AWS
202
242
  # @!method remove_permission(options = {})
203
243
  # Calls the RemovePermission API operation.
204
244
  # @param [Hash] options
205
- # * `:topic_arn` - *required* - (String) The ARN of the topic whose
206
- # access control policy you wish to modify.
207
- # * `:label` - *required* - (String) The unique label of the statement
208
- # you want to remove.
245
+ #
246
+ # * `:topic_arn` - *required* - (String)
247
+ # * `:label` - *required* - (String)
248
+ # @return [Core::Response]
249
+
250
+ # @!method set_endpoint_attributes(options = {})
251
+ # Calls the SetEndpointAttributes API operation.
252
+ # @param [Hash] options
253
+ #
254
+ # * `:endpoint_arn` - (String)
255
+ # * `:attributes` - (Hash<String,String>)
256
+ # @return [Core::Response]
257
+
258
+ # @!method set_platform_application_attributes(options = {})
259
+ # Calls the SetPlatformApplicationAttributes API operation.
260
+ # @param [Hash] options
261
+ #
262
+ # * `:platform_application_arn` - (String)
263
+ # * `:attributes` - (Hash<String,String>)
209
264
  # @return [Core::Response]
210
265
 
211
266
  # @!method set_subscription_attributes(options = {})
212
267
  # Calls the SetSubscriptionAttributes API operation.
213
268
  # @param [Hash] options
214
- # * `:subscription_arn` - *required* - (String) The ARN of the
215
- # subscription to modify.
216
- # * `:attribute_name` - *required* - (String) The name of the attribute
217
- # you want to set. Only a subset of the subscriptions attributes are
218
- # mutable. Valid values: DeliveryPolicy
219
- # * `:attribute_value` - *required* - (String) The new value for the
220
- # attribute.
269
+ #
270
+ # * `:subscription_arn` - *required* - (String)
271
+ # * `:attribute_name` - *required* - (String)
272
+ # * `:attribute_value` - (String)
221
273
  # @return [Core::Response]
222
274
 
223
275
  # @!method set_topic_attributes(options = {})
224
276
  # Calls the SetTopicAttributes API operation.
225
277
  # @param [Hash] options
226
- # * `:topic_arn` - *required* - (String) The ARN of the topic to
227
- # modify.
228
- # * `:attribute_name` - *required* - (String) The name of the attribute
229
- # you want to set. Only a subset of the topic's attributes are
230
- # mutable. Valid values: Policy | DisplayName
231
- # * `:attribute_value` - *required* - (String) The new value for the
232
- # attribute.
278
+ #
279
+ # * `:topic_arn` - *required* - (String)
280
+ # * `:attribute_name` - *required* - (String)
281
+ # * `:attribute_value` - (String)
233
282
  # @return [Core::Response]
234
283
 
235
284
  # @!method subscribe(options = {})
236
285
  # Calls the Subscribe API operation.
237
286
  # @param [Hash] options
238
- # * `:topic_arn` - *required* - (String) The ARN of topic you want to
239
- # subscribe to.
240
- # * `:protocol` - *required* - (String) The protocol you want to use.
241
- # Supported protocols include: http -- delivery of JSON-encoded
242
- # message via HTTP POST https -- delivery of JSON-encoded message via
243
- # HTTPS POST email -- delivery of message via SMTP email-json --
244
- # delivery of JSON-encoded message via SMTP sms -- delivery of
245
- # message via SMS sqs -- delivery of JSON-encoded message to an
246
- # Amazon SQS queue
247
- # * `:endpoint` - *required* - (String) The endpoint that you want to
248
- # receive notifications. Endpoints vary by protocol: For the http
249
- # protocol, the endpoint is an URL beginning with "http://" For the
250
- # https protocol, the endpoint is a URL beginning with "https://" For
251
- # the email protocol, the endpoint is an e-mail address For the
252
- # email-json protocol, the endpoint is an e-mail address For the sms
253
- # protocol, the endpoint is a phone number of an SMS-enabled device
254
- # For the sqs protocol, the endpoint is the ARN of an Amazon SQS
255
- # queue
287
+ #
288
+ # * `:topic_arn` - *required* - (String)
289
+ # * `:protocol` - *required* - (String)
290
+ # * `:endpoint` - (String)
256
291
  # @return [Core::Response]
257
292
  # The #data method of the response object returns
258
293
  # a hash with the following structure:
@@ -262,8 +297,8 @@ module AWS
262
297
  # @!method unsubscribe(options = {})
263
298
  # Calls the Unsubscribe API operation.
264
299
  # @param [Hash] options
265
- # * `:subscription_arn` - *required* - (String) The ARN of the
266
- # subscription to be deleted.
300
+ #
301
+ # * `:subscription_arn` - *required* - (String)
267
302
  # @return [Core::Response]
268
303
 
269
304
  # end client methods #
@@ -16,7 +16,13 @@ module AWS
16
16
 
17
17
  # @api private
18
18
  class Request < Core::Http::Request
19
- include Core::Signature::Version2
19
+
20
+ include Core::Signature::Version4
21
+
22
+ def service
23
+ 'sns'
24
+ end
25
+
20
26
  end
21
27
 
22
28
  end
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method add_permission(options = {})
26
26
  # Calls the AddPermission API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
29
30
  # take action on.
30
31
  # * `:label` - *required* - (String) The unique identification of the
@@ -42,6 +43,7 @@ module AWS
42
43
  # @!method change_message_visibility(options = {})
43
44
  # Calls the ChangeMessageVisibility API operation.
44
45
  # @param [Hash] options
46
+ #
45
47
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
46
48
  # take action on.
47
49
  # * `:receipt_handle` - *required* - (String) The receipt handle
@@ -54,6 +56,7 @@ module AWS
54
56
  # @!method change_message_visibility_batch(options = {})
55
57
  # Calls the ChangeMessageVisibilityBatch API operation.
56
58
  # @param [Hash] options
59
+ #
57
60
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
58
61
  # take action on.
59
62
  # * `:entries` - *required* - (Array<Hash>) A list of receipt handles
@@ -79,6 +82,7 @@ module AWS
79
82
  # @!method create_queue(options = {})
80
83
  # Calls the CreateQueue API operation.
81
84
  # @param [Hash] options
85
+ #
82
86
  # * `:queue_name` - *required* - (String) The name for the queue to be
83
87
  # created.
84
88
  # * `:attributes` - (Hash<String,String>) A map of attributes with
@@ -92,6 +96,7 @@ module AWS
92
96
  # @!method delete_message(options = {})
93
97
  # Calls the DeleteMessage API operation.
94
98
  # @param [Hash] options
99
+ #
95
100
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
96
101
  # take action on.
97
102
  # * `:receipt_handle` - *required* - (String) The receipt handle
@@ -101,6 +106,7 @@ module AWS
101
106
  # @!method delete_message_batch(options = {})
102
107
  # Calls the DeleteMessageBatch API operation.
103
108
  # @param [Hash] options
109
+ #
104
110
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
105
111
  # take action on.
106
112
  # * `:entries` - *required* - (Array<Hash>) A list of receipt handles
@@ -124,6 +130,7 @@ module AWS
124
130
  # @!method delete_queue(options = {})
125
131
  # Calls the DeleteQueue API operation.
126
132
  # @param [Hash] options
133
+ #
127
134
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
128
135
  # take action on.
129
136
  # @return [Core::Response]
@@ -131,6 +138,7 @@ module AWS
131
138
  # @!method get_queue_attributes(options = {})
132
139
  # Calls the GetQueueAttributes API operation.
133
140
  # @param [Hash] options
141
+ #
134
142
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
135
143
  # take action on.
136
144
  # * `:attribute_names` - (Array<String>) A list of attributes to
@@ -144,6 +152,7 @@ module AWS
144
152
  # @!method get_queue_url(options = {})
145
153
  # Calls the GetQueueUrl API operation.
146
154
  # @param [Hash] options
155
+ #
147
156
  # * `:queue_name` - *required* - (String) The name of the queue whose
148
157
  # URL must be fetched.
149
158
  # * `:queue_owner_aws_account_id` - (String) The AWS account number of
@@ -157,6 +166,7 @@ module AWS
157
166
  # @!method list_queues(options = {})
158
167
  # Calls the ListQueues API operation.
159
168
  # @param [Hash] options
169
+ #
160
170
  # * `:queue_name_prefix` - (String) A string to use for filtering the
161
171
  # list results. Only those queues whose name begins with the
162
172
  # specified string are returned.
@@ -169,6 +179,7 @@ module AWS
169
179
  # @!method receive_message(options = {})
170
180
  # Calls the ReceiveMessage API operation.
171
181
  # @param [Hash] options
182
+ #
172
183
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
173
184
  # take action on.
174
185
  # * `:attribute_names` - (Array<String>) A list of attributes that need
@@ -200,6 +211,7 @@ module AWS
200
211
  # @!method remove_permission(options = {})
201
212
  # Calls the RemovePermission API operation.
202
213
  # @param [Hash] options
214
+ #
203
215
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
204
216
  # take action on.
205
217
  # * `:label` - *required* - (String) The identification of the
@@ -210,6 +222,7 @@ module AWS
210
222
  # @!method send_message(options = {})
211
223
  # Calls the SendMessage API operation.
212
224
  # @param [Hash] options
225
+ #
213
226
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
214
227
  # take action on.
215
228
  # * `:message_body` - *required* - (String) The message to send.
@@ -225,6 +238,7 @@ module AWS
225
238
  # @!method send_message_batch(options = {})
226
239
  # Calls the SendMessageBatch API operation.
227
240
  # @param [Hash] options
241
+ #
228
242
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
229
243
  # take action on.
230
244
  # * `:entries` - *required* - (Array<Hash>) A list of
@@ -252,6 +266,7 @@ module AWS
252
266
  # @!method set_queue_attributes(options = {})
253
267
  # Calls the SetQueueAttributes API operation.
254
268
  # @param [Hash] options
269
+ #
255
270
  # * `:queue_url` - *required* - (String) The URL of the SQS queue to
256
271
  # take action on.
257
272
  # * `:attributes` - *required* - (Hash<String,String>) A map of