aws-sdk-sns 1.66.0 → 1.75.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +45 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sns/client.rb +141 -71
- data/lib/aws-sdk-sns/client_api.rb +45 -33
- data/lib/aws-sdk-sns/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-sns/errors.rb +32 -0
- data/lib/aws-sdk-sns/platform_application.rb +19 -3
- data/lib/aws-sdk-sns/platform_endpoint.rb +1 -1
- data/lib/aws-sdk-sns/plugins/endpoints.rb +4 -2
- data/lib/aws-sdk-sns/resource.rb +9 -2
- data/lib/aws-sdk-sns/topic.rb +23 -1
- data/lib/aws-sdk-sns/types.rb +127 -52
- data/lib/aws-sdk-sns.rb +1 -1
- data/sig/client.rbs +525 -0
- data/sig/errors.rbs +119 -0
- data/sig/platform_application.rbs +64 -0
- data/sig/platform_endpoint.rbs +68 -0
- data/sig/resource.rbs +128 -0
- data/sig/subscription.rbs +52 -0
- data/sig/topic.rbs +104 -0
- data/sig/types.rbs +664 -0
- data/sig/waiters.rbs +13 -0
- metadata +18 -9
data/sig/client.rbs
ADDED
@@ -0,0 +1,525 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module SNS
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?stub_responses: untyped,
|
52
|
+
?token_provider: untyped,
|
53
|
+
?use_dualstack_endpoint: bool,
|
54
|
+
?use_fips_endpoint: bool,
|
55
|
+
?validate_params: bool,
|
56
|
+
?endpoint_provider: untyped,
|
57
|
+
?http_proxy: String,
|
58
|
+
?http_open_timeout: (Float | Integer),
|
59
|
+
?http_read_timeout: (Float | Integer),
|
60
|
+
?http_idle_timeout: (Float | Integer),
|
61
|
+
?http_continue_timeout: (Float | Integer),
|
62
|
+
?ssl_timeout: (Float | Integer | nil),
|
63
|
+
?http_wire_trace: bool,
|
64
|
+
?ssl_verify_peer: bool,
|
65
|
+
?ssl_ca_bundle: String,
|
66
|
+
?ssl_ca_directory: String,
|
67
|
+
?ssl_ca_store: String,
|
68
|
+
?on_chunk_received: Proc,
|
69
|
+
?on_chunk_sent: Proc,
|
70
|
+
?raise_response_errors: bool
|
71
|
+
) -> instance
|
72
|
+
| (?Hash[Symbol, untyped]) -> instance
|
73
|
+
|
74
|
+
|
75
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#add_permission-instance_method
|
76
|
+
def add_permission: (
|
77
|
+
topic_arn: ::String,
|
78
|
+
label: ::String,
|
79
|
+
aws_account_id: Array[::String],
|
80
|
+
action_name: Array[::String]
|
81
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
82
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
83
|
+
|
84
|
+
interface _CheckIfPhoneNumberIsOptedOutResponseSuccess
|
85
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CheckIfPhoneNumberIsOptedOutResponse]
|
86
|
+
def is_opted_out: () -> bool
|
87
|
+
end
|
88
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#check_if_phone_number_is_opted_out-instance_method
|
89
|
+
def check_if_phone_number_is_opted_out: (
|
90
|
+
phone_number: ::String
|
91
|
+
) -> _CheckIfPhoneNumberIsOptedOutResponseSuccess
|
92
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CheckIfPhoneNumberIsOptedOutResponseSuccess
|
93
|
+
|
94
|
+
interface _ConfirmSubscriptionResponseSuccess
|
95
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ConfirmSubscriptionResponse]
|
96
|
+
def subscription_arn: () -> ::String
|
97
|
+
end
|
98
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#confirm_subscription-instance_method
|
99
|
+
def confirm_subscription: (
|
100
|
+
topic_arn: ::String,
|
101
|
+
token: ::String,
|
102
|
+
?authenticate_on_unsubscribe: ::String
|
103
|
+
) -> _ConfirmSubscriptionResponseSuccess
|
104
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ConfirmSubscriptionResponseSuccess
|
105
|
+
|
106
|
+
interface _CreatePlatformApplicationResponseSuccess
|
107
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreatePlatformApplicationResponse]
|
108
|
+
def platform_application_arn: () -> ::String
|
109
|
+
end
|
110
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#create_platform_application-instance_method
|
111
|
+
def create_platform_application: (
|
112
|
+
name: ::String,
|
113
|
+
platform: ::String,
|
114
|
+
attributes: Hash[::String, ::String]
|
115
|
+
) -> _CreatePlatformApplicationResponseSuccess
|
116
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePlatformApplicationResponseSuccess
|
117
|
+
|
118
|
+
interface _CreatePlatformEndpointResponseSuccess
|
119
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateEndpointResponse]
|
120
|
+
def endpoint_arn: () -> ::String
|
121
|
+
end
|
122
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#create_platform_endpoint-instance_method
|
123
|
+
def create_platform_endpoint: (
|
124
|
+
platform_application_arn: ::String,
|
125
|
+
token: ::String,
|
126
|
+
?custom_user_data: ::String,
|
127
|
+
?attributes: Hash[::String, ::String]
|
128
|
+
) -> _CreatePlatformEndpointResponseSuccess
|
129
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreatePlatformEndpointResponseSuccess
|
130
|
+
|
131
|
+
interface _CreateSMSSandboxPhoneNumberResponseSuccess
|
132
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateSMSSandboxPhoneNumberResult]
|
133
|
+
end
|
134
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#create_sms_sandbox_phone_number-instance_method
|
135
|
+
def create_sms_sandbox_phone_number: (
|
136
|
+
phone_number: ::String,
|
137
|
+
?language_code: ("en-US" | "en-GB" | "es-419" | "es-ES" | "de-DE" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "pt-BR" | "kr-KR" | "zh-CN" | "zh-TW")
|
138
|
+
) -> _CreateSMSSandboxPhoneNumberResponseSuccess
|
139
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSMSSandboxPhoneNumberResponseSuccess
|
140
|
+
|
141
|
+
interface _CreateTopicResponseSuccess
|
142
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateTopicResponse]
|
143
|
+
def topic_arn: () -> ::String
|
144
|
+
end
|
145
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#create_topic-instance_method
|
146
|
+
def create_topic: (
|
147
|
+
name: ::String,
|
148
|
+
?attributes: Hash[::String, ::String],
|
149
|
+
?tags: Array[
|
150
|
+
{
|
151
|
+
key: ::String,
|
152
|
+
value: ::String
|
153
|
+
},
|
154
|
+
],
|
155
|
+
?data_protection_policy: ::String
|
156
|
+
) -> _CreateTopicResponseSuccess
|
157
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateTopicResponseSuccess
|
158
|
+
|
159
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#delete_endpoint-instance_method
|
160
|
+
def delete_endpoint: (
|
161
|
+
endpoint_arn: ::String
|
162
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
163
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
164
|
+
|
165
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#delete_platform_application-instance_method
|
166
|
+
def delete_platform_application: (
|
167
|
+
platform_application_arn: ::String
|
168
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
169
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
170
|
+
|
171
|
+
interface _DeleteSMSSandboxPhoneNumberResponseSuccess
|
172
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteSMSSandboxPhoneNumberResult]
|
173
|
+
end
|
174
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#delete_sms_sandbox_phone_number-instance_method
|
175
|
+
def delete_sms_sandbox_phone_number: (
|
176
|
+
phone_number: ::String
|
177
|
+
) -> _DeleteSMSSandboxPhoneNumberResponseSuccess
|
178
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteSMSSandboxPhoneNumberResponseSuccess
|
179
|
+
|
180
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#delete_topic-instance_method
|
181
|
+
def delete_topic: (
|
182
|
+
topic_arn: ::String
|
183
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
184
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
185
|
+
|
186
|
+
interface _GetDataProtectionPolicyResponseSuccess
|
187
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDataProtectionPolicyResponse]
|
188
|
+
def data_protection_policy: () -> ::String
|
189
|
+
end
|
190
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_data_protection_policy-instance_method
|
191
|
+
def get_data_protection_policy: (
|
192
|
+
resource_arn: ::String
|
193
|
+
) -> _GetDataProtectionPolicyResponseSuccess
|
194
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataProtectionPolicyResponseSuccess
|
195
|
+
|
196
|
+
interface _GetEndpointAttributesResponseSuccess
|
197
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetEndpointAttributesResponse]
|
198
|
+
def attributes: () -> ::Hash[::String, ::String]
|
199
|
+
end
|
200
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_endpoint_attributes-instance_method
|
201
|
+
def get_endpoint_attributes: (
|
202
|
+
endpoint_arn: ::String
|
203
|
+
) -> _GetEndpointAttributesResponseSuccess
|
204
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetEndpointAttributesResponseSuccess
|
205
|
+
|
206
|
+
interface _GetPlatformApplicationAttributesResponseSuccess
|
207
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPlatformApplicationAttributesResponse]
|
208
|
+
def attributes: () -> ::Hash[::String, ::String]
|
209
|
+
end
|
210
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_platform_application_attributes-instance_method
|
211
|
+
def get_platform_application_attributes: (
|
212
|
+
platform_application_arn: ::String
|
213
|
+
) -> _GetPlatformApplicationAttributesResponseSuccess
|
214
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPlatformApplicationAttributesResponseSuccess
|
215
|
+
|
216
|
+
interface _GetSMSAttributesResponseSuccess
|
217
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSMSAttributesResponse]
|
218
|
+
def attributes: () -> ::Hash[::String, ::String]
|
219
|
+
end
|
220
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_sms_attributes-instance_method
|
221
|
+
def get_sms_attributes: (
|
222
|
+
?attributes: Array[::String]
|
223
|
+
) -> _GetSMSAttributesResponseSuccess
|
224
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSMSAttributesResponseSuccess
|
225
|
+
|
226
|
+
interface _GetSMSSandboxAccountStatusResponseSuccess
|
227
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSMSSandboxAccountStatusResult]
|
228
|
+
def is_in_sandbox: () -> bool
|
229
|
+
end
|
230
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_sms_sandbox_account_status-instance_method
|
231
|
+
def get_sms_sandbox_account_status: (
|
232
|
+
) -> _GetSMSSandboxAccountStatusResponseSuccess
|
233
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSMSSandboxAccountStatusResponseSuccess
|
234
|
+
|
235
|
+
interface _GetSubscriptionAttributesResponseSuccess
|
236
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSubscriptionAttributesResponse]
|
237
|
+
def attributes: () -> ::Hash[::String, ::String]
|
238
|
+
end
|
239
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_subscription_attributes-instance_method
|
240
|
+
def get_subscription_attributes: (
|
241
|
+
subscription_arn: ::String
|
242
|
+
) -> _GetSubscriptionAttributesResponseSuccess
|
243
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSubscriptionAttributesResponseSuccess
|
244
|
+
|
245
|
+
interface _GetTopicAttributesResponseSuccess
|
246
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetTopicAttributesResponse]
|
247
|
+
def attributes: () -> ::Hash[::String, ::String]
|
248
|
+
end
|
249
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#get_topic_attributes-instance_method
|
250
|
+
def get_topic_attributes: (
|
251
|
+
topic_arn: ::String
|
252
|
+
) -> _GetTopicAttributesResponseSuccess
|
253
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetTopicAttributesResponseSuccess
|
254
|
+
|
255
|
+
interface _ListEndpointsByPlatformApplicationResponseSuccess
|
256
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListEndpointsByPlatformApplicationResponse]
|
257
|
+
def endpoints: () -> ::Array[Types::Endpoint]
|
258
|
+
def next_token: () -> ::String
|
259
|
+
end
|
260
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_endpoints_by_platform_application-instance_method
|
261
|
+
def list_endpoints_by_platform_application: (
|
262
|
+
platform_application_arn: ::String,
|
263
|
+
?next_token: ::String
|
264
|
+
) -> _ListEndpointsByPlatformApplicationResponseSuccess
|
265
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEndpointsByPlatformApplicationResponseSuccess
|
266
|
+
|
267
|
+
interface _ListOriginationNumbersResponseSuccess
|
268
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListOriginationNumbersResult]
|
269
|
+
def next_token: () -> ::String
|
270
|
+
def phone_numbers: () -> ::Array[Types::PhoneNumberInformation]
|
271
|
+
end
|
272
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_origination_numbers-instance_method
|
273
|
+
def list_origination_numbers: (
|
274
|
+
?next_token: ::String,
|
275
|
+
?max_results: ::Integer
|
276
|
+
) -> _ListOriginationNumbersResponseSuccess
|
277
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListOriginationNumbersResponseSuccess
|
278
|
+
|
279
|
+
interface _ListPhoneNumbersOptedOutResponseSuccess
|
280
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPhoneNumbersOptedOutResponse]
|
281
|
+
def phone_numbers: () -> ::Array[::String]
|
282
|
+
def next_token: () -> ::String
|
283
|
+
end
|
284
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_phone_numbers_opted_out-instance_method
|
285
|
+
def list_phone_numbers_opted_out: (
|
286
|
+
?next_token: ::String
|
287
|
+
) -> _ListPhoneNumbersOptedOutResponseSuccess
|
288
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPhoneNumbersOptedOutResponseSuccess
|
289
|
+
|
290
|
+
interface _ListPlatformApplicationsResponseSuccess
|
291
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListPlatformApplicationsResponse]
|
292
|
+
def platform_applications: () -> ::Array[Types::PlatformApplication]
|
293
|
+
def next_token: () -> ::String
|
294
|
+
end
|
295
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_platform_applications-instance_method
|
296
|
+
def list_platform_applications: (
|
297
|
+
?next_token: ::String
|
298
|
+
) -> _ListPlatformApplicationsResponseSuccess
|
299
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPlatformApplicationsResponseSuccess
|
300
|
+
|
301
|
+
interface _ListSMSSandboxPhoneNumbersResponseSuccess
|
302
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSMSSandboxPhoneNumbersResult]
|
303
|
+
def phone_numbers: () -> ::Array[Types::SMSSandboxPhoneNumber]
|
304
|
+
def next_token: () -> ::String
|
305
|
+
end
|
306
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_sms_sandbox_phone_numbers-instance_method
|
307
|
+
def list_sms_sandbox_phone_numbers: (
|
308
|
+
?next_token: ::String,
|
309
|
+
?max_results: ::Integer
|
310
|
+
) -> _ListSMSSandboxPhoneNumbersResponseSuccess
|
311
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSMSSandboxPhoneNumbersResponseSuccess
|
312
|
+
|
313
|
+
interface _ListSubscriptionsResponseSuccess
|
314
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSubscriptionsResponse]
|
315
|
+
def subscriptions: () -> ::Array[Types::Subscription]
|
316
|
+
def next_token: () -> ::String
|
317
|
+
end
|
318
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_subscriptions-instance_method
|
319
|
+
def list_subscriptions: (
|
320
|
+
?next_token: ::String
|
321
|
+
) -> _ListSubscriptionsResponseSuccess
|
322
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSubscriptionsResponseSuccess
|
323
|
+
|
324
|
+
interface _ListSubscriptionsByTopicResponseSuccess
|
325
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListSubscriptionsByTopicResponse]
|
326
|
+
def subscriptions: () -> ::Array[Types::Subscription]
|
327
|
+
def next_token: () -> ::String
|
328
|
+
end
|
329
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_subscriptions_by_topic-instance_method
|
330
|
+
def list_subscriptions_by_topic: (
|
331
|
+
topic_arn: ::String,
|
332
|
+
?next_token: ::String
|
333
|
+
) -> _ListSubscriptionsByTopicResponseSuccess
|
334
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListSubscriptionsByTopicResponseSuccess
|
335
|
+
|
336
|
+
interface _ListTagsForResourceResponseSuccess
|
337
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
338
|
+
def tags: () -> ::Array[Types::Tag]
|
339
|
+
end
|
340
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_tags_for_resource-instance_method
|
341
|
+
def list_tags_for_resource: (
|
342
|
+
resource_arn: ::String
|
343
|
+
) -> _ListTagsForResourceResponseSuccess
|
344
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
345
|
+
|
346
|
+
interface _ListTopicsResponseSuccess
|
347
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTopicsResponse]
|
348
|
+
def topics: () -> ::Array[Types::Topic]
|
349
|
+
def next_token: () -> ::String
|
350
|
+
end
|
351
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#list_topics-instance_method
|
352
|
+
def list_topics: (
|
353
|
+
?next_token: ::String
|
354
|
+
) -> _ListTopicsResponseSuccess
|
355
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTopicsResponseSuccess
|
356
|
+
|
357
|
+
interface _OptInPhoneNumberResponseSuccess
|
358
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::OptInPhoneNumberResponse]
|
359
|
+
end
|
360
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#opt_in_phone_number-instance_method
|
361
|
+
def opt_in_phone_number: (
|
362
|
+
phone_number: ::String
|
363
|
+
) -> _OptInPhoneNumberResponseSuccess
|
364
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _OptInPhoneNumberResponseSuccess
|
365
|
+
|
366
|
+
interface _PublishResponseSuccess
|
367
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PublishResponse]
|
368
|
+
def message_id: () -> ::String
|
369
|
+
def sequence_number: () -> ::String
|
370
|
+
end
|
371
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#publish-instance_method
|
372
|
+
def publish: (
|
373
|
+
?topic_arn: ::String,
|
374
|
+
?target_arn: ::String,
|
375
|
+
?phone_number: ::String,
|
376
|
+
message: ::String,
|
377
|
+
?subject: ::String,
|
378
|
+
?message_structure: ::String,
|
379
|
+
?message_attributes: Hash[::String, {
|
380
|
+
data_type: ::String,
|
381
|
+
string_value: ::String?,
|
382
|
+
binary_value: ::String?
|
383
|
+
}],
|
384
|
+
?message_deduplication_id: ::String,
|
385
|
+
?message_group_id: ::String
|
386
|
+
) -> _PublishResponseSuccess
|
387
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PublishResponseSuccess
|
388
|
+
|
389
|
+
interface _PublishBatchResponseSuccess
|
390
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PublishBatchResponse]
|
391
|
+
def successful: () -> ::Array[Types::PublishBatchResultEntry]
|
392
|
+
def failed: () -> ::Array[Types::BatchResultErrorEntry]
|
393
|
+
end
|
394
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#publish_batch-instance_method
|
395
|
+
def publish_batch: (
|
396
|
+
topic_arn: ::String,
|
397
|
+
publish_batch_request_entries: Array[
|
398
|
+
{
|
399
|
+
id: ::String,
|
400
|
+
message: ::String,
|
401
|
+
subject: ::String?,
|
402
|
+
message_structure: ::String?,
|
403
|
+
message_attributes: Hash[::String, {
|
404
|
+
data_type: ::String,
|
405
|
+
string_value: ::String?,
|
406
|
+
binary_value: ::String?
|
407
|
+
}]?,
|
408
|
+
message_deduplication_id: ::String?,
|
409
|
+
message_group_id: ::String?
|
410
|
+
},
|
411
|
+
]
|
412
|
+
) -> _PublishBatchResponseSuccess
|
413
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PublishBatchResponseSuccess
|
414
|
+
|
415
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#put_data_protection_policy-instance_method
|
416
|
+
def put_data_protection_policy: (
|
417
|
+
resource_arn: ::String,
|
418
|
+
data_protection_policy: ::String
|
419
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
420
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
421
|
+
|
422
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#remove_permission-instance_method
|
423
|
+
def remove_permission: (
|
424
|
+
topic_arn: ::String,
|
425
|
+
label: ::String
|
426
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
427
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
428
|
+
|
429
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#set_endpoint_attributes-instance_method
|
430
|
+
def set_endpoint_attributes: (
|
431
|
+
endpoint_arn: ::String,
|
432
|
+
attributes: Hash[::String, ::String]
|
433
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
434
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
435
|
+
|
436
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#set_platform_application_attributes-instance_method
|
437
|
+
def set_platform_application_attributes: (
|
438
|
+
platform_application_arn: ::String,
|
439
|
+
attributes: Hash[::String, ::String]
|
440
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
441
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
442
|
+
|
443
|
+
interface _SetSMSAttributesResponseSuccess
|
444
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SetSMSAttributesResponse]
|
445
|
+
end
|
446
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#set_sms_attributes-instance_method
|
447
|
+
def set_sms_attributes: (
|
448
|
+
attributes: Hash[::String, ::String]
|
449
|
+
) -> _SetSMSAttributesResponseSuccess
|
450
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SetSMSAttributesResponseSuccess
|
451
|
+
|
452
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#set_subscription_attributes-instance_method
|
453
|
+
def set_subscription_attributes: (
|
454
|
+
subscription_arn: ::String,
|
455
|
+
attribute_name: ::String,
|
456
|
+
?attribute_value: ::String
|
457
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
458
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
459
|
+
|
460
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#set_topic_attributes-instance_method
|
461
|
+
def set_topic_attributes: (
|
462
|
+
topic_arn: ::String,
|
463
|
+
attribute_name: ::String,
|
464
|
+
?attribute_value: ::String
|
465
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
466
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
467
|
+
|
468
|
+
interface _SubscribeResponseSuccess
|
469
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SubscribeResponse]
|
470
|
+
def subscription_arn: () -> ::String
|
471
|
+
end
|
472
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#subscribe-instance_method
|
473
|
+
def subscribe: (
|
474
|
+
topic_arn: ::String,
|
475
|
+
protocol: ::String,
|
476
|
+
?endpoint: ::String,
|
477
|
+
?attributes: Hash[::String, ::String],
|
478
|
+
?return_subscription_arn: bool
|
479
|
+
) -> _SubscribeResponseSuccess
|
480
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SubscribeResponseSuccess
|
481
|
+
|
482
|
+
interface _TagResourceResponseSuccess
|
483
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
484
|
+
end
|
485
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#tag_resource-instance_method
|
486
|
+
def tag_resource: (
|
487
|
+
resource_arn: ::String,
|
488
|
+
tags: Array[
|
489
|
+
{
|
490
|
+
key: ::String,
|
491
|
+
value: ::String
|
492
|
+
},
|
493
|
+
]
|
494
|
+
) -> _TagResourceResponseSuccess
|
495
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
496
|
+
|
497
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#unsubscribe-instance_method
|
498
|
+
def unsubscribe: (
|
499
|
+
subscription_arn: ::String
|
500
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
501
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
502
|
+
|
503
|
+
interface _UntagResourceResponseSuccess
|
504
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
505
|
+
end
|
506
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#untag_resource-instance_method
|
507
|
+
def untag_resource: (
|
508
|
+
resource_arn: ::String,
|
509
|
+
tag_keys: Array[::String]
|
510
|
+
) -> _UntagResourceResponseSuccess
|
511
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
512
|
+
|
513
|
+
interface _VerifySMSSandboxPhoneNumberResponseSuccess
|
514
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::VerifySMSSandboxPhoneNumberResult]
|
515
|
+
end
|
516
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SNS/Client.html#verify_sms_sandbox_phone_number-instance_method
|
517
|
+
def verify_sms_sandbox_phone_number: (
|
518
|
+
phone_number: ::String,
|
519
|
+
one_time_password: ::String
|
520
|
+
) -> _VerifySMSSandboxPhoneNumberResponseSuccess
|
521
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _VerifySMSSandboxPhoneNumberResponseSuccess
|
522
|
+
end
|
523
|
+
end
|
524
|
+
end
|
525
|
+
|
data/sig/errors.rbs
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module SNS
|
10
|
+
module Errors
|
11
|
+
class ServiceError < ::Aws::Errors::ServiceError
|
12
|
+
end
|
13
|
+
|
14
|
+
class AuthorizationErrorException < ::Aws::Errors::ServiceError
|
15
|
+
def message: () -> ::String
|
16
|
+
end
|
17
|
+
class BatchEntryIdsNotDistinctException < ::Aws::Errors::ServiceError
|
18
|
+
def message: () -> ::String
|
19
|
+
end
|
20
|
+
class BatchRequestTooLongException < ::Aws::Errors::ServiceError
|
21
|
+
def message: () -> ::String
|
22
|
+
end
|
23
|
+
class ConcurrentAccessException < ::Aws::Errors::ServiceError
|
24
|
+
def message: () -> ::String
|
25
|
+
end
|
26
|
+
class EmptyBatchRequestException < ::Aws::Errors::ServiceError
|
27
|
+
def message: () -> ::String
|
28
|
+
end
|
29
|
+
class EndpointDisabledException < ::Aws::Errors::ServiceError
|
30
|
+
def message: () -> ::String
|
31
|
+
end
|
32
|
+
class FilterPolicyLimitExceededException < ::Aws::Errors::ServiceError
|
33
|
+
def message: () -> ::String
|
34
|
+
end
|
35
|
+
class InternalErrorException < ::Aws::Errors::ServiceError
|
36
|
+
def message: () -> ::String
|
37
|
+
end
|
38
|
+
class InvalidBatchEntryIdException < ::Aws::Errors::ServiceError
|
39
|
+
def message: () -> ::String
|
40
|
+
end
|
41
|
+
class InvalidParameterException < ::Aws::Errors::ServiceError
|
42
|
+
def message: () -> ::String
|
43
|
+
end
|
44
|
+
class InvalidParameterValueException < ::Aws::Errors::ServiceError
|
45
|
+
def message: () -> ::String
|
46
|
+
end
|
47
|
+
class InvalidSecurityException < ::Aws::Errors::ServiceError
|
48
|
+
def message: () -> ::String
|
49
|
+
end
|
50
|
+
class InvalidStateException < ::Aws::Errors::ServiceError
|
51
|
+
def message: () -> ::String
|
52
|
+
end
|
53
|
+
class KMSAccessDeniedException < ::Aws::Errors::ServiceError
|
54
|
+
def message: () -> ::String
|
55
|
+
end
|
56
|
+
class KMSDisabledException < ::Aws::Errors::ServiceError
|
57
|
+
def message: () -> ::String
|
58
|
+
end
|
59
|
+
class KMSInvalidStateException < ::Aws::Errors::ServiceError
|
60
|
+
def message: () -> ::String
|
61
|
+
end
|
62
|
+
class KMSNotFoundException < ::Aws::Errors::ServiceError
|
63
|
+
def message: () -> ::String
|
64
|
+
end
|
65
|
+
class KMSOptInRequired < ::Aws::Errors::ServiceError
|
66
|
+
def message: () -> ::String
|
67
|
+
end
|
68
|
+
class KMSThrottlingException < ::Aws::Errors::ServiceError
|
69
|
+
def message: () -> ::String
|
70
|
+
end
|
71
|
+
class NotFoundException < ::Aws::Errors::ServiceError
|
72
|
+
def message: () -> ::String
|
73
|
+
end
|
74
|
+
class OptedOutException < ::Aws::Errors::ServiceError
|
75
|
+
def message: () -> ::String
|
76
|
+
end
|
77
|
+
class PlatformApplicationDisabledException < ::Aws::Errors::ServiceError
|
78
|
+
def message: () -> ::String
|
79
|
+
end
|
80
|
+
class ReplayLimitExceededException < ::Aws::Errors::ServiceError
|
81
|
+
def message: () -> ::String
|
82
|
+
end
|
83
|
+
class ResourceNotFoundException < ::Aws::Errors::ServiceError
|
84
|
+
def message: () -> ::String
|
85
|
+
end
|
86
|
+
class StaleTagException < ::Aws::Errors::ServiceError
|
87
|
+
def message: () -> ::String
|
88
|
+
end
|
89
|
+
class SubscriptionLimitExceededException < ::Aws::Errors::ServiceError
|
90
|
+
def message: () -> ::String
|
91
|
+
end
|
92
|
+
class TagLimitExceededException < ::Aws::Errors::ServiceError
|
93
|
+
def message: () -> ::String
|
94
|
+
end
|
95
|
+
class TagPolicyException < ::Aws::Errors::ServiceError
|
96
|
+
def message: () -> ::String
|
97
|
+
end
|
98
|
+
class ThrottledException < ::Aws::Errors::ServiceError
|
99
|
+
def message: () -> ::String
|
100
|
+
end
|
101
|
+
class TooManyEntriesInBatchRequestException < ::Aws::Errors::ServiceError
|
102
|
+
def message: () -> ::String
|
103
|
+
end
|
104
|
+
class TopicLimitExceededException < ::Aws::Errors::ServiceError
|
105
|
+
def message: () -> ::String
|
106
|
+
end
|
107
|
+
class UserErrorException < ::Aws::Errors::ServiceError
|
108
|
+
def message: () -> ::String
|
109
|
+
end
|
110
|
+
class ValidationException < ::Aws::Errors::ServiceError
|
111
|
+
def message: () -> ::String
|
112
|
+
end
|
113
|
+
class VerificationException < ::Aws::Errors::ServiceError
|
114
|
+
def message: () -> ::String
|
115
|
+
def status: () -> ::String
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|