aws-sdk-sns 1.0.0.rc1 → 1.0.0.rc2

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.
@@ -1,1351 +1,1595 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module SNS
10
- module Types
8
+ module Aws::SNS
9
+ module Types
11
10
 
12
- # @note When making an API call, pass AddPermissionInput
13
- # data as a hash:
14
- #
15
- # {
16
- # topic_arn: "topicARN", # required
17
- # label: "label", # required
18
- # aws_account_id: ["delegate"], # required
19
- # action_name: ["action"], # required
20
- # }
21
- # @!attribute [rw] topic_arn
22
- # The ARN of the topic whose access control policy you wish to modify.
23
- # @return [String]
24
- #
25
- # @!attribute [rw] label
26
- # A unique identifier for the new policy statement.
27
- # @return [String]
28
- #
29
- # @!attribute [rw] aws_account_id
30
- # The AWS account IDs of the users (principals) who will be given
31
- # access to the specified actions. The users must have AWS accounts,
32
- # but do not need to be signed up for this service.
33
- # @return [Array<String>]
34
- #
35
- # @!attribute [rw] action_name
36
- # The action you want to allow for the specified principal(s).
37
- #
38
- # Valid values: any Amazon SNS action name.
39
- # @return [Array<String>]
40
- class AddPermissionInput < Struct.new(
41
- :topic_arn,
42
- :label,
43
- :aws_account_id,
44
- :action_name)
45
- include Aws::Structure
46
- end
47
-
48
- # The input for the `CheckIfPhoneNumberIsOptedOut` action.
49
- # @note When making an API call, pass CheckIfPhoneNumberIsOptedOutInput
50
- # data as a hash:
51
- #
52
- # {
53
- # phone_number: "PhoneNumber", # required
54
- # }
55
- # @!attribute [rw] phone_number
56
- # The phone number for which you want to check the opt out status.
57
- # @return [String]
58
- class CheckIfPhoneNumberIsOptedOutInput < Struct.new(
59
- :phone_number)
60
- include Aws::Structure
61
- end
11
+ # @note When making an API call, you may pass AddPermissionInput
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # topic_arn: "topicARN", # required
16
+ # label: "label", # required
17
+ # aws_account_id: ["delegate"], # required
18
+ # action_name: ["action"], # required
19
+ # }
20
+ #
21
+ # @!attribute [rw] topic_arn
22
+ # The ARN of the topic whose access control policy you wish to modify.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] label
26
+ # A unique identifier for the new policy statement.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] aws_account_id
30
+ # The AWS account IDs of the users (principals) who will be given
31
+ # access to the specified actions. The users must have AWS accounts,
32
+ # but do not need to be signed up for this service.
33
+ # @return [Array<String>]
34
+ #
35
+ # @!attribute [rw] action_name
36
+ # The action you want to allow for the specified principal(s).
37
+ #
38
+ # Valid values: any Amazon SNS action name.
39
+ # @return [Array<String>]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/AddPermissionInput AWS API Documentation
42
+ #
43
+ class AddPermissionInput < Struct.new(
44
+ :topic_arn,
45
+ :label,
46
+ :aws_account_id,
47
+ :action_name)
48
+ include Aws::Structure
49
+ end
62
50
 
63
- # The response from the `CheckIfPhoneNumberIsOptedOut` action.
64
- # @!attribute [rw] is_opted_out
65
- # Indicates whether the phone number is opted out:
66
- #
67
- # * `true` – The phone number is opted out, meaning you cannot publish
68
- # SMS messages to it.
69
- #
70
- # * `false` – The phone number is opted in, meaning you can publish
71
- # SMS messages to it.
72
- # @return [Boolean]
73
- class CheckIfPhoneNumberIsOptedOutResponse < Struct.new(
74
- :is_opted_out)
75
- include Aws::Structure
76
- end
51
+ # The input for the `CheckIfPhoneNumberIsOptedOut` action.
52
+ #
53
+ # @note When making an API call, you may pass CheckIfPhoneNumberIsOptedOutInput
54
+ # data as a hash:
55
+ #
56
+ # {
57
+ # phone_number: "PhoneNumber", # required
58
+ # }
59
+ #
60
+ # @!attribute [rw] phone_number
61
+ # The phone number for which you want to check the opt out status.
62
+ # @return [String]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOutInput AWS API Documentation
65
+ #
66
+ class CheckIfPhoneNumberIsOptedOutInput < Struct.new(
67
+ :phone_number)
68
+ include Aws::Structure
69
+ end
77
70
 
78
- # Input for ConfirmSubscription action.
79
- # @note When making an API call, pass ConfirmSubscriptionInput
80
- # data as a hash:
81
- #
82
- # {
83
- # topic_arn: "topicARN", # required
84
- # token: "token", # required
85
- # authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
86
- # }
87
- # @!attribute [rw] topic_arn
88
- # The ARN of the topic for which you wish to confirm a subscription.
89
- # @return [String]
90
- #
91
- # @!attribute [rw] token
92
- # Short-lived token sent to an endpoint during the `Subscribe` action.
93
- # @return [String]
94
- #
95
- # @!attribute [rw] authenticate_on_unsubscribe
96
- # Disallows unauthenticated unsubscribes of the subscription. If the
97
- # value of this parameter is `true` and the request has an AWS
98
- # signature, then only the topic owner and the subscription owner can
99
- # unsubscribe the endpoint. The unsubscribe action requires AWS
100
- # authentication.
101
- # @return [String]
102
- class ConfirmSubscriptionInput < Struct.new(
103
- :topic_arn,
104
- :token,
105
- :authenticate_on_unsubscribe)
106
- include Aws::Structure
107
- end
71
+ # The response from the `CheckIfPhoneNumberIsOptedOut` action.
72
+ #
73
+ # @!attribute [rw] is_opted_out
74
+ # Indicates whether the phone number is opted out:
75
+ #
76
+ # * `true` – The phone number is opted out, meaning you cannot publish
77
+ # SMS messages to it.
78
+ #
79
+ # * `false` – The phone number is opted in, meaning you can publish
80
+ # SMS messages to it.
81
+ # @return [Boolean]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CheckIfPhoneNumberIsOptedOutResponse AWS API Documentation
84
+ #
85
+ class CheckIfPhoneNumberIsOptedOutResponse < Struct.new(
86
+ :is_opted_out)
87
+ include Aws::Structure
88
+ end
108
89
 
109
- # Response for ConfirmSubscriptions action.
110
- # @!attribute [rw] subscription_arn
111
- # The ARN of the created subscription.
112
- # @return [String]
113
- class ConfirmSubscriptionResponse < Struct.new(
114
- :subscription_arn)
115
- include Aws::Structure
116
- end
90
+ # Input for ConfirmSubscription action.
91
+ #
92
+ # @note When making an API call, you may pass ConfirmSubscriptionInput
93
+ # data as a hash:
94
+ #
95
+ # {
96
+ # topic_arn: "topicARN", # required
97
+ # token: "token", # required
98
+ # authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
99
+ # }
100
+ #
101
+ # @!attribute [rw] topic_arn
102
+ # The ARN of the topic for which you wish to confirm a subscription.
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] token
106
+ # Short-lived token sent to an endpoint during the `Subscribe` action.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] authenticate_on_unsubscribe
110
+ # Disallows unauthenticated unsubscribes of the subscription. If the
111
+ # value of this parameter is `true` and the request has an AWS
112
+ # signature, then only the topic owner and the subscription owner can
113
+ # unsubscribe the endpoint. The unsubscribe action requires AWS
114
+ # authentication.
115
+ # @return [String]
116
+ #
117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscriptionInput AWS API Documentation
118
+ #
119
+ class ConfirmSubscriptionInput < Struct.new(
120
+ :topic_arn,
121
+ :token,
122
+ :authenticate_on_unsubscribe)
123
+ include Aws::Structure
124
+ end
117
125
 
118
- # Response from CreateEndpoint action.
119
- # @!attribute [rw] endpoint_arn
120
- # EndpointArn returned from CreateEndpoint action.
121
- # @return [String]
122
- class CreateEndpointResponse < Struct.new(
123
- :endpoint_arn)
124
- include Aws::Structure
125
- end
126
+ # Response for ConfirmSubscriptions action.
127
+ #
128
+ # @!attribute [rw] subscription_arn
129
+ # The ARN of the created subscription.
130
+ # @return [String]
131
+ #
132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscriptionResponse AWS API Documentation
133
+ #
134
+ class ConfirmSubscriptionResponse < Struct.new(
135
+ :subscription_arn)
136
+ include Aws::Structure
137
+ end
126
138
 
127
- # Input for CreatePlatformApplication action.
128
- # @note When making an API call, pass CreatePlatformApplicationInput
129
- # data as a hash:
130
- #
131
- # {
132
- # name: "String", # required
133
- # platform: "String", # required
134
- # attributes: { # required
135
- # "String" => "String",
136
- # },
137
- # }
138
- # @!attribute [rw] name
139
- # Application names must be made up of only uppercase and lowercase
140
- # ASCII letters, numbers, underscores, hyphens, and periods, and must
141
- # be between 1 and 256 characters long.
142
- # @return [String]
143
- #
144
- # @!attribute [rw] platform
145
- # The following platforms are supported: ADM (Amazon Device
146
- # Messaging), APNS (Apple Push Notification Service), APNS\_SANDBOX,
147
- # and GCM (Google Cloud Messaging).
148
- # @return [String]
149
- #
150
- # @!attribute [rw] attributes
151
- # For a list of attributes, see [SetPlatformApplicationAttributes][1]
152
- #
153
- #
154
- #
155
- # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
156
- # @return [Hash<String,String>]
157
- class CreatePlatformApplicationInput < Struct.new(
158
- :name,
159
- :platform,
160
- :attributes)
161
- include Aws::Structure
162
- end
139
+ # Response from CreateEndpoint action.
140
+ #
141
+ # @!attribute [rw] endpoint_arn
142
+ # EndpointArn returned from CreateEndpoint action.
143
+ # @return [String]
144
+ #
145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateEndpointResponse AWS API Documentation
146
+ #
147
+ class CreateEndpointResponse < Struct.new(
148
+ :endpoint_arn)
149
+ include Aws::Structure
150
+ end
163
151
 
164
- # Response from CreatePlatformApplication action.
165
- # @!attribute [rw] platform_application_arn
166
- # PlatformApplicationArn is returned.
167
- # @return [String]
168
- class CreatePlatformApplicationResponse < Struct.new(
169
- :platform_application_arn)
170
- include Aws::Structure
171
- end
152
+ # Input for CreatePlatformApplication action.
153
+ #
154
+ # @note When making an API call, you may pass CreatePlatformApplicationInput
155
+ # data as a hash:
156
+ #
157
+ # {
158
+ # name: "String", # required
159
+ # platform: "String", # required
160
+ # attributes: { # required
161
+ # "String" => "String",
162
+ # },
163
+ # }
164
+ #
165
+ # @!attribute [rw] name
166
+ # Application names must be made up of only uppercase and lowercase
167
+ # ASCII letters, numbers, underscores, hyphens, and periods, and must
168
+ # be between 1 and 256 characters long.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] platform
172
+ # The following platforms are supported: ADM (Amazon Device
173
+ # Messaging), APNS (Apple Push Notification Service), APNS\_SANDBOX,
174
+ # and GCM (Google Cloud Messaging).
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] attributes
178
+ # For a list of attributes, see [SetPlatformApplicationAttributes][1]
179
+ #
180
+ #
181
+ #
182
+ # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
183
+ # @return [Hash<String,String>]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationInput AWS API Documentation
186
+ #
187
+ class CreatePlatformApplicationInput < Struct.new(
188
+ :name,
189
+ :platform,
190
+ :attributes)
191
+ include Aws::Structure
192
+ end
172
193
 
173
- # Input for CreatePlatformEndpoint action.
174
- # @note When making an API call, pass CreatePlatformEndpointInput
175
- # data as a hash:
176
- #
177
- # {
178
- # platform_application_arn: "String", # required
179
- # token: "String", # required
180
- # custom_user_data: "String",
181
- # attributes: {
182
- # "String" => "String",
183
- # },
184
- # }
185
- # @!attribute [rw] platform_application_arn
186
- # PlatformApplicationArn returned from CreatePlatformApplication is
187
- # used to create a an endpoint.
188
- # @return [String]
189
- #
190
- # @!attribute [rw] token
191
- # Unique identifier created by the notification service for an app on
192
- # a device. The specific name for Token will vary, depending on which
193
- # notification service is being used. For example, when using APNS as
194
- # the notification service, you need the device token. Alternatively,
195
- # when using GCM or ADM, the device token equivalent is called the
196
- # registration ID.
197
- # @return [String]
198
- #
199
- # @!attribute [rw] custom_user_data
200
- # Arbitrary user data to associate with the endpoint. Amazon SNS does
201
- # not use this data. The data must be in UTF-8 format and less than
202
- # 2KB.
203
- # @return [String]
204
- #
205
- # @!attribute [rw] attributes
206
- # For a list of attributes, see [SetEndpointAttributes][1].
207
- #
208
- #
209
- #
210
- # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html
211
- # @return [Hash<String,String>]
212
- class CreatePlatformEndpointInput < Struct.new(
213
- :platform_application_arn,
214
- :token,
215
- :custom_user_data,
216
- :attributes)
217
- include Aws::Structure
218
- end
194
+ # Response from CreatePlatformApplication action.
195
+ #
196
+ # @!attribute [rw] platform_application_arn
197
+ # PlatformApplicationArn is returned.
198
+ # @return [String]
199
+ #
200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationResponse AWS API Documentation
201
+ #
202
+ class CreatePlatformApplicationResponse < Struct.new(
203
+ :platform_application_arn)
204
+ include Aws::Structure
205
+ end
219
206
 
220
- # Input for CreateTopic action.
221
- # @note When making an API call, pass CreateTopicInput
222
- # data as a hash:
223
- #
224
- # {
225
- # name: "topicName", # required
226
- # }
227
- # @!attribute [rw] name
228
- # The name of the topic you want to create.
229
- #
230
- # Constraints: Topic names must be made up of only uppercase and
231
- # lowercase ASCII letters, numbers, underscores, and hyphens, and must
232
- # be between 1 and 256 characters long.
233
- # @return [String]
234
- class CreateTopicInput < Struct.new(
235
- :name)
236
- include Aws::Structure
237
- end
207
+ # Input for CreatePlatformEndpoint action.
208
+ #
209
+ # @note When making an API call, you may pass CreatePlatformEndpointInput
210
+ # data as a hash:
211
+ #
212
+ # {
213
+ # platform_application_arn: "String", # required
214
+ # token: "String", # required
215
+ # custom_user_data: "String",
216
+ # attributes: {
217
+ # "String" => "String",
218
+ # },
219
+ # }
220
+ #
221
+ # @!attribute [rw] platform_application_arn
222
+ # PlatformApplicationArn returned from CreatePlatformApplication is
223
+ # used to create a an endpoint.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] token
227
+ # Unique identifier created by the notification service for an app on
228
+ # a device. The specific name for Token will vary, depending on which
229
+ # notification service is being used. For example, when using APNS as
230
+ # the notification service, you need the device token. Alternatively,
231
+ # when using GCM or ADM, the device token equivalent is called the
232
+ # registration ID.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] custom_user_data
236
+ # Arbitrary user data to associate with the endpoint. Amazon SNS does
237
+ # not use this data. The data must be in UTF-8 format and less than
238
+ # 2KB.
239
+ # @return [String]
240
+ #
241
+ # @!attribute [rw] attributes
242
+ # For a list of attributes, see [SetEndpointAttributes][1].
243
+ #
244
+ #
245
+ #
246
+ # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html
247
+ # @return [Hash<String,String>]
248
+ #
249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformEndpointInput AWS API Documentation
250
+ #
251
+ class CreatePlatformEndpointInput < Struct.new(
252
+ :platform_application_arn,
253
+ :token,
254
+ :custom_user_data,
255
+ :attributes)
256
+ include Aws::Structure
257
+ end
238
258
 
239
- # Response from CreateTopic action.
240
- # @!attribute [rw] topic_arn
241
- # The Amazon Resource Name (ARN) assigned to the created topic.
242
- # @return [String]
243
- class CreateTopicResponse < Struct.new(
244
- :topic_arn)
245
- include Aws::Structure
246
- end
259
+ # Input for CreateTopic action.
260
+ #
261
+ # @note When making an API call, you may pass CreateTopicInput
262
+ # data as a hash:
263
+ #
264
+ # {
265
+ # name: "topicName", # required
266
+ # }
267
+ #
268
+ # @!attribute [rw] name
269
+ # The name of the topic you want to create.
270
+ #
271
+ # Constraints: Topic names must be made up of only uppercase and
272
+ # lowercase ASCII letters, numbers, underscores, and hyphens, and must
273
+ # be between 1 and 256 characters long.
274
+ # @return [String]
275
+ #
276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopicInput AWS API Documentation
277
+ #
278
+ class CreateTopicInput < Struct.new(
279
+ :name)
280
+ include Aws::Structure
281
+ end
247
282
 
248
- # Input for DeleteEndpoint action.
249
- # @note When making an API call, pass DeleteEndpointInput
250
- # data as a hash:
251
- #
252
- # {
253
- # endpoint_arn: "String", # required
254
- # }
255
- # @!attribute [rw] endpoint_arn
256
- # EndpointArn of endpoint to delete.
257
- # @return [String]
258
- class DeleteEndpointInput < Struct.new(
259
- :endpoint_arn)
260
- include Aws::Structure
261
- end
283
+ # Response from CreateTopic action.
284
+ #
285
+ # @!attribute [rw] topic_arn
286
+ # The Amazon Resource Name (ARN) assigned to the created topic.
287
+ # @return [String]
288
+ #
289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreateTopicResponse AWS API Documentation
290
+ #
291
+ class CreateTopicResponse < Struct.new(
292
+ :topic_arn)
293
+ include Aws::Structure
294
+ end
262
295
 
263
- # Input for DeletePlatformApplication action.
264
- # @note When making an API call, pass DeletePlatformApplicationInput
265
- # data as a hash:
266
- #
267
- # {
268
- # platform_application_arn: "String", # required
269
- # }
270
- # @!attribute [rw] platform_application_arn
271
- # PlatformApplicationArn of platform application object to delete.
272
- # @return [String]
273
- class DeletePlatformApplicationInput < Struct.new(
274
- :platform_application_arn)
275
- include Aws::Structure
276
- end
296
+ # Input for DeleteEndpoint action.
297
+ #
298
+ # @note When making an API call, you may pass DeleteEndpointInput
299
+ # data as a hash:
300
+ #
301
+ # {
302
+ # endpoint_arn: "String", # required
303
+ # }
304
+ #
305
+ # @!attribute [rw] endpoint_arn
306
+ # EndpointArn of endpoint to delete.
307
+ # @return [String]
308
+ #
309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointInput AWS API Documentation
310
+ #
311
+ class DeleteEndpointInput < Struct.new(
312
+ :endpoint_arn)
313
+ include Aws::Structure
314
+ end
277
315
 
278
- # @note When making an API call, pass DeleteTopicInput
279
- # data as a hash:
280
- #
281
- # {
282
- # topic_arn: "topicARN", # required
283
- # }
284
- # @!attribute [rw] topic_arn
285
- # The ARN of the topic you want to delete.
286
- # @return [String]
287
- class DeleteTopicInput < Struct.new(
288
- :topic_arn)
289
- include Aws::Structure
290
- end
316
+ # Input for DeletePlatformApplication action.
317
+ #
318
+ # @note When making an API call, you may pass DeletePlatformApplicationInput
319
+ # data as a hash:
320
+ #
321
+ # {
322
+ # platform_application_arn: "String", # required
323
+ # }
324
+ #
325
+ # @!attribute [rw] platform_application_arn
326
+ # PlatformApplicationArn of platform application object to delete.
327
+ # @return [String]
328
+ #
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationInput AWS API Documentation
330
+ #
331
+ class DeletePlatformApplicationInput < Struct.new(
332
+ :platform_application_arn)
333
+ include Aws::Structure
334
+ end
291
335
 
292
- # Endpoint for mobile app and device.
293
- # @!attribute [rw] endpoint_arn
294
- # EndpointArn for mobile app and device.
295
- # @return [String]
296
- #
297
- # @!attribute [rw] attributes
298
- # Attributes for endpoint.
299
- # @return [Hash<String,String>]
300
- class Endpoint < Struct.new(
301
- :endpoint_arn,
302
- :attributes)
303
- include Aws::Structure
304
- end
336
+ # @note When making an API call, you may pass DeleteTopicInput
337
+ # data as a hash:
338
+ #
339
+ # {
340
+ # topic_arn: "topicARN", # required
341
+ # }
342
+ #
343
+ # @!attribute [rw] topic_arn
344
+ # The ARN of the topic you want to delete.
345
+ # @return [String]
346
+ #
347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteTopicInput AWS API Documentation
348
+ #
349
+ class DeleteTopicInput < Struct.new(
350
+ :topic_arn)
351
+ include Aws::Structure
352
+ end
305
353
 
306
- # Input for GetEndpointAttributes action.
307
- # @note When making an API call, pass GetEndpointAttributesInput
308
- # data as a hash:
309
- #
310
- # {
311
- # endpoint_arn: "String", # required
312
- # }
313
- # @!attribute [rw] endpoint_arn
314
- # EndpointArn for GetEndpointAttributes input.
315
- # @return [String]
316
- class GetEndpointAttributesInput < Struct.new(
317
- :endpoint_arn)
318
- include Aws::Structure
319
- end
354
+ # Endpoint for mobile app and device.
355
+ #
356
+ # @!attribute [rw] endpoint_arn
357
+ # EndpointArn for mobile app and device.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] attributes
361
+ # Attributes for endpoint.
362
+ # @return [Hash<String,String>]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Endpoint AWS API Documentation
365
+ #
366
+ class Endpoint < Struct.new(
367
+ :endpoint_arn,
368
+ :attributes)
369
+ include Aws::Structure
370
+ end
320
371
 
321
- # Response from GetEndpointAttributes of the EndpointArn.
322
- # @!attribute [rw] attributes
323
- # Attributes include the following:
324
- #
325
- # * `CustomUserData` -- arbitrary user data to associate with the
326
- # endpoint. Amazon SNS does not use this data. The data must be in
327
- # UTF-8 format and less than 2KB.
328
- #
329
- # * `Enabled` -- flag that enables/disables delivery to the endpoint.
330
- # Amazon SNS will set this to false when a notification service
331
- # indicates to Amazon SNS that the endpoint is invalid. Users can
332
- # set it back to true, typically after updating Token.
333
- #
334
- # * `Token` -- device token, also referred to as a registration id,
335
- # for an app and mobile device. This is returned from the
336
- # notification service when an app and mobile device are registered
337
- # with the notification service.
338
- # @return [Hash<String,String>]
339
- class GetEndpointAttributesResponse < Struct.new(
340
- :attributes)
341
- include Aws::Structure
342
- end
372
+ # Input for GetEndpointAttributes action.
373
+ #
374
+ # @note When making an API call, you may pass GetEndpointAttributesInput
375
+ # data as a hash:
376
+ #
377
+ # {
378
+ # endpoint_arn: "String", # required
379
+ # }
380
+ #
381
+ # @!attribute [rw] endpoint_arn
382
+ # EndpointArn for GetEndpointAttributes input.
383
+ # @return [String]
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesInput AWS API Documentation
386
+ #
387
+ class GetEndpointAttributesInput < Struct.new(
388
+ :endpoint_arn)
389
+ include Aws::Structure
390
+ end
343
391
 
344
- # Input for GetPlatformApplicationAttributes action.
345
- # @note When making an API call, pass GetPlatformApplicationAttributesInput
346
- # data as a hash:
347
- #
348
- # {
349
- # platform_application_arn: "String", # required
350
- # }
351
- # @!attribute [rw] platform_application_arn
352
- # PlatformApplicationArn for GetPlatformApplicationAttributesInput.
353
- # @return [String]
354
- class GetPlatformApplicationAttributesInput < Struct.new(
355
- :platform_application_arn)
356
- include Aws::Structure
357
- end
392
+ # Response from GetEndpointAttributes of the EndpointArn.
393
+ #
394
+ # @!attribute [rw] attributes
395
+ # Attributes include the following:
396
+ #
397
+ # * `CustomUserData` -- arbitrary user data to associate with the
398
+ # endpoint. Amazon SNS does not use this data. The data must be in
399
+ # UTF-8 format and less than 2KB.
400
+ #
401
+ # * `Enabled` -- flag that enables/disables delivery to the endpoint.
402
+ # Amazon SNS will set this to false when a notification service
403
+ # indicates to Amazon SNS that the endpoint is invalid. Users can
404
+ # set it back to true, typically after updating Token.
405
+ #
406
+ # * `Token` -- device token, also referred to as a registration id,
407
+ # for an app and mobile device. This is returned from the
408
+ # notification service when an app and mobile device are registered
409
+ # with the notification service.
410
+ # @return [Hash<String,String>]
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesResponse AWS API Documentation
413
+ #
414
+ class GetEndpointAttributesResponse < Struct.new(
415
+ :attributes)
416
+ include Aws::Structure
417
+ end
358
418
 
359
- # Response for GetPlatformApplicationAttributes action.
360
- # @!attribute [rw] attributes
361
- # Attributes include the following:
362
- #
363
- # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
364
- # notifications should be sent.
365
- #
366
- # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
367
- # notifications should be sent.
368
- #
369
- # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
370
- # notifications should be sent.
371
- #
372
- # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
373
- # notifications should be sent upon Direct Publish delivery failure
374
- # (permanent) to one of the application's endpoints.
375
- # @return [Hash<String,String>]
376
- class GetPlatformApplicationAttributesResponse < Struct.new(
377
- :attributes)
378
- include Aws::Structure
379
- end
419
+ # Input for GetPlatformApplicationAttributes action.
420
+ #
421
+ # @note When making an API call, you may pass GetPlatformApplicationAttributesInput
422
+ # data as a hash:
423
+ #
424
+ # {
425
+ # platform_application_arn: "String", # required
426
+ # }
427
+ #
428
+ # @!attribute [rw] platform_application_arn
429
+ # PlatformApplicationArn for GetPlatformApplicationAttributesInput.
430
+ # @return [String]
431
+ #
432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesInput AWS API Documentation
433
+ #
434
+ class GetPlatformApplicationAttributesInput < Struct.new(
435
+ :platform_application_arn)
436
+ include Aws::Structure
437
+ end
380
438
 
381
- # The input for the `GetSMSAttributes` request.
382
- # @note When making an API call, pass GetSMSAttributesInput
383
- # data as a hash:
384
- #
385
- # {
386
- # attributes: ["String"],
387
- # }
388
- # @!attribute [rw] attributes
389
- # A list of the individual attribute names, such as
390
- # `MonthlySpendLimit`, for which you want values.
391
- #
392
- # For all attribute names, see [SetSMSAttributes][1].
393
- #
394
- # If you don't use this parameter, Amazon SNS returns all SMS
395
- # attributes.
396
- #
397
- #
398
- #
399
- # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html
400
- # @return [Array<String>]
401
- class GetSMSAttributesInput < Struct.new(
402
- :attributes)
403
- include Aws::Structure
404
- end
439
+ # Response for GetPlatformApplicationAttributes action.
440
+ #
441
+ # @!attribute [rw] attributes
442
+ # Attributes include the following:
443
+ #
444
+ # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
445
+ # notifications should be sent.
446
+ #
447
+ # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
448
+ # notifications should be sent.
449
+ #
450
+ # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
451
+ # notifications should be sent.
452
+ #
453
+ # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
454
+ # notifications should be sent upon Direct Publish delivery failure
455
+ # (permanent) to one of the application's endpoints.
456
+ # @return [Hash<String,String>]
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesResponse AWS API Documentation
459
+ #
460
+ class GetPlatformApplicationAttributesResponse < Struct.new(
461
+ :attributes)
462
+ include Aws::Structure
463
+ end
405
464
 
406
- # The response from the `GetSMSAttributes` request.
407
- # @!attribute [rw] attributes
408
- # The SMS attribute names and their values.
409
- # @return [Hash<String,String>]
410
- class GetSMSAttributesResponse < Struct.new(
411
- :attributes)
412
- include Aws::Structure
413
- end
465
+ # The input for the `GetSMSAttributes` request.
466
+ #
467
+ # @note When making an API call, you may pass GetSMSAttributesInput
468
+ # data as a hash:
469
+ #
470
+ # {
471
+ # attributes: ["String"],
472
+ # }
473
+ #
474
+ # @!attribute [rw] attributes
475
+ # A list of the individual attribute names, such as
476
+ # `MonthlySpendLimit`, for which you want values.
477
+ #
478
+ # For all attribute names, see [SetSMSAttributes][1].
479
+ #
480
+ # If you don't use this parameter, Amazon SNS returns all SMS
481
+ # attributes.
482
+ #
483
+ #
484
+ #
485
+ # [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetSMSAttributes.html
486
+ # @return [Array<String>]
487
+ #
488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributesInput AWS API Documentation
489
+ #
490
+ class GetSMSAttributesInput < Struct.new(
491
+ :attributes)
492
+ include Aws::Structure
493
+ end
414
494
 
415
- # Input for GetSubscriptionAttributes.
416
- # @note When making an API call, pass GetSubscriptionAttributesInput
417
- # data as a hash:
418
- #
419
- # {
420
- # subscription_arn: "subscriptionARN", # required
421
- # }
422
- # @!attribute [rw] subscription_arn
423
- # The ARN of the subscription whose properties you want to get.
424
- # @return [String]
425
- class GetSubscriptionAttributesInput < Struct.new(
426
- :subscription_arn)
427
- include Aws::Structure
428
- end
495
+ # The response from the `GetSMSAttributes` request.
496
+ #
497
+ # @!attribute [rw] attributes
498
+ # The SMS attribute names and their values.
499
+ # @return [Hash<String,String>]
500
+ #
501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSMSAttributesResponse AWS API Documentation
502
+ #
503
+ class GetSMSAttributesResponse < Struct.new(
504
+ :attributes)
505
+ include Aws::Structure
506
+ end
429
507
 
430
- # Response for GetSubscriptionAttributes action.
431
- # @!attribute [rw] attributes
432
- # A map of the subscription's attributes. Attributes in this map
433
- # include the following:
434
- #
435
- # * `SubscriptionArn` -- the subscription's ARN
436
- #
437
- # * `TopicArn` -- the topic ARN that the subscription is associated
438
- # with
439
- #
440
- # * `Owner` -- the AWS account ID of the subscription's owner
441
- #
442
- # * `ConfirmationWasAuthenticated` -- true if the subscription
443
- # confirmation request was authenticated
444
- #
445
- # * `DeliveryPolicy` -- the JSON serialization of the subscription's
446
- # delivery policy
447
- #
448
- # * `EffectiveDeliveryPolicy` -- the JSON serialization of the
449
- # effective delivery policy that takes into account the topic
450
- # delivery policy and account system defaults
451
- # @return [Hash<String,String>]
452
- class GetSubscriptionAttributesResponse < Struct.new(
453
- :attributes)
454
- include Aws::Structure
455
- end
508
+ # Input for GetSubscriptionAttributes.
509
+ #
510
+ # @note When making an API call, you may pass GetSubscriptionAttributesInput
511
+ # data as a hash:
512
+ #
513
+ # {
514
+ # subscription_arn: "subscriptionARN", # required
515
+ # }
516
+ #
517
+ # @!attribute [rw] subscription_arn
518
+ # The ARN of the subscription whose properties you want to get.
519
+ # @return [String]
520
+ #
521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesInput AWS API Documentation
522
+ #
523
+ class GetSubscriptionAttributesInput < Struct.new(
524
+ :subscription_arn)
525
+ include Aws::Structure
526
+ end
456
527
 
457
- # Input for GetTopicAttributes action.
458
- # @note When making an API call, pass GetTopicAttributesInput
459
- # data as a hash:
460
- #
461
- # {
462
- # topic_arn: "topicARN", # required
463
- # }
464
- # @!attribute [rw] topic_arn
465
- # The ARN of the topic whose properties you want to get.
466
- # @return [String]
467
- class GetTopicAttributesInput < Struct.new(
468
- :topic_arn)
469
- include Aws::Structure
470
- end
528
+ # Response for GetSubscriptionAttributes action.
529
+ #
530
+ # @!attribute [rw] attributes
531
+ # A map of the subscription's attributes. Attributes in this map
532
+ # include the following:
533
+ #
534
+ # * `SubscriptionArn` -- the subscription's ARN
535
+ #
536
+ # * `TopicArn` -- the topic ARN that the subscription is associated
537
+ # with
538
+ #
539
+ # * `Owner` -- the AWS account ID of the subscription's owner
540
+ #
541
+ # * `ConfirmationWasAuthenticated` -- true if the subscription
542
+ # confirmation request was authenticated
543
+ #
544
+ # * `DeliveryPolicy` -- the JSON serialization of the subscription's
545
+ # delivery policy
546
+ #
547
+ # * `EffectiveDeliveryPolicy` -- the JSON serialization of the
548
+ # effective delivery policy that takes into account the topic
549
+ # delivery policy and account system defaults
550
+ # @return [Hash<String,String>]
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
553
+ #
554
+ class GetSubscriptionAttributesResponse < Struct.new(
555
+ :attributes)
556
+ include Aws::Structure
557
+ end
471
558
 
472
- # Response for GetTopicAttributes action.
473
- # @!attribute [rw] attributes
474
- # A map of the topic's attributes. Attributes in this map include the
475
- # following:
476
- #
477
- # * `TopicArn` -- the topic's ARN
478
- #
479
- # * `Owner` -- the AWS account ID of the topic's owner
480
- #
481
- # * `Policy` -- the JSON serialization of the topic's access control
482
- # policy
483
- #
484
- # * `DisplayName` -- the human-readable name used in the "From"
485
- # field for notifications to email and email-json endpoints
486
- #
487
- # * `SubscriptionsPending` -- the number of subscriptions pending
488
- # confirmation on this topic
489
- #
490
- # * `SubscriptionsConfirmed` -- the number of confirmed subscriptions
491
- # on this topic
492
- #
493
- # * `SubscriptionsDeleted` -- the number of deleted subscriptions on
494
- # this topic
495
- #
496
- # * `DeliveryPolicy` -- the JSON serialization of the topic's
497
- # delivery policy
498
- #
499
- # * `EffectiveDeliveryPolicy` -- the JSON serialization of the
500
- # effective delivery policy that takes into account system defaults
501
- # @return [Hash<String,String>]
502
- class GetTopicAttributesResponse < Struct.new(
503
- :attributes)
504
- include Aws::Structure
505
- end
559
+ # Input for GetTopicAttributes action.
560
+ #
561
+ # @note When making an API call, you may pass GetTopicAttributesInput
562
+ # data as a hash:
563
+ #
564
+ # {
565
+ # topic_arn: "topicARN", # required
566
+ # }
567
+ #
568
+ # @!attribute [rw] topic_arn
569
+ # The ARN of the topic whose properties you want to get.
570
+ # @return [String]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesInput AWS API Documentation
573
+ #
574
+ class GetTopicAttributesInput < Struct.new(
575
+ :topic_arn)
576
+ include Aws::Structure
577
+ end
506
578
 
507
- # Input for ListEndpointsByPlatformApplication action.
508
- # @note When making an API call, pass ListEndpointsByPlatformApplicationInput
509
- # data as a hash:
510
- #
511
- # {
512
- # platform_application_arn: "String", # required
513
- # next_token: "String",
514
- # }
515
- # @!attribute [rw] platform_application_arn
516
- # PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
517
- # action.
518
- # @return [String]
519
- #
520
- # @!attribute [rw] next_token
521
- # NextToken string is used when calling
522
- # ListEndpointsByPlatformApplication action to retrieve additional
523
- # records that are available after the first page results.
524
- # @return [String]
525
- class ListEndpointsByPlatformApplicationInput < Struct.new(
526
- :platform_application_arn,
527
- :next_token)
528
- include Aws::Structure
529
- end
579
+ # Response for GetTopicAttributes action.
580
+ #
581
+ # @!attribute [rw] attributes
582
+ # A map of the topic's attributes. Attributes in this map include the
583
+ # following:
584
+ #
585
+ # * `TopicArn` -- the topic's ARN
586
+ #
587
+ # * `Owner` -- the AWS account ID of the topic's owner
588
+ #
589
+ # * `Policy` -- the JSON serialization of the topic's access control
590
+ # policy
591
+ #
592
+ # * `DisplayName` -- the human-readable name used in the "From"
593
+ # field for notifications to email and email-json endpoints
594
+ #
595
+ # * `SubscriptionsPending` -- the number of subscriptions pending
596
+ # confirmation on this topic
597
+ #
598
+ # * `SubscriptionsConfirmed` -- the number of confirmed subscriptions
599
+ # on this topic
600
+ #
601
+ # * `SubscriptionsDeleted` -- the number of deleted subscriptions on
602
+ # this topic
603
+ #
604
+ # * `DeliveryPolicy` -- the JSON serialization of the topic's
605
+ # delivery policy
606
+ #
607
+ # * `EffectiveDeliveryPolicy` -- the JSON serialization of the
608
+ # effective delivery policy that takes into account system defaults
609
+ # @return [Hash<String,String>]
610
+ #
611
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetTopicAttributesResponse AWS API Documentation
612
+ #
613
+ class GetTopicAttributesResponse < Struct.new(
614
+ :attributes)
615
+ include Aws::Structure
616
+ end
530
617
 
531
- # Response for ListEndpointsByPlatformApplication action.
532
- # @!attribute [rw] endpoints
533
- # Endpoints returned for ListEndpointsByPlatformApplication action.
534
- # @return [Array<Types::Endpoint>]
535
- #
536
- # @!attribute [rw] next_token
537
- # NextToken string is returned when calling
538
- # ListEndpointsByPlatformApplication action if additional records are
539
- # available after the first page results.
540
- # @return [String]
541
- class ListEndpointsByPlatformApplicationResponse < Struct.new(
542
- :endpoints,
543
- :next_token)
544
- include Aws::Structure
545
- end
618
+ # Input for ListEndpointsByPlatformApplication action.
619
+ #
620
+ # @note When making an API call, you may pass ListEndpointsByPlatformApplicationInput
621
+ # data as a hash:
622
+ #
623
+ # {
624
+ # platform_application_arn: "String", # required
625
+ # next_token: "String",
626
+ # }
627
+ #
628
+ # @!attribute [rw] platform_application_arn
629
+ # PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
630
+ # action.
631
+ # @return [String]
632
+ #
633
+ # @!attribute [rw] next_token
634
+ # NextToken string is used when calling
635
+ # ListEndpointsByPlatformApplication action to retrieve additional
636
+ # records that are available after the first page results.
637
+ # @return [String]
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationInput AWS API Documentation
640
+ #
641
+ class ListEndpointsByPlatformApplicationInput < Struct.new(
642
+ :platform_application_arn,
643
+ :next_token)
644
+ include Aws::Structure
645
+ end
546
646
 
547
- # The input for the `ListPhoneNumbersOptedOut` action.
548
- # @note When making an API call, pass ListPhoneNumbersOptedOutInput
549
- # data as a hash:
550
- #
551
- # {
552
- # next_token: "string",
553
- # }
554
- # @!attribute [rw] next_token
555
- # A `NextToken` string is used when you call the
556
- # `ListPhoneNumbersOptedOut` action to retrieve additional records
557
- # that are available after the first page of results.
558
- # @return [String]
559
- class ListPhoneNumbersOptedOutInput < Struct.new(
560
- :next_token)
561
- include Aws::Structure
562
- end
647
+ # Response for ListEndpointsByPlatformApplication action.
648
+ #
649
+ # @!attribute [rw] endpoints
650
+ # Endpoints returned for ListEndpointsByPlatformApplication action.
651
+ # @return [Array<Types::Endpoint>]
652
+ #
653
+ # @!attribute [rw] next_token
654
+ # NextToken string is returned when calling
655
+ # ListEndpointsByPlatformApplication action if additional records are
656
+ # available after the first page results.
657
+ # @return [String]
658
+ #
659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationResponse AWS API Documentation
660
+ #
661
+ class ListEndpointsByPlatformApplicationResponse < Struct.new(
662
+ :endpoints,
663
+ :next_token)
664
+ include Aws::Structure
665
+ end
563
666
 
564
- # The response from the `ListPhoneNumbersOptedOut` action.
565
- # @!attribute [rw] phone_numbers
566
- # A list of phone numbers that are opted out of receiving SMS
567
- # messages. The list is paginated, and each page can contain up to 100
568
- # phone numbers.
569
- # @return [Array<String>]
570
- #
571
- # @!attribute [rw] next_token
572
- # A `NextToken` string is returned when you call the
573
- # `ListPhoneNumbersOptedOut` action if additional records are
574
- # available after the first page of results.
575
- # @return [String]
576
- class ListPhoneNumbersOptedOutResponse < Struct.new(
577
- :phone_numbers,
578
- :next_token)
579
- include Aws::Structure
580
- end
667
+ # The input for the `ListPhoneNumbersOptedOut` action.
668
+ #
669
+ # @note When making an API call, you may pass ListPhoneNumbersOptedOutInput
670
+ # data as a hash:
671
+ #
672
+ # {
673
+ # next_token: "string",
674
+ # }
675
+ #
676
+ # @!attribute [rw] next_token
677
+ # A `NextToken` string is used when you call the
678
+ # `ListPhoneNumbersOptedOut` action to retrieve additional records
679
+ # that are available after the first page of results.
680
+ # @return [String]
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOutInput AWS API Documentation
683
+ #
684
+ class ListPhoneNumbersOptedOutInput < Struct.new(
685
+ :next_token)
686
+ include Aws::Structure
687
+ end
581
688
 
582
- # Input for ListPlatformApplications action.
583
- # @note When making an API call, pass ListPlatformApplicationsInput
584
- # data as a hash:
585
- #
586
- # {
587
- # next_token: "String",
588
- # }
589
- # @!attribute [rw] next_token
590
- # NextToken string is used when calling ListPlatformApplications
591
- # action to retrieve additional records that are available after the
592
- # first page results.
593
- # @return [String]
594
- class ListPlatformApplicationsInput < Struct.new(
595
- :next_token)
596
- include Aws::Structure
597
- end
689
+ # The response from the `ListPhoneNumbersOptedOut` action.
690
+ #
691
+ # @!attribute [rw] phone_numbers
692
+ # A list of phone numbers that are opted out of receiving SMS
693
+ # messages. The list is paginated, and each page can contain up to 100
694
+ # phone numbers.
695
+ # @return [Array<String>]
696
+ #
697
+ # @!attribute [rw] next_token
698
+ # A `NextToken` string is returned when you call the
699
+ # `ListPhoneNumbersOptedOut` action if additional records are
700
+ # available after the first page of results.
701
+ # @return [String]
702
+ #
703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPhoneNumbersOptedOutResponse AWS API Documentation
704
+ #
705
+ class ListPhoneNumbersOptedOutResponse < Struct.new(
706
+ :phone_numbers,
707
+ :next_token)
708
+ include Aws::Structure
709
+ end
598
710
 
599
- # Response for ListPlatformApplications action.
600
- # @!attribute [rw] platform_applications
601
- # Platform applications returned when calling ListPlatformApplications
602
- # action.
603
- # @return [Array<Types::PlatformApplication>]
604
- #
605
- # @!attribute [rw] next_token
606
- # NextToken string is returned when calling ListPlatformApplications
607
- # action if additional records are available after the first page
608
- # results.
609
- # @return [String]
610
- class ListPlatformApplicationsResponse < Struct.new(
611
- :platform_applications,
612
- :next_token)
613
- include Aws::Structure
614
- end
711
+ # Input for ListPlatformApplications action.
712
+ #
713
+ # @note When making an API call, you may pass ListPlatformApplicationsInput
714
+ # data as a hash:
715
+ #
716
+ # {
717
+ # next_token: "String",
718
+ # }
719
+ #
720
+ # @!attribute [rw] next_token
721
+ # NextToken string is used when calling ListPlatformApplications
722
+ # action to retrieve additional records that are available after the
723
+ # first page results.
724
+ # @return [String]
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsInput AWS API Documentation
727
+ #
728
+ class ListPlatformApplicationsInput < Struct.new(
729
+ :next_token)
730
+ include Aws::Structure
731
+ end
615
732
 
616
- # Input for ListSubscriptionsByTopic action.
617
- # @note When making an API call, pass ListSubscriptionsByTopicInput
618
- # data as a hash:
619
- #
620
- # {
621
- # topic_arn: "topicARN", # required
622
- # next_token: "nextToken",
623
- # }
624
- # @!attribute [rw] topic_arn
625
- # The ARN of the topic for which you wish to find subscriptions.
626
- # @return [String]
627
- #
628
- # @!attribute [rw] next_token
629
- # Token returned by the previous `ListSubscriptionsByTopic` request.
630
- # @return [String]
631
- class ListSubscriptionsByTopicInput < Struct.new(
632
- :topic_arn,
633
- :next_token)
634
- include Aws::Structure
635
- end
733
+ # Response for ListPlatformApplications action.
734
+ #
735
+ # @!attribute [rw] platform_applications
736
+ # Platform applications returned when calling ListPlatformApplications
737
+ # action.
738
+ # @return [Array<Types::PlatformApplication>]
739
+ #
740
+ # @!attribute [rw] next_token
741
+ # NextToken string is returned when calling ListPlatformApplications
742
+ # action if additional records are available after the first page
743
+ # results.
744
+ # @return [String]
745
+ #
746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsResponse AWS API Documentation
747
+ #
748
+ class ListPlatformApplicationsResponse < Struct.new(
749
+ :platform_applications,
750
+ :next_token)
751
+ include Aws::Structure
752
+ end
636
753
 
637
- # Response for ListSubscriptionsByTopic action.
638
- # @!attribute [rw] subscriptions
639
- # A list of subscriptions.
640
- # @return [Array<Types::Subscription>]
641
- #
642
- # @!attribute [rw] next_token
643
- # Token to pass along to the next `ListSubscriptionsByTopic` request.
644
- # This element is returned if there are more subscriptions to
645
- # retrieve.
646
- # @return [String]
647
- class ListSubscriptionsByTopicResponse < Struct.new(
648
- :subscriptions,
649
- :next_token)
650
- include Aws::Structure
651
- end
754
+ # Input for ListSubscriptionsByTopic action.
755
+ #
756
+ # @note When making an API call, you may pass ListSubscriptionsByTopicInput
757
+ # data as a hash:
758
+ #
759
+ # {
760
+ # topic_arn: "topicARN", # required
761
+ # next_token: "nextToken",
762
+ # }
763
+ #
764
+ # @!attribute [rw] topic_arn
765
+ # The ARN of the topic for which you wish to find subscriptions.
766
+ # @return [String]
767
+ #
768
+ # @!attribute [rw] next_token
769
+ # Token returned by the previous `ListSubscriptionsByTopic` request.
770
+ # @return [String]
771
+ #
772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopicInput AWS API Documentation
773
+ #
774
+ class ListSubscriptionsByTopicInput < Struct.new(
775
+ :topic_arn,
776
+ :next_token)
777
+ include Aws::Structure
778
+ end
652
779
 
653
- # Input for ListSubscriptions action.
654
- # @note When making an API call, pass ListSubscriptionsInput
655
- # data as a hash:
656
- #
657
- # {
658
- # next_token: "nextToken",
659
- # }
660
- # @!attribute [rw] next_token
661
- # Token returned by the previous `ListSubscriptions` request.
662
- # @return [String]
663
- class ListSubscriptionsInput < Struct.new(
664
- :next_token)
665
- include Aws::Structure
666
- end
780
+ # Response for ListSubscriptionsByTopic action.
781
+ #
782
+ # @!attribute [rw] subscriptions
783
+ # A list of subscriptions.
784
+ # @return [Array<Types::Subscription>]
785
+ #
786
+ # @!attribute [rw] next_token
787
+ # Token to pass along to the next `ListSubscriptionsByTopic` request.
788
+ # This element is returned if there are more subscriptions to
789
+ # retrieve.
790
+ # @return [String]
791
+ #
792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsByTopicResponse AWS API Documentation
793
+ #
794
+ class ListSubscriptionsByTopicResponse < Struct.new(
795
+ :subscriptions,
796
+ :next_token)
797
+ include Aws::Structure
798
+ end
667
799
 
668
- # Response for ListSubscriptions action
669
- # @!attribute [rw] subscriptions
670
- # A list of subscriptions.
671
- # @return [Array<Types::Subscription>]
672
- #
673
- # @!attribute [rw] next_token
674
- # Token to pass along to the next `ListSubscriptions` request. This
675
- # element is returned if there are more subscriptions to retrieve.
676
- # @return [String]
677
- class ListSubscriptionsResponse < Struct.new(
678
- :subscriptions,
679
- :next_token)
680
- include Aws::Structure
681
- end
800
+ # Input for ListSubscriptions action.
801
+ #
802
+ # @note When making an API call, you may pass ListSubscriptionsInput
803
+ # data as a hash:
804
+ #
805
+ # {
806
+ # next_token: "nextToken",
807
+ # }
808
+ #
809
+ # @!attribute [rw] next_token
810
+ # Token returned by the previous `ListSubscriptions` request.
811
+ # @return [String]
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsInput AWS API Documentation
814
+ #
815
+ class ListSubscriptionsInput < Struct.new(
816
+ :next_token)
817
+ include Aws::Structure
818
+ end
682
819
 
683
- # @note When making an API call, pass ListTopicsInput
684
- # data as a hash:
685
- #
686
- # {
687
- # next_token: "nextToken",
688
- # }
689
- # @!attribute [rw] next_token
690
- # Token returned by the previous `ListTopics` request.
691
- # @return [String]
692
- class ListTopicsInput < Struct.new(
693
- :next_token)
694
- include Aws::Structure
695
- end
820
+ # Response for ListSubscriptions action
821
+ #
822
+ # @!attribute [rw] subscriptions
823
+ # A list of subscriptions.
824
+ # @return [Array<Types::Subscription>]
825
+ #
826
+ # @!attribute [rw] next_token
827
+ # Token to pass along to the next `ListSubscriptions` request. This
828
+ # element is returned if there are more subscriptions to retrieve.
829
+ # @return [String]
830
+ #
831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListSubscriptionsResponse AWS API Documentation
832
+ #
833
+ class ListSubscriptionsResponse < Struct.new(
834
+ :subscriptions,
835
+ :next_token)
836
+ include Aws::Structure
837
+ end
696
838
 
697
- # Response for ListTopics action.
698
- # @!attribute [rw] topics
699
- # A list of topic ARNs.
700
- # @return [Array<Types::Topic>]
701
- #
702
- # @!attribute [rw] next_token
703
- # Token to pass along to the next `ListTopics` request. This element
704
- # is returned if there are additional topics to retrieve.
705
- # @return [String]
706
- class ListTopicsResponse < Struct.new(
707
- :topics,
708
- :next_token)
709
- include Aws::Structure
710
- end
839
+ # @note When making an API call, you may pass ListTopicsInput
840
+ # data as a hash:
841
+ #
842
+ # {
843
+ # next_token: "nextToken",
844
+ # }
845
+ #
846
+ # @!attribute [rw] next_token
847
+ # Token returned by the previous `ListTopics` request.
848
+ # @return [String]
849
+ #
850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopicsInput AWS API Documentation
851
+ #
852
+ class ListTopicsInput < Struct.new(
853
+ :next_token)
854
+ include Aws::Structure
855
+ end
711
856
 
712
- # The user-specified message attribute value. For string data types, the
713
- # value attribute has the same restrictions on the content as the
714
- # message body. For more information, see [Publish][1].
715
- #
716
- # Name, type, and value must not be empty or null. In addition, the
717
- # message body should not be empty or null. All parts of the message
718
- # attribute, including name, type, and value, are included in the
719
- # message size restriction, which is currently 256 KB (262,144 bytes).
720
- # For more information, see [Using Amazon SNS Message Attributes][2].
721
- #
722
- #
723
- #
724
- # [1]: http://docs.aws.amazon.com/sns/latest/api/API_Publish.html
725
- # [2]: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
726
- # @note When making an API call, pass MessageAttributeValue
727
- # data as a hash:
728
- #
729
- # {
730
- # data_type: "String", # required
731
- # string_value: "String",
732
- # binary_value: "data",
733
- # }
734
- # @!attribute [rw] data_type
735
- # Amazon SNS supports the following logical data types: String,
736
- # Number, and Binary. For more information, see [Message Attribute
737
- # Data Types][1].
738
- #
739
- #
740
- #
741
- # [1]: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes
742
- # @return [String]
743
- #
744
- # @!attribute [rw] string_value
745
- # Strings are Unicode with UTF8 binary encoding. For a list of code
746
- # values, see
747
- # [http://en.wikipedia.org/wiki/ASCII#ASCII\_printable\_characters][1].
748
- #
749
- #
750
- #
751
- # [1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
752
- # @return [String]
753
- #
754
- # @!attribute [rw] binary_value
755
- # Binary type attributes can store any binary data, for example,
756
- # compressed data, encrypted data, or images.
757
- # @return [String]
758
- class MessageAttributeValue < Struct.new(
759
- :data_type,
760
- :string_value,
761
- :binary_value)
762
- include Aws::Structure
763
- end
857
+ # Response for ListTopics action.
858
+ #
859
+ # @!attribute [rw] topics
860
+ # A list of topic ARNs.
861
+ # @return [Array<Types::Topic>]
862
+ #
863
+ # @!attribute [rw] next_token
864
+ # Token to pass along to the next `ListTopics` request. This element
865
+ # is returned if there are additional topics to retrieve.
866
+ # @return [String]
867
+ #
868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListTopicsResponse AWS API Documentation
869
+ #
870
+ class ListTopicsResponse < Struct.new(
871
+ :topics,
872
+ :next_token)
873
+ include Aws::Structure
874
+ end
764
875
 
765
- # Input for the OptInPhoneNumber action.
766
- # @note When making an API call, pass OptInPhoneNumberInput
767
- # data as a hash:
768
- #
769
- # {
770
- # phone_number: "PhoneNumber", # required
771
- # }
772
- # @!attribute [rw] phone_number
773
- # The phone number to opt in.
774
- # @return [String]
775
- class OptInPhoneNumberInput < Struct.new(
776
- :phone_number)
777
- include Aws::Structure
778
- end
876
+ # The user-specified message attribute value. For string data types, the
877
+ # value attribute has the same restrictions on the content as the
878
+ # message body. For more information, see [Publish][1].
879
+ #
880
+ # Name, type, and value must not be empty or null. In addition, the
881
+ # message body should not be empty or null. All parts of the message
882
+ # attribute, including name, type, and value, are included in the
883
+ # message size restriction, which is currently 256 KB (262,144 bytes).
884
+ # For more information, see [Using Amazon SNS Message Attributes][2].
885
+ #
886
+ #
887
+ #
888
+ # [1]: http://docs.aws.amazon.com/sns/latest/api/API_Publish.html
889
+ # [2]: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html
890
+ #
891
+ # @note When making an API call, you may pass MessageAttributeValue
892
+ # data as a hash:
893
+ #
894
+ # {
895
+ # data_type: "String", # required
896
+ # string_value: "String",
897
+ # binary_value: "data",
898
+ # }
899
+ #
900
+ # @!attribute [rw] data_type
901
+ # Amazon SNS supports the following logical data types: String,
902
+ # Number, and Binary. For more information, see [Message Attribute
903
+ # Data Types][1].
904
+ #
905
+ #
906
+ #
907
+ # [1]: http://docs.aws.amazon.com/sns/latest/dg/SNSMessageAttributes.html#SNSMessageAttributes.DataTypes
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] string_value
911
+ # Strings are Unicode with UTF8 binary encoding. For a list of code
912
+ # values, see
913
+ # [http://en.wikipedia.org/wiki/ASCII#ASCII\_printable\_characters][1].
914
+ #
915
+ #
916
+ #
917
+ # [1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
918
+ # @return [String]
919
+ #
920
+ # @!attribute [rw] binary_value
921
+ # Binary type attributes can store any binary data, for example,
922
+ # compressed data, encrypted data, or images.
923
+ # @return [String]
924
+ #
925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/MessageAttributeValue AWS API Documentation
926
+ #
927
+ class MessageAttributeValue < Struct.new(
928
+ :data_type,
929
+ :string_value,
930
+ :binary_value)
931
+ include Aws::Structure
932
+ end
779
933
 
780
- # The response for the OptInPhoneNumber action.
781
- class OptInPhoneNumberResponse < Aws::EmptyStructure; end
934
+ # Input for the OptInPhoneNumber action.
935
+ #
936
+ # @note When making an API call, you may pass OptInPhoneNumberInput
937
+ # data as a hash:
938
+ #
939
+ # {
940
+ # phone_number: "PhoneNumber", # required
941
+ # }
942
+ #
943
+ # @!attribute [rw] phone_number
944
+ # The phone number to opt in.
945
+ # @return [String]
946
+ #
947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumberInput AWS API Documentation
948
+ #
949
+ class OptInPhoneNumberInput < Struct.new(
950
+ :phone_number)
951
+ include Aws::Structure
952
+ end
782
953
 
783
- # Platform application object.
784
- # @!attribute [rw] platform_application_arn
785
- # PlatformApplicationArn for platform application object.
786
- # @return [String]
787
- #
788
- # @!attribute [rw] attributes
789
- # Attributes for platform application object.
790
- # @return [Hash<String,String>]
791
- class PlatformApplication < Struct.new(
792
- :platform_application_arn,
793
- :attributes)
794
- include Aws::Structure
795
- end
954
+ # The response for the OptInPhoneNumber action.
955
+ #
956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/OptInPhoneNumberResponse AWS API Documentation
957
+ #
958
+ class OptInPhoneNumberResponse < Aws::EmptyStructure; end
796
959
 
797
- # Input for Publish action.
798
- # @note When making an API call, pass PublishInput
799
- # data as a hash:
800
- #
801
- # {
802
- # topic_arn: "topicARN",
803
- # target_arn: "String",
804
- # phone_number: "String",
805
- # message: "message", # required
806
- # subject: "subject",
807
- # message_structure: "messageStructure",
808
- # message_attributes: {
809
- # "String" => {
810
- # data_type: "String", # required
811
- # string_value: "String",
812
- # binary_value: "data",
813
- # },
814
- # },
815
- # }
816
- # @!attribute [rw] topic_arn
817
- # The topic you want to publish to.
818
- #
819
- # If you don't specify a value for the `TopicArn` parameter, you must
820
- # specify a value for the `PhoneNumber` or `TargetArn` parameters.
821
- # @return [String]
822
- #
823
- # @!attribute [rw] target_arn
824
- # Either TopicArn or EndpointArn, but not both.
825
- #
826
- # If you don't specify a value for the `TargetArn` parameter, you
827
- # must specify a value for the `PhoneNumber` or `TopicArn` parameters.
828
- # @return [String]
829
- #
830
- # @!attribute [rw] phone_number
831
- # The phone number to which you want to deliver an SMS message. Use
832
- # E.164 format.
833
- #
834
- # If you don't specify a value for the `PhoneNumber` parameter, you
835
- # must specify a value for the `TargetArn` or `TopicArn` parameters.
836
- # @return [String]
837
- #
838
- # @!attribute [rw] message
839
- # The message you want to send to the topic.
840
- #
841
- # If you want to send the same message to all transport protocols,
842
- # include the text of the message as a String value.
843
- #
844
- # If you want to send different messages for each transport protocol,
845
- # set the value of the `MessageStructure` parameter to `json` and use
846
- # a JSON object for the `Message` parameter.
847
- #
848
- # Constraints: Messages must be UTF-8 encoded strings at most 256 KB
849
- # in size (262144 bytes, not 262144 characters).
850
- #
851
- # JSON-specific constraints:
852
- #
853
- # * Keys in the JSON object that correspond to supported transport
854
- # protocols must have simple JSON string values.
855
- #
856
- # * The values will be parsed (unescaped) before they are used in
857
- # outgoing messages.
858
- #
859
- # * Outbound notifications are JSON encoded (meaning that the
860
- # characters will be reescaped for sending).
861
- #
862
- # * Values have a minimum length of 0 (the empty string, "", is
863
- # allowed).
864
- #
865
- # * Values have a maximum length bounded by the overall message size
866
- # (so, including multiple protocols may limit message sizes).
867
- #
868
- # * Non-string values will cause the key to be ignored.
869
- #
870
- # * Keys that do not correspond to supported transport protocols are
871
- # ignored.
872
- #
873
- # * Duplicate keys are not allowed.
874
- #
875
- # * Failure to parse or validate any key or value in the message will
876
- # cause the `Publish` call to return an error (no partial delivery).
877
- # @return [String]
878
- #
879
- # @!attribute [rw] subject
880
- # Optional parameter to be used as the "Subject" line when the
881
- # message is delivered to email endpoints. This field will also be
882
- # included, if present, in the standard JSON messages delivered to
883
- # other endpoints.
884
- #
885
- # Constraints: Subjects must be ASCII text that begins with a letter,
886
- # number, or punctuation mark; must not include line breaks or control
887
- # characters; and must be less than 100 characters long.
888
- # @return [String]
889
- #
890
- # @!attribute [rw] message_structure
891
- # Set `MessageStructure` to `json` if you want to send a different
892
- # message for each protocol. For example, using one publish action,
893
- # you can send a short message to your SMS subscribers and a longer
894
- # message to your email subscribers. If you set `MessageStructure` to
895
- # `json`, the value of the `Message` parameter must:
896
- #
897
- # * be a syntactically valid JSON object; and
898
- #
899
- # * contain at least a top-level JSON key of "default" with a value
900
- # that is a string.
901
- #
902
- # You can define other top-level keys that define the message you want
903
- # to send to a specific transport protocol (e.g., "http").
904
- #
905
- # For information about sending different messages for each protocol
906
- # using the AWS Management Console, go to [Create Different Messages
907
- # for Each Protocol][1] in the *Amazon Simple Notification Service
908
- # Getting Started Guide*.
909
- #
910
- # Valid value: `json`
911
- #
912
- #
913
- #
914
- # [1]: http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
915
- # @return [String]
916
- #
917
- # @!attribute [rw] message_attributes
918
- # Message attributes for Publish action.
919
- # @return [Hash<String,Types::MessageAttributeValue>]
920
- class PublishInput < Struct.new(
921
- :topic_arn,
922
- :target_arn,
923
- :phone_number,
924
- :message,
925
- :subject,
926
- :message_structure,
927
- :message_attributes)
928
- include Aws::Structure
929
- end
960
+ # Platform application object.
961
+ #
962
+ # @!attribute [rw] platform_application_arn
963
+ # PlatformApplicationArn for platform application object.
964
+ # @return [String]
965
+ #
966
+ # @!attribute [rw] attributes
967
+ # Attributes for platform application object.
968
+ # @return [Hash<String,String>]
969
+ #
970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PlatformApplication AWS API Documentation
971
+ #
972
+ class PlatformApplication < Struct.new(
973
+ :platform_application_arn,
974
+ :attributes)
975
+ include Aws::Structure
976
+ end
930
977
 
931
- # Response for Publish action.
932
- # @!attribute [rw] message_id
933
- # Unique identifier assigned to the published message.
934
- #
935
- # Length Constraint: Maximum 100 characters
936
- # @return [String]
937
- class PublishResponse < Struct.new(
938
- :message_id)
939
- include Aws::Structure
940
- end
978
+ # Input for Publish action.
979
+ #
980
+ # @note When making an API call, you may pass PublishInput
981
+ # data as a hash:
982
+ #
983
+ # {
984
+ # topic_arn: "topicARN",
985
+ # target_arn: "String",
986
+ # phone_number: "String",
987
+ # message: "message", # required
988
+ # subject: "subject",
989
+ # message_structure: "messageStructure",
990
+ # message_attributes: {
991
+ # "String" => {
992
+ # data_type: "String", # required
993
+ # string_value: "String",
994
+ # binary_value: "data",
995
+ # },
996
+ # },
997
+ # }
998
+ #
999
+ # @!attribute [rw] topic_arn
1000
+ # The topic you want to publish to.
1001
+ #
1002
+ # If you don't specify a value for the `TopicArn` parameter, you must
1003
+ # specify a value for the `PhoneNumber` or `TargetArn` parameters.
1004
+ # @return [String]
1005
+ #
1006
+ # @!attribute [rw] target_arn
1007
+ # Either TopicArn or EndpointArn, but not both.
1008
+ #
1009
+ # If you don't specify a value for the `TargetArn` parameter, you
1010
+ # must specify a value for the `PhoneNumber` or `TopicArn` parameters.
1011
+ # @return [String]
1012
+ #
1013
+ # @!attribute [rw] phone_number
1014
+ # The phone number to which you want to deliver an SMS message. Use
1015
+ # E.164 format.
1016
+ #
1017
+ # If you don't specify a value for the `PhoneNumber` parameter, you
1018
+ # must specify a value for the `TargetArn` or `TopicArn` parameters.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] message
1022
+ # The message you want to send to the topic.
1023
+ #
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
+ #
1027
+ # If you want to send different messages for each transport protocol,
1028
+ # set the value of the `MessageStructure` parameter to `json` and use
1029
+ # a JSON object for the `Message` parameter.
1030
+ #
1031
+ # Constraints: Messages must be UTF-8 encoded strings at most 256 KB
1032
+ # in size (262144 bytes, not 262144 characters).
1033
+ #
1034
+ # JSON-specific constraints:
1035
+ #
1036
+ # * Keys in the JSON object that correspond to supported transport
1037
+ # protocols must have simple JSON string values.
1038
+ #
1039
+ # * The values will be parsed (unescaped) before they are used in
1040
+ # outgoing messages.
1041
+ #
1042
+ # * Outbound notifications are JSON encoded (meaning that the
1043
+ # characters will be reescaped for sending).
1044
+ #
1045
+ # * Values have a minimum length of 0 (the empty string, "", is
1046
+ # allowed).
1047
+ #
1048
+ # * Values have a maximum length bounded by the overall message size
1049
+ # (so, including multiple protocols may limit message sizes).
1050
+ #
1051
+ # * Non-string values will cause the key to be ignored.
1052
+ #
1053
+ # * Keys that do not correspond to supported transport protocols are
1054
+ # ignored.
1055
+ #
1056
+ # * Duplicate keys are not allowed.
1057
+ #
1058
+ # * Failure to parse or validate any key or value in the message will
1059
+ # cause the `Publish` call to return an error (no partial delivery).
1060
+ # @return [String]
1061
+ #
1062
+ # @!attribute [rw] subject
1063
+ # Optional parameter to be used as the "Subject" line when the
1064
+ # message is delivered to email endpoints. This field will also be
1065
+ # included, if present, in the standard JSON messages delivered to
1066
+ # other endpoints.
1067
+ #
1068
+ # Constraints: Subjects must be ASCII text that begins with a letter,
1069
+ # number, or punctuation mark; must not include line breaks or control
1070
+ # characters; and must be less than 100 characters long.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] message_structure
1074
+ # Set `MessageStructure` to `json` if you want to send a different
1075
+ # message for each protocol. For example, using one publish action,
1076
+ # you can send a short message to your SMS subscribers and a longer
1077
+ # message to your email subscribers. If you set `MessageStructure` to
1078
+ # `json`, the value of the `Message` parameter must:
1079
+ #
1080
+ # * be a syntactically valid JSON object; and
1081
+ #
1082
+ # * contain at least a top-level JSON key of "default" with a value
1083
+ # that is a string.
1084
+ #
1085
+ # You can define other top-level keys that define the message you want
1086
+ # to send to a specific transport protocol (e.g., "http").
1087
+ #
1088
+ # For information about sending different messages for each protocol
1089
+ # using the AWS Management Console, go to [Create Different Messages
1090
+ # for Each Protocol][1] in the *Amazon Simple Notification Service
1091
+ # Getting Started Guide*.
1092
+ #
1093
+ # Valid value: `json`
1094
+ #
1095
+ #
1096
+ #
1097
+ # [1]: http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
1098
+ # @return [String]
1099
+ #
1100
+ # @!attribute [rw] message_attributes
1101
+ # Message attributes for Publish action.
1102
+ # @return [Hash<String,Types::MessageAttributeValue>]
1103
+ #
1104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishInput AWS API Documentation
1105
+ #
1106
+ class PublishInput < Struct.new(
1107
+ :topic_arn,
1108
+ :target_arn,
1109
+ :phone_number,
1110
+ :message,
1111
+ :subject,
1112
+ :message_structure,
1113
+ :message_attributes)
1114
+ include Aws::Structure
1115
+ end
941
1116
 
942
- # Input for RemovePermission action.
943
- # @note When making an API call, pass RemovePermissionInput
944
- # data as a hash:
945
- #
946
- # {
947
- # topic_arn: "topicARN", # required
948
- # label: "label", # required
949
- # }
950
- # @!attribute [rw] topic_arn
951
- # The ARN of the topic whose access control policy you wish to modify.
952
- # @return [String]
953
- #
954
- # @!attribute [rw] label
955
- # The unique label of the statement you want to remove.
956
- # @return [String]
957
- class RemovePermissionInput < Struct.new(
958
- :topic_arn,
959
- :label)
960
- include Aws::Structure
961
- end
1117
+ # Response for Publish action.
1118
+ #
1119
+ # @!attribute [rw] message_id
1120
+ # Unique identifier assigned to the published message.
1121
+ #
1122
+ # Length Constraint: Maximum 100 characters
1123
+ # @return [String]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/PublishResponse AWS API Documentation
1126
+ #
1127
+ class PublishResponse < Struct.new(
1128
+ :message_id)
1129
+ include Aws::Structure
1130
+ end
962
1131
 
963
- # Input for SetEndpointAttributes action.
964
- # @note When making an API call, pass SetEndpointAttributesInput
965
- # data as a hash:
966
- #
967
- # {
968
- # endpoint_arn: "String", # required
969
- # attributes: { # required
970
- # "String" => "String",
971
- # },
972
- # }
973
- # @!attribute [rw] endpoint_arn
974
- # EndpointArn used for SetEndpointAttributes action.
975
- # @return [String]
976
- #
977
- # @!attribute [rw] attributes
978
- # A map of the endpoint attributes. Attributes in this map include the
979
- # following:
980
- #
981
- # * `CustomUserData` -- arbitrary user data to associate with the
982
- # endpoint. Amazon SNS does not use this data. The data must be in
983
- # UTF-8 format and less than 2KB.
984
- #
985
- # * `Enabled` -- flag that enables/disables delivery to the endpoint.
986
- # Amazon SNS will set this to false when a notification service
987
- # indicates to Amazon SNS that the endpoint is invalid. Users can
988
- # set it back to true, typically after updating Token.
989
- #
990
- # * `Token` -- device token, also referred to as a registration id,
991
- # for an app and mobile device. This is returned from the
992
- # notification service when an app and mobile device are registered
993
- # with the notification service.
994
- # @return [Hash<String,String>]
995
- class SetEndpointAttributesInput < Struct.new(
996
- :endpoint_arn,
997
- :attributes)
998
- include Aws::Structure
999
- end
1132
+ # Input for RemovePermission action.
1133
+ #
1134
+ # @note When making an API call, you may pass RemovePermissionInput
1135
+ # data as a hash:
1136
+ #
1137
+ # {
1138
+ # topic_arn: "topicARN", # required
1139
+ # label: "label", # required
1140
+ # }
1141
+ #
1142
+ # @!attribute [rw] topic_arn
1143
+ # The ARN of the topic whose access control policy you wish to modify.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] label
1147
+ # The unique label of the statement you want to remove.
1148
+ # @return [String]
1149
+ #
1150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/RemovePermissionInput AWS API Documentation
1151
+ #
1152
+ class RemovePermissionInput < Struct.new(
1153
+ :topic_arn,
1154
+ :label)
1155
+ include Aws::Structure
1156
+ end
1000
1157
 
1001
- # Input for SetPlatformApplicationAttributes action.
1002
- # @note When making an API call, pass SetPlatformApplicationAttributesInput
1003
- # data as a hash:
1004
- #
1005
- # {
1006
- # platform_application_arn: "String", # required
1007
- # attributes: { # required
1008
- # "String" => "String",
1009
- # },
1010
- # }
1011
- # @!attribute [rw] platform_application_arn
1012
- # PlatformApplicationArn for SetPlatformApplicationAttributes action.
1013
- # @return [String]
1014
- #
1015
- # @!attribute [rw] attributes
1016
- # A map of the platform application attributes. Attributes in this map
1017
- # include the following:
1018
- #
1019
- # * `PlatformCredential` -- The credential received from the
1020
- # notification service. For APNS/APNS\_SANDBOX, PlatformCredential
1021
- # is private key. For GCM, PlatformCredential is "API key". For
1022
- # ADM, PlatformCredential is "client secret".
1023
- #
1024
- # * `PlatformPrincipal` -- The principal received from the
1025
- # notification service. For APNS/APNS\_SANDBOX, PlatformPrincipal is
1026
- # SSL certificate. For GCM, PlatformPrincipal is not applicable. For
1027
- # ADM, PlatformPrincipal is "client id".
1028
- #
1029
- # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
1030
- # notifications should be sent.
1031
- #
1032
- # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
1033
- # notifications should be sent.
1034
- #
1035
- # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
1036
- # notifications should be sent.
1037
- #
1038
- # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
1039
- # notifications should be sent upon Direct Publish delivery failure
1040
- # (permanent) to one of the application's endpoints.
1041
- #
1042
- # * `SuccessFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
1043
- # write access to use CloudWatch Logs on your behalf.
1044
- #
1045
- # * `FailureFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
1046
- # write access to use CloudWatch Logs on your behalf.
1047
- #
1048
- # * `SuccessFeedbackSampleRate` -- Sample rate percentage (0-100) of
1049
- # successfully delivered messages.
1050
- # @return [Hash<String,String>]
1051
- class SetPlatformApplicationAttributesInput < Struct.new(
1052
- :platform_application_arn,
1053
- :attributes)
1054
- include Aws::Structure
1055
- end
1158
+ # Input for SetEndpointAttributes action.
1159
+ #
1160
+ # @note When making an API call, you may pass SetEndpointAttributesInput
1161
+ # data as a hash:
1162
+ #
1163
+ # {
1164
+ # endpoint_arn: "String", # required
1165
+ # attributes: { # required
1166
+ # "String" => "String",
1167
+ # },
1168
+ # }
1169
+ #
1170
+ # @!attribute [rw] endpoint_arn
1171
+ # EndpointArn used for SetEndpointAttributes action.
1172
+ # @return [String]
1173
+ #
1174
+ # @!attribute [rw] attributes
1175
+ # A map of the endpoint attributes. Attributes in this map include the
1176
+ # following:
1177
+ #
1178
+ # * `CustomUserData` -- arbitrary user data to associate with the
1179
+ # endpoint. Amazon SNS does not use this data. The data must be in
1180
+ # UTF-8 format and less than 2KB.
1181
+ #
1182
+ # * `Enabled` -- flag that enables/disables delivery to the endpoint.
1183
+ # Amazon SNS will set this to false when a notification service
1184
+ # indicates to Amazon SNS that the endpoint is invalid. Users can
1185
+ # set it back to true, typically after updating Token.
1186
+ #
1187
+ # * `Token` -- device token, also referred to as a registration id,
1188
+ # for an app and mobile device. This is returned from the
1189
+ # notification service when an app and mobile device are registered
1190
+ # with the notification service.
1191
+ # @return [Hash<String,String>]
1192
+ #
1193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetEndpointAttributesInput AWS API Documentation
1194
+ #
1195
+ class SetEndpointAttributesInput < Struct.new(
1196
+ :endpoint_arn,
1197
+ :attributes)
1198
+ include Aws::Structure
1199
+ end
1056
1200
 
1057
- # The input for the SetSMSAttributes action.
1058
- # @note When making an API call, pass SetSMSAttributesInput
1059
- # data as a hash:
1060
- #
1061
- # {
1062
- # attributes: { # required
1063
- # "String" => "String",
1064
- # },
1065
- # }
1066
- # @!attribute [rw] attributes
1067
- # The default settings for sending SMS messages from your account. You
1068
- # can set values for the following attribute names:
1069
- #
1070
- # `MonthlySpendLimit` The maximum amount in USD that you are willing
1071
- # to spend each month to send SMS messages. When Amazon SNS determines
1072
- # that sending an SMS message would incur a cost that exceeds this
1073
- # limit, it stops sending SMS messages within minutes.
1074
- #
1075
- # Amazon SNS stops sending SMS messages within minutes of the limit
1076
- # being crossed. During that interval, if you continue to send SMS
1077
- # messages, you will incur costs that exceed your limit.
1078
- #
1079
- # By default, the spend limit is set to the maximum allowed by Amazon
1080
- # SNS. If you want to exceed the maximum, contact [AWS Support][1] or
1081
- # your AWS sales representative for a service limit increase.
1082
- #
1083
- # `DeliveryStatusIAMRole` The ARN of the IAM role that allows Amazon
1084
- # SNS to write logs about SMS deliveries in CloudWatch Logs. For each
1085
- # SMS message that you send, Amazon SNS writes a log that includes the
1086
- # message price, the success or failure status, the reason for failure
1087
- # (if the message failed), the message dwell time, and other
1088
- # information.
1089
- #
1090
- # `DeliveryStatusSuccessSamplingRate` The percentage of successful
1091
- # SMS deliveries for which Amazon SNS will write logs in CloudWatch
1092
- # Logs. The value can be an integer from 0 - 100. For example, to
1093
- # write logs only for failed deliveries, set this value to `0`. To
1094
- # write logs for 10% of your successful deliveries, set it to `10`.
1095
- #
1096
- # `DefaultSenderID` A string, such as your business brand, that is
1097
- # displayed as the sender on the receiving device. Support for sender
1098
- # IDs varies by country. The sender ID can be 1 - 11 alphanumeric
1099
- # characters, and it must contain at least one letter.
1100
- #
1101
- # `DefaultSMSType` The type of SMS message that you will send by
1102
- # default. You can assign the following values:
1103
- #
1104
- # * `Promotional` (Default) Noncritical messages, such as marketing
1105
- # messages. Amazon SNS optimizes the message delivery to incur the
1106
- # lowest cost.
1107
- #
1108
- # * `Transactional` – Critical messages that support customer
1109
- # transactions, such as one-time passcodes for multi-factor
1110
- # authentication. Amazon SNS optimizes the message delivery to
1111
- # achieve the highest reliability.
1112
- #
1113
- # `UsageReportS3Bucket` – The name of the Amazon S3 bucket to receive
1114
- # daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will
1115
- # deliver a usage report as a CSV file to the bucket. The report
1116
- # includes the following information for each SMS message that was
1117
- # successfully delivered by your account:
1118
- #
1119
- # * Time that the message was published (in UTC)
1120
- #
1121
- # * Message ID
1122
- #
1123
- # * Destination phone number
1124
- #
1125
- # * Message type
1126
- #
1127
- # * Delivery status
1128
- #
1129
- # * Message price (in USD)
1130
- #
1131
- # * Part number (a message is split into multiple parts if it is too
1132
- # long for a single message)
1133
- #
1134
- # * Total number of parts
1135
- #
1136
- # To receive the report, the bucket must have a policy that allows the
1137
- # Amazon SNS service principle to perform the `s3:PutObject` and
1138
- # `s3:GetBucketLocation` actions.
1139
- #
1140
- # For an example bucket policy and usage report, see [Monitoring SMS
1141
- # Activity][2] in the *Amazon SNS Developer Guide*.
1142
- #
1143
- #
1144
- #
1145
- # [1]: https://aws.amazon.com/premiumsupport/
1146
- # [2]: http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html
1147
- # @return [Hash<String,String>]
1148
- class SetSMSAttributesInput < Struct.new(
1149
- :attributes)
1150
- include Aws::Structure
1151
- end
1201
+ # Input for SetPlatformApplicationAttributes action.
1202
+ #
1203
+ # @note When making an API call, you may pass SetPlatformApplicationAttributesInput
1204
+ # data as a hash:
1205
+ #
1206
+ # {
1207
+ # platform_application_arn: "String", # required
1208
+ # attributes: { # required
1209
+ # "String" => "String",
1210
+ # },
1211
+ # }
1212
+ #
1213
+ # @!attribute [rw] platform_application_arn
1214
+ # PlatformApplicationArn for SetPlatformApplicationAttributes action.
1215
+ # @return [String]
1216
+ #
1217
+ # @!attribute [rw] attributes
1218
+ # A map of the platform application attributes. Attributes in this map
1219
+ # include the following:
1220
+ #
1221
+ # * `PlatformCredential` -- The credential received from the
1222
+ # notification service. For APNS/APNS\_SANDBOX, PlatformCredential
1223
+ # is private key. For GCM, PlatformCredential is "API key". For
1224
+ # ADM, PlatformCredential is "client secret".
1225
+ #
1226
+ # * `PlatformPrincipal` -- The principal received from the
1227
+ # notification service. For APNS/APNS\_SANDBOX, PlatformPrincipal is
1228
+ # SSL certificate. For GCM, PlatformPrincipal is not applicable. For
1229
+ # ADM, PlatformPrincipal is "client id".
1230
+ #
1231
+ # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
1232
+ # notifications should be sent.
1233
+ #
1234
+ # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
1235
+ # notifications should be sent.
1236
+ #
1237
+ # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
1238
+ # notifications should be sent.
1239
+ #
1240
+ # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
1241
+ # notifications should be sent upon Direct Publish delivery failure
1242
+ # (permanent) to one of the application's endpoints.
1243
+ #
1244
+ # * `SuccessFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
1245
+ # write access to use CloudWatch Logs on your behalf.
1246
+ #
1247
+ # * `FailureFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
1248
+ # write access to use CloudWatch Logs on your behalf.
1249
+ #
1250
+ # * `SuccessFeedbackSampleRate` -- Sample rate percentage (0-100) of
1251
+ # successfully delivered messages.
1252
+ # @return [Hash<String,String>]
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetPlatformApplicationAttributesInput AWS API Documentation
1255
+ #
1256
+ class SetPlatformApplicationAttributesInput < Struct.new(
1257
+ :platform_application_arn,
1258
+ :attributes)
1259
+ include Aws::Structure
1260
+ end
1152
1261
 
1153
- # The response for the SetSMSAttributes action.
1154
- class SetSMSAttributesResponse < Aws::EmptyStructure; end
1262
+ # The input for the SetSMSAttributes action.
1263
+ #
1264
+ # @note When making an API call, you may pass SetSMSAttributesInput
1265
+ # data as a hash:
1266
+ #
1267
+ # {
1268
+ # attributes: { # required
1269
+ # "String" => "String",
1270
+ # },
1271
+ # }
1272
+ #
1273
+ # @!attribute [rw] attributes
1274
+ # The default settings for sending SMS messages from your account. You
1275
+ # can set values for the following attribute names:
1276
+ #
1277
+ # `MonthlySpendLimit` – The maximum amount in USD that you are willing
1278
+ # to spend each month to send SMS messages. When Amazon SNS determines
1279
+ # that sending an SMS message would incur a cost that exceeds this
1280
+ # limit, it stops sending SMS messages within minutes.
1281
+ #
1282
+ # Amazon SNS stops sending SMS messages within minutes of the limit
1283
+ # being crossed. During that interval, if you continue to send SMS
1284
+ # messages, you will incur costs that exceed your limit.
1285
+ #
1286
+ # By default, the spend limit is set to the maximum allowed by Amazon
1287
+ # SNS. If you want to exceed the maximum, contact [AWS Support][1] or
1288
+ # your AWS sales representative for a service limit increase.
1289
+ #
1290
+ # `DeliveryStatusIAMRole` – The ARN of the IAM role that allows Amazon
1291
+ # SNS to write logs about SMS deliveries in CloudWatch Logs. For each
1292
+ # SMS message that you send, Amazon SNS writes a log that includes the
1293
+ # message price, the success or failure status, the reason for failure
1294
+ # (if the message failed), the message dwell time, and other
1295
+ # information.
1296
+ #
1297
+ # `DeliveryStatusSuccessSamplingRate` – The percentage of successful
1298
+ # SMS deliveries for which Amazon SNS will write logs in CloudWatch
1299
+ # Logs. The value can be an integer from 0 - 100. For example, to
1300
+ # write logs only for failed deliveries, set this value to `0`. To
1301
+ # write logs for 10% of your successful deliveries, set it to `10`.
1302
+ #
1303
+ # `DefaultSenderID` – A string, such as your business brand, that is
1304
+ # displayed as the sender on the receiving device. Support for sender
1305
+ # IDs varies by country. The sender ID can be 1 - 11 alphanumeric
1306
+ # characters, and it must contain at least one letter.
1307
+ #
1308
+ # `DefaultSMSType` – The type of SMS message that you will send by
1309
+ # default. You can assign the following values:
1310
+ #
1311
+ # * `Promotional` – (Default) Noncritical messages, such as marketing
1312
+ # messages. Amazon SNS optimizes the message delivery to incur the
1313
+ # lowest cost.
1314
+ #
1315
+ # * `Transactional` – Critical messages that support customer
1316
+ # transactions, such as one-time passcodes for multi-factor
1317
+ # authentication. Amazon SNS optimizes the message delivery to
1318
+ # achieve the highest reliability.
1319
+ #
1320
+ # `UsageReportS3Bucket` – The name of the Amazon S3 bucket to receive
1321
+ # daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will
1322
+ # deliver a usage report as a CSV file to the bucket. The report
1323
+ # includes the following information for each SMS message that was
1324
+ # successfully delivered by your account:
1325
+ #
1326
+ # * Time that the message was published (in UTC)
1327
+ #
1328
+ # * Message ID
1329
+ #
1330
+ # * Destination phone number
1331
+ #
1332
+ # * Message type
1333
+ #
1334
+ # * Delivery status
1335
+ #
1336
+ # * Message price (in USD)
1337
+ #
1338
+ # * Part number (a message is split into multiple parts if it is too
1339
+ # long for a single message)
1340
+ #
1341
+ # * Total number of parts
1342
+ #
1343
+ # To receive the report, the bucket must have a policy that allows the
1344
+ # Amazon SNS service principle to perform the `s3:PutObject` and
1345
+ # `s3:GetBucketLocation` actions.
1346
+ #
1347
+ # For an example bucket policy and usage report, see [Monitoring SMS
1348
+ # Activity][2] in the *Amazon SNS Developer Guide*.
1349
+ #
1350
+ #
1351
+ #
1352
+ # [1]: https://aws.amazon.com/premiumsupport/
1353
+ # [2]: http://docs.aws.amazon.com/sns/latest/dg/sms_stats.html
1354
+ # @return [Hash<String,String>]
1355
+ #
1356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributesInput AWS API Documentation
1357
+ #
1358
+ class SetSMSAttributesInput < Struct.new(
1359
+ :attributes)
1360
+ include Aws::Structure
1361
+ end
1155
1362
 
1156
- # Input for SetSubscriptionAttributes action.
1157
- # @note When making an API call, pass SetSubscriptionAttributesInput
1158
- # data as a hash:
1159
- #
1160
- # {
1161
- # subscription_arn: "subscriptionARN", # required
1162
- # attribute_name: "attributeName", # required
1163
- # attribute_value: "attributeValue",
1164
- # }
1165
- # @!attribute [rw] subscription_arn
1166
- # The ARN of the subscription to modify.
1167
- # @return [String]
1168
- #
1169
- # @!attribute [rw] attribute_name
1170
- # The name of the attribute you want to set. Only a subset of the
1171
- # subscriptions attributes are mutable.
1172
- #
1173
- # Valid values: `DeliveryPolicy` \| `RawMessageDelivery`
1174
- # @return [String]
1175
- #
1176
- # @!attribute [rw] attribute_value
1177
- # The new value for the attribute in JSON format.
1178
- # @return [String]
1179
- class SetSubscriptionAttributesInput < Struct.new(
1180
- :subscription_arn,
1181
- :attribute_name,
1182
- :attribute_value)
1183
- include Aws::Structure
1184
- end
1363
+ # The response for the SetSMSAttributes action.
1364
+ #
1365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSMSAttributesResponse AWS API Documentation
1366
+ #
1367
+ class SetSMSAttributesResponse < Aws::EmptyStructure; end
1185
1368
 
1186
- # Input for SetTopicAttributes action.
1187
- # @note When making an API call, pass SetTopicAttributesInput
1188
- # data as a hash:
1189
- #
1190
- # {
1191
- # topic_arn: "topicARN", # required
1192
- # attribute_name: "attributeName", # required
1193
- # attribute_value: "attributeValue",
1194
- # }
1195
- # @!attribute [rw] topic_arn
1196
- # The ARN of the topic to modify.
1197
- # @return [String]
1198
- #
1199
- # @!attribute [rw] attribute_name
1200
- # The name of the attribute you want to set. Only a subset of the
1201
- # topic's attributes are mutable.
1202
- #
1203
- # Valid values: `Policy` \| `DisplayName` \| `DeliveryPolicy`
1204
- # @return [String]
1205
- #
1206
- # @!attribute [rw] attribute_value
1207
- # The new value for the attribute.
1208
- # @return [String]
1209
- class SetTopicAttributesInput < Struct.new(
1210
- :topic_arn,
1211
- :attribute_name,
1212
- :attribute_value)
1213
- include Aws::Structure
1214
- end
1369
+ # Input for SetSubscriptionAttributes action.
1370
+ #
1371
+ # @note When making an API call, you may pass SetSubscriptionAttributesInput
1372
+ # data as a hash:
1373
+ #
1374
+ # {
1375
+ # subscription_arn: "subscriptionARN", # required
1376
+ # attribute_name: "attributeName", # required
1377
+ # attribute_value: "attributeValue",
1378
+ # }
1379
+ #
1380
+ # @!attribute [rw] subscription_arn
1381
+ # The ARN of the subscription to modify.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] attribute_name
1385
+ # The name of the attribute you want to set. Only a subset of the
1386
+ # subscriptions attributes are mutable.
1387
+ #
1388
+ # Valid values: `DeliveryPolicy` \| `RawMessageDelivery`
1389
+ # @return [String]
1390
+ #
1391
+ # @!attribute [rw] attribute_value
1392
+ # The new value for the attribute in JSON format.
1393
+ # @return [String]
1394
+ #
1395
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetSubscriptionAttributesInput AWS API Documentation
1396
+ #
1397
+ class SetSubscriptionAttributesInput < Struct.new(
1398
+ :subscription_arn,
1399
+ :attribute_name,
1400
+ :attribute_value)
1401
+ include Aws::Structure
1402
+ end
1215
1403
 
1216
- # Input for Subscribe action.
1217
- # @note When making an API call, pass SubscribeInput
1218
- # data as a hash:
1219
- #
1220
- # {
1221
- # topic_arn: "topicARN", # required
1222
- # protocol: "protocol", # required
1223
- # endpoint: "endpoint",
1224
- # }
1225
- # @!attribute [rw] topic_arn
1226
- # The ARN of the topic you want to subscribe to.
1227
- # @return [String]
1228
- #
1229
- # @!attribute [rw] protocol
1230
- # The protocol you want to use. Supported protocols include:
1231
- #
1232
- # * `http` -- delivery of JSON-encoded message via HTTP POST
1233
- #
1234
- # * `https` -- delivery of JSON-encoded message via HTTPS POST
1235
- #
1236
- # * `email` -- delivery of message via SMTP
1237
- #
1238
- # * `email-json` -- delivery of JSON-encoded message via SMTP
1239
- #
1240
- # * `sms` -- delivery of message via SMS
1241
- #
1242
- # * `sqs` -- delivery of JSON-encoded message to an Amazon SQS queue
1243
- #
1244
- # * `application` -- delivery of JSON-encoded message to an
1245
- # EndpointArn for a mobile app and device.
1246
- #
1247
- # * `lambda` -- delivery of JSON-encoded message to an AWS Lambda
1248
- # function.
1249
- # @return [String]
1250
- #
1251
- # @!attribute [rw] endpoint
1252
- # The endpoint that you want to receive notifications. Endpoints vary
1253
- # by protocol:
1254
- #
1255
- # * For the `http` protocol, the endpoint is an URL beginning with
1256
- # "http://"
1257
- #
1258
- # * For the `https` protocol, the endpoint is a URL beginning with
1259
- # "https://"
1260
- #
1261
- # * For the `email` protocol, the endpoint is an email address
1262
- #
1263
- # * For the `email-json` protocol, the endpoint is an email address
1264
- #
1265
- # * For the `sms` protocol, the endpoint is a phone number of an
1266
- # SMS-enabled device
1267
- #
1268
- # * For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS
1269
- # queue
1270
- #
1271
- # * For the `application` protocol, the endpoint is the EndpointArn of
1272
- # a mobile app and device.
1273
- #
1274
- # * For the `lambda` protocol, the endpoint is the ARN of an AWS
1275
- # Lambda function.
1276
- # @return [String]
1277
- class SubscribeInput < Struct.new(
1278
- :topic_arn,
1279
- :protocol,
1280
- :endpoint)
1281
- include Aws::Structure
1282
- end
1404
+ # Input for SetTopicAttributes action.
1405
+ #
1406
+ # @note When making an API call, you may pass SetTopicAttributesInput
1407
+ # data as a hash:
1408
+ #
1409
+ # {
1410
+ # topic_arn: "topicARN", # required
1411
+ # attribute_name: "attributeName", # required
1412
+ # attribute_value: "attributeValue",
1413
+ # }
1414
+ #
1415
+ # @!attribute [rw] topic_arn
1416
+ # The ARN of the topic to modify.
1417
+ # @return [String]
1418
+ #
1419
+ # @!attribute [rw] attribute_name
1420
+ # The name of the attribute you want to set. Only a subset of the
1421
+ # topic's attributes are mutable.
1422
+ #
1423
+ # Valid values: `Policy` \| `DisplayName` \| `DeliveryPolicy`
1424
+ # @return [String]
1425
+ #
1426
+ # @!attribute [rw] attribute_value
1427
+ # The new value for the attribute.
1428
+ # @return [String]
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SetTopicAttributesInput AWS API Documentation
1431
+ #
1432
+ class SetTopicAttributesInput < Struct.new(
1433
+ :topic_arn,
1434
+ :attribute_name,
1435
+ :attribute_value)
1436
+ include Aws::Structure
1437
+ end
1283
1438
 
1284
- # Response for Subscribe action.
1285
- # @!attribute [rw] subscription_arn
1286
- # The ARN of the subscription, if the service was able to create a
1287
- # subscription immediately (without requiring endpoint owner
1288
- # confirmation).
1289
- # @return [String]
1290
- class SubscribeResponse < Struct.new(
1291
- :subscription_arn)
1292
- include Aws::Structure
1293
- end
1439
+ # Input for Subscribe action.
1440
+ #
1441
+ # @note When making an API call, you may pass SubscribeInput
1442
+ # data as a hash:
1443
+ #
1444
+ # {
1445
+ # topic_arn: "topicARN", # required
1446
+ # protocol: "protocol", # required
1447
+ # endpoint: "endpoint",
1448
+ # }
1449
+ #
1450
+ # @!attribute [rw] topic_arn
1451
+ # The ARN of the topic you want to subscribe to.
1452
+ # @return [String]
1453
+ #
1454
+ # @!attribute [rw] protocol
1455
+ # The protocol you want to use. Supported protocols include:
1456
+ #
1457
+ # * `http` -- delivery of JSON-encoded message via HTTP POST
1458
+ #
1459
+ # * `https` -- delivery of JSON-encoded message via HTTPS POST
1460
+ #
1461
+ # * `email` -- delivery of message via SMTP
1462
+ #
1463
+ # * `email-json` -- delivery of JSON-encoded message via SMTP
1464
+ #
1465
+ # * `sms` -- delivery of message via SMS
1466
+ #
1467
+ # * `sqs` -- delivery of JSON-encoded message to an Amazon SQS queue
1468
+ #
1469
+ # * `application` -- delivery of JSON-encoded message to an
1470
+ # EndpointArn for a mobile app and device.
1471
+ #
1472
+ # * `lambda` -- delivery of JSON-encoded message to an AWS Lambda
1473
+ # function.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] endpoint
1477
+ # The endpoint that you want to receive notifications. Endpoints vary
1478
+ # by protocol:
1479
+ #
1480
+ # * For the `http` protocol, the endpoint is an URL beginning with
1481
+ # "http://"
1482
+ #
1483
+ # * For the `https` protocol, the endpoint is a URL beginning with
1484
+ # "https://"
1485
+ #
1486
+ # * For the `email` protocol, the endpoint is an email address
1487
+ #
1488
+ # * For the `email-json` protocol, the endpoint is an email address
1489
+ #
1490
+ # * For the `sms` protocol, the endpoint is a phone number of an
1491
+ # SMS-enabled device
1492
+ #
1493
+ # * For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS
1494
+ # queue
1495
+ #
1496
+ # * For the `application` protocol, the endpoint is the EndpointArn of
1497
+ # a mobile app and device.
1498
+ #
1499
+ # * For the `lambda` protocol, the endpoint is the ARN of an AWS
1500
+ # Lambda function.
1501
+ # @return [String]
1502
+ #
1503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeInput AWS API Documentation
1504
+ #
1505
+ class SubscribeInput < Struct.new(
1506
+ :topic_arn,
1507
+ :protocol,
1508
+ :endpoint)
1509
+ include Aws::Structure
1510
+ end
1294
1511
 
1295
- # A wrapper type for the attributes of an Amazon SNS subscription.
1296
- # @!attribute [rw] subscription_arn
1297
- # The subscription's ARN.
1298
- # @return [String]
1299
- #
1300
- # @!attribute [rw] owner
1301
- # The subscription's owner.
1302
- # @return [String]
1303
- #
1304
- # @!attribute [rw] protocol
1305
- # The subscription's protocol.
1306
- # @return [String]
1307
- #
1308
- # @!attribute [rw] endpoint
1309
- # The subscription's endpoint (format depends on the protocol).
1310
- # @return [String]
1311
- #
1312
- # @!attribute [rw] topic_arn
1313
- # The ARN of the subscription's topic.
1314
- # @return [String]
1315
- class Subscription < Struct.new(
1316
- :subscription_arn,
1317
- :owner,
1318
- :protocol,
1319
- :endpoint,
1320
- :topic_arn)
1321
- include Aws::Structure
1322
- end
1512
+ # Response for Subscribe action.
1513
+ #
1514
+ # @!attribute [rw] subscription_arn
1515
+ # The ARN of the subscription, if the service was able to create a
1516
+ # subscription immediately (without requiring endpoint owner
1517
+ # confirmation).
1518
+ # @return [String]
1519
+ #
1520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/SubscribeResponse AWS API Documentation
1521
+ #
1522
+ class SubscribeResponse < Struct.new(
1523
+ :subscription_arn)
1524
+ include Aws::Structure
1525
+ end
1323
1526
 
1324
- # A wrapper type for the topic's Amazon Resource Name (ARN). To
1325
- # retrieve a topic's attributes, use `GetTopicAttributes`.
1326
- # @!attribute [rw] topic_arn
1327
- # The topic's ARN.
1328
- # @return [String]
1329
- class Topic < Struct.new(
1330
- :topic_arn)
1331
- include Aws::Structure
1332
- end
1527
+ # A wrapper type for the attributes of an Amazon SNS subscription.
1528
+ #
1529
+ # @!attribute [rw] subscription_arn
1530
+ # The subscription's ARN.
1531
+ # @return [String]
1532
+ #
1533
+ # @!attribute [rw] owner
1534
+ # The subscription's owner.
1535
+ # @return [String]
1536
+ #
1537
+ # @!attribute [rw] protocol
1538
+ # The subscription's protocol.
1539
+ # @return [String]
1540
+ #
1541
+ # @!attribute [rw] endpoint
1542
+ # The subscription's endpoint (format depends on the protocol).
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] topic_arn
1546
+ # The ARN of the subscription's topic.
1547
+ # @return [String]
1548
+ #
1549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Subscription AWS API Documentation
1550
+ #
1551
+ class Subscription < Struct.new(
1552
+ :subscription_arn,
1553
+ :owner,
1554
+ :protocol,
1555
+ :endpoint,
1556
+ :topic_arn)
1557
+ include Aws::Structure
1558
+ end
1333
1559
 
1334
- # Input for Unsubscribe action.
1335
- # @note When making an API call, pass UnsubscribeInput
1336
- # data as a hash:
1337
- #
1338
- # {
1339
- # subscription_arn: "subscriptionARN", # required
1340
- # }
1341
- # @!attribute [rw] subscription_arn
1342
- # The ARN of the subscription to be deleted.
1343
- # @return [String]
1344
- class UnsubscribeInput < Struct.new(
1345
- :subscription_arn)
1346
- include Aws::Structure
1347
- end
1560
+ # A wrapper type for the topic's Amazon Resource Name (ARN). To
1561
+ # retrieve a topic's attributes, use `GetTopicAttributes`.
1562
+ #
1563
+ # @!attribute [rw] topic_arn
1564
+ # The topic's ARN.
1565
+ # @return [String]
1566
+ #
1567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/Topic AWS API Documentation
1568
+ #
1569
+ class Topic < Struct.new(
1570
+ :topic_arn)
1571
+ include Aws::Structure
1572
+ end
1348
1573
 
1574
+ # Input for Unsubscribe action.
1575
+ #
1576
+ # @note When making an API call, you may pass UnsubscribeInput
1577
+ # data as a hash:
1578
+ #
1579
+ # {
1580
+ # subscription_arn: "subscriptionARN", # required
1581
+ # }
1582
+ #
1583
+ # @!attribute [rw] subscription_arn
1584
+ # The ARN of the subscription to be deleted.
1585
+ # @return [String]
1586
+ #
1587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/UnsubscribeInput AWS API Documentation
1588
+ #
1589
+ class UnsubscribeInput < Struct.new(
1590
+ :subscription_arn)
1591
+ include Aws::Structure
1349
1592
  end
1593
+
1350
1594
  end
1351
1595
  end