aws-sdk-sns 1.60.0 → 1.96.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +180 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sns/client.rb +356 -153
- data/lib/aws-sdk-sns/client_api.rb +48 -33
- data/lib/aws-sdk-sns/customizations.rb +5 -1
- data/lib/aws-sdk-sns/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-sns/endpoint_provider.rb +16 -20
- data/lib/aws-sdk-sns/endpoints.rb +3 -586
- data/lib/aws-sdk-sns/errors.rb +32 -0
- data/lib/aws-sdk-sns/platform_application.rb +33 -8
- data/lib/aws-sdk-sns/platform_endpoint.rb +60 -23
- data/lib/aws-sdk-sns/plugins/endpoints.rb +23 -98
- data/lib/aws-sdk-sns/resource.rb +39 -10
- data/lib/aws-sdk-sns/subscription.rb +21 -21
- data/lib/aws-sdk-sns/topic.rb +134 -46
- data/lib/aws-sdk-sns/types.rb +266 -125
- data/lib/aws-sdk-sns.rb +19 -15
- data/sig/client.rbs +530 -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 +133 -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 +20 -11
data/lib/aws-sdk-sns/client.rb
CHANGED
@@ -7,33 +7,34 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
19
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
20
|
-
require 'aws-sdk-core/plugins/endpoint_discovery
|
21
|
-
require 'aws-sdk-core/plugins/endpoint_pattern
|
22
|
-
require 'aws-sdk-core/plugins/response_paging
|
23
|
-
require 'aws-sdk-core/plugins/stub_responses
|
24
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
25
|
-
require 'aws-sdk-core/plugins/
|
26
|
-
require 'aws-sdk-core/plugins/
|
27
|
-
require 'aws-sdk-core/plugins/
|
28
|
-
require 'aws-sdk-core/plugins/
|
29
|
-
require 'aws-sdk-core/plugins/
|
30
|
-
require 'aws-sdk-core/plugins/
|
31
|
-
require 'aws-sdk-core/plugins/
|
32
|
-
require 'aws-sdk-core/plugins/
|
33
|
-
require 'aws-sdk-core/plugins/
|
34
|
-
require 'aws-sdk-core/plugins/
|
35
|
-
|
36
|
-
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/query'
|
37
38
|
|
38
39
|
module Aws::SNS
|
39
40
|
# An API client for SNS. To construct a client, you need to configure a `:region` and `:credentials`.
|
@@ -71,20 +72,28 @@ module Aws::SNS
|
|
71
72
|
add_plugin(Aws::Plugins::ResponsePaging)
|
72
73
|
add_plugin(Aws::Plugins::StubResponses)
|
73
74
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
75
|
+
add_plugin(Aws::Plugins::InvocationId)
|
74
76
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
77
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
78
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
79
|
add_plugin(Aws::Plugins::TransferEncoding)
|
78
80
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
81
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
80
83
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
84
|
add_plugin(Aws::Plugins::RecursionDetection)
|
85
|
+
add_plugin(Aws::Plugins::Telemetry)
|
82
86
|
add_plugin(Aws::Plugins::Sign)
|
83
87
|
add_plugin(Aws::Plugins::Protocols::Query)
|
84
88
|
add_plugin(Aws::SNS::Plugins::Endpoints)
|
85
89
|
|
86
90
|
# @overload initialize(options)
|
87
91
|
# @param [Hash] options
|
92
|
+
#
|
93
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
94
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
95
|
+
# class name or an instance of a plugin class.
|
96
|
+
#
|
88
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
89
98
|
# Your AWS credentials. This can be an instance of any one of the
|
90
99
|
# following classes:
|
@@ -119,13 +128,15 @@ module Aws::SNS
|
|
119
128
|
# locations will be searched for credentials:
|
120
129
|
#
|
121
130
|
# * `Aws.config[:credentials]`
|
122
|
-
# * The `:access_key_id`, `:secret_access_key`,
|
123
|
-
#
|
131
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
132
|
+
# `:account_id` options.
|
133
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
134
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
124
135
|
# * `~/.aws/credentials`
|
125
136
|
# * `~/.aws/config`
|
126
137
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
138
|
# are very aggressive. Construct and pass an instance of
|
128
|
-
# `Aws::
|
139
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
129
140
|
# enable retries and extended timeouts. Instance profile credential
|
130
141
|
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
142
|
# to true.
|
@@ -144,6 +155,8 @@ module Aws::SNS
|
|
144
155
|
#
|
145
156
|
# @option options [String] :access_key_id
|
146
157
|
#
|
158
|
+
# @option options [String] :account_id
|
159
|
+
#
|
147
160
|
# @option options [Boolean] :active_endpoint_cache (false)
|
148
161
|
# When set to `true`, a thread polling for endpoints will be running in
|
149
162
|
# the background every 60 secs (default). Defaults to `false`.
|
@@ -190,10 +203,20 @@ module Aws::SNS
|
|
190
203
|
# Set to true to disable SDK automatically adding host prefix
|
191
204
|
# to default service endpoint when available.
|
192
205
|
#
|
193
|
-
# @option options [
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
206
|
+
# @option options [Boolean] :disable_request_compression (false)
|
207
|
+
# When set to 'true' the request body will not be compressed
|
208
|
+
# for supported operations.
|
209
|
+
#
|
210
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
211
|
+
# Normally you should not configure the `:endpoint` option
|
212
|
+
# directly. This is normally constructed from the `:region`
|
213
|
+
# option. Configuring `:endpoint` is normally reserved for
|
214
|
+
# connecting to test or custom endpoints. The endpoint should
|
215
|
+
# be a URI formatted like:
|
216
|
+
#
|
217
|
+
# 'http://example.com'
|
218
|
+
# 'https://example.com'
|
219
|
+
# 'http://example.com:123'
|
197
220
|
#
|
198
221
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
222
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -210,6 +233,10 @@ module Aws::SNS
|
|
210
233
|
# @option options [Boolean] :endpoint_discovery (false)
|
211
234
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
235
|
#
|
236
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
237
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
238
|
+
# variables and the shared configuration file.
|
239
|
+
#
|
213
240
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
241
|
# The log formatter.
|
215
242
|
#
|
@@ -230,6 +257,34 @@ module Aws::SNS
|
|
230
257
|
# Used when loading credentials from the shared credentials file
|
231
258
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
259
|
#
|
260
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
261
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
262
|
+
#
|
263
|
+
# * `when_supported` - (default) When set, a checksum will be
|
264
|
+
# calculated for all request payloads of operations modeled with the
|
265
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
266
|
+
# `requestAlgorithmMember` is modeled.
|
267
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
268
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
269
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
270
|
+
# is modeled and supplied.
|
271
|
+
#
|
272
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
273
|
+
# The minimum size in bytes that triggers compression for request
|
274
|
+
# bodies. The value must be non-negative integer value between 0
|
275
|
+
# and 10485780 bytes inclusive.
|
276
|
+
#
|
277
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
278
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
279
|
+
#
|
280
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
281
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
282
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
283
|
+
# are supported.
|
284
|
+
# * `when_required` - When set, checksum validation is not performed on
|
285
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
286
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
287
|
+
#
|
233
288
|
# @option options [Proc] :retry_backoff
|
234
289
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
290
|
# This option is only used in the `legacy` retry mode.
|
@@ -274,11 +329,25 @@ module Aws::SNS
|
|
274
329
|
# throttling. This is a provisional mode that may change behavior
|
275
330
|
# in the future.
|
276
331
|
#
|
332
|
+
# @option options [String] :sdk_ua_app_id
|
333
|
+
# A unique and opaque application ID that is appended to the
|
334
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
335
|
+
# maximum length of 50. This variable is sourced from environment
|
336
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
277
337
|
#
|
278
338
|
# @option options [String] :secret_access_key
|
279
339
|
#
|
280
340
|
# @option options [String] :session_token
|
281
341
|
#
|
342
|
+
# @option options [Array] :sigv4a_signing_region_set
|
343
|
+
# A list of regions that should be signed with SigV4a signing. When
|
344
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
345
|
+
# in the following locations:
|
346
|
+
#
|
347
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
348
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
349
|
+
# * `~/.aws/config`
|
350
|
+
#
|
282
351
|
# @option options [Boolean] :stub_responses (false)
|
283
352
|
# Causes the client to return stubbed responses. By default
|
284
353
|
# fake responses are generated and returned. You can specify
|
@@ -288,6 +357,16 @@ module Aws::SNS
|
|
288
357
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
358
|
# requests are made, and retries are disabled.
|
290
359
|
#
|
360
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
361
|
+
# Allows you to provide a telemetry provider, which is used to
|
362
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
363
|
+
# will not record or emit any telemetry data. The SDK supports the
|
364
|
+
# following telemetry providers:
|
365
|
+
#
|
366
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
367
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
368
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
369
|
+
#
|
291
370
|
# @option options [Aws::TokenProvider] :token_provider
|
292
371
|
# A Bearer Token Provider. This can be an instance of any one of the
|
293
372
|
# following classes:
|
@@ -315,52 +394,75 @@ module Aws::SNS
|
|
315
394
|
# sending the request.
|
316
395
|
#
|
317
396
|
# @option options [Aws::SNS::EndpointProvider] :endpoint_provider
|
318
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
# `
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
397
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
398
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
399
|
+
# `Aws::SNS::EndpointParameters`.
|
400
|
+
#
|
401
|
+
# @option options [Float] :http_continue_timeout (1)
|
402
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
403
|
+
# request body. This option has no effect unless the request has "Expect"
|
404
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
405
|
+
# behaviour. This value can safely be set per request on the session.
|
406
|
+
#
|
407
|
+
# @option options [Float] :http_idle_timeout (5)
|
408
|
+
# The number of seconds a connection is allowed to sit idle before it
|
409
|
+
# is considered stale. Stale connections are closed and removed from the
|
410
|
+
# pool before making a request.
|
411
|
+
#
|
412
|
+
# @option options [Float] :http_open_timeout (15)
|
413
|
+
# The default number of seconds to wait for response data.
|
414
|
+
# This value can safely be set per-request on the session.
|
415
|
+
#
|
416
|
+
# @option options [URI::HTTP,String] :http_proxy
|
417
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
418
|
+
#
|
419
|
+
# @option options [Float] :http_read_timeout (60)
|
420
|
+
# The default number of seconds to wait for response data.
|
421
|
+
# This value can safely be set per-request on the session.
|
422
|
+
#
|
423
|
+
# @option options [Boolean] :http_wire_trace (false)
|
424
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
425
|
+
#
|
426
|
+
# @option options [Proc] :on_chunk_received
|
427
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
428
|
+
# of the response body is received. It provides three arguments: the chunk,
|
429
|
+
# the number of bytes received, and the total number of
|
430
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
431
|
+
#
|
432
|
+
# @option options [Proc] :on_chunk_sent
|
433
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
434
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
435
|
+
# the number of bytes read from the body, and the total number of
|
436
|
+
# bytes in the body.
|
437
|
+
#
|
438
|
+
# @option options [Boolean] :raise_response_errors (true)
|
439
|
+
# When `true`, response errors are raised.
|
440
|
+
#
|
441
|
+
# @option options [String] :ssl_ca_bundle
|
442
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
443
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
444
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
445
|
+
#
|
446
|
+
# @option options [String] :ssl_ca_directory
|
447
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
448
|
+
# authority files for verifying peer certificates. If you do
|
449
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
450
|
+
# default will be used if available.
|
342
451
|
#
|
343
|
-
# @option options [
|
344
|
-
#
|
452
|
+
# @option options [String] :ssl_ca_store
|
453
|
+
# Sets the X509::Store to verify peer certificate.
|
345
454
|
#
|
346
|
-
# @option options [
|
347
|
-
#
|
455
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
456
|
+
# Sets a client certificate when creating http connections.
|
348
457
|
#
|
349
|
-
# @option options [
|
350
|
-
#
|
351
|
-
# connection.
|
458
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
459
|
+
# Sets a client key when creating http connections.
|
352
460
|
#
|
353
|
-
# @option options [
|
354
|
-
#
|
355
|
-
# verifying peer certificates. If you do not pass
|
356
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
-
# will be used if available.
|
461
|
+
# @option options [Float] :ssl_timeout
|
462
|
+
# Sets the SSL timeout in seconds
|
358
463
|
#
|
359
|
-
# @option options [
|
360
|
-
#
|
361
|
-
# authority files for verifying peer certificates. If you do
|
362
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
-
# system default will be used if available.
|
464
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
465
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
364
466
|
#
|
365
467
|
def initialize(*args)
|
366
468
|
super
|
@@ -501,27 +603,34 @@ module Aws::SNS
|
|
501
603
|
# `PlatformPrincipal` and `PlatformCredential` are received from the
|
502
604
|
# notification service.
|
503
605
|
#
|
504
|
-
# * For
|
505
|
-
#
|
606
|
+
# * For ADM, `PlatformPrincipal` is `client id` and `PlatformCredential`
|
607
|
+
# is `client secret`.
|
506
608
|
#
|
507
|
-
# * For
|
508
|
-
# `PlatformCredential` is `secret key`.
|
509
|
-
#
|
510
|
-
# * For `APNS` and `APNS_SANDBOX` using certificate credentials,
|
609
|
+
# * For APNS and `APNS_SANDBOX` using certificate credentials,
|
511
610
|
# `PlatformPrincipal` is `SSL certificate` and `PlatformCredential` is
|
512
611
|
# `private key`.
|
513
612
|
#
|
514
|
-
# * For
|
613
|
+
# * For APNS and `APNS_SANDBOX` using token credentials,
|
515
614
|
# `PlatformPrincipal` is `signing key ID` and `PlatformCredential` is
|
516
615
|
# `signing key`.
|
517
616
|
#
|
518
|
-
# * For `
|
519
|
-
#
|
617
|
+
# * For Baidu, `PlatformPrincipal` is `API key` and `PlatformCredential`
|
618
|
+
# is `secret key`.
|
619
|
+
#
|
620
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there is
|
621
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
|
520
622
|
#
|
521
|
-
# * For
|
623
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials, there is
|
624
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is a JSON formatted
|
625
|
+
# private key file. When using the Amazon Web Services CLI, the file
|
626
|
+
# must be in string format and special characters must be ignored. To
|
627
|
+
# format the file correctly, Amazon SNS recommends using the following
|
628
|
+
# command: `` SERVICE_JSON=`jq @json <<< cat service.json` ``.
|
629
|
+
#
|
630
|
+
# * For MPNS, `PlatformPrincipal` is `TLS certificate` and
|
522
631
|
# `PlatformCredential` is `private key`.
|
523
632
|
#
|
524
|
-
# * For
|
633
|
+
# * For WNS, `PlatformPrincipal` is `Package Security Identifier` and
|
525
634
|
# `PlatformCredential` is `secret key`.
|
526
635
|
#
|
527
636
|
# You can use the returned `PlatformApplicationArn` as an attribute for
|
@@ -538,7 +647,8 @@ module Aws::SNS
|
|
538
647
|
# (Firebase Cloud Messaging).
|
539
648
|
#
|
540
649
|
# @option params [required, Hash<String,String>] :attributes
|
541
|
-
# For a list of attributes, see [SetPlatformApplicationAttributes
|
650
|
+
# For a list of attributes, see [ `SetPlatformApplicationAttributes`
|
651
|
+
# ][1].
|
542
652
|
#
|
543
653
|
#
|
544
654
|
#
|
@@ -594,8 +704,8 @@ module Aws::SNS
|
|
594
704
|
# [2]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html
|
595
705
|
#
|
596
706
|
# @option params [required, String] :platform_application_arn
|
597
|
-
# PlatformApplicationArn returned from CreatePlatformApplication is
|
598
|
-
# to create a an endpoint.
|
707
|
+
# `PlatformApplicationArn` returned from CreatePlatformApplication is
|
708
|
+
# used to create a an endpoint.
|
599
709
|
#
|
600
710
|
# @option params [required, String] :token
|
601
711
|
# Unique identifier created by the notification service for an app on a
|
@@ -610,7 +720,7 @@ module Aws::SNS
|
|
610
720
|
# not use this data. The data must be in UTF-8 format and less than 2KB.
|
611
721
|
#
|
612
722
|
# @option params [Hash<String,String>] :attributes
|
613
|
-
# For a list of attributes, see [SetEndpointAttributes][1].
|
723
|
+
# For a list of attributes, see [ `SetEndpointAttributes` ][1].
|
614
724
|
#
|
615
725
|
#
|
616
726
|
#
|
@@ -712,7 +822,7 @@ module Aws::SNS
|
|
712
822
|
# @option params [Hash<String,String>] :attributes
|
713
823
|
# A map of attributes with their corresponding values.
|
714
824
|
#
|
715
|
-
# The following lists
|
825
|
+
# The following lists names, descriptions, and values of the special
|
716
826
|
# request parameters that the `CreateTopic` action uses:
|
717
827
|
#
|
718
828
|
# * `DeliveryPolicy` – The policy that defines how Amazon SNS retries
|
@@ -739,7 +849,7 @@ module Aws::SNS
|
|
739
849
|
# segment data to topic owner account if the sampled flag in the
|
740
850
|
# tracing header is true. This is only supported on standard topics.
|
741
851
|
#
|
742
|
-
# The following attribute applies only to [server-side encryption][1]
|
852
|
+
# The following attribute applies only to [server-side encryption][1]:
|
743
853
|
#
|
744
854
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
745
855
|
# master key (CMK) for Amazon SNS or a custom CMK. For more
|
@@ -748,9 +858,10 @@ module Aws::SNS
|
|
748
858
|
#
|
749
859
|
# ^
|
750
860
|
#
|
751
|
-
# The following attributes apply only to [FIFO topics][4]
|
861
|
+
# The following attributes apply only to [FIFO topics][4]:
|
752
862
|
#
|
753
|
-
# * `
|
863
|
+
# * `ArchivePolicy` – The policy that sets the retention period for
|
864
|
+
# messages stored in the message archive of an Amazon SNS FIFO topic.
|
754
865
|
#
|
755
866
|
# * `ContentBasedDeduplication` – Enables content-based deduplication
|
756
867
|
# for FIFO topics.
|
@@ -767,6 +878,22 @@ module Aws::SNS
|
|
767
878
|
# (Optional) To override the generated value, you can specify a
|
768
879
|
# value for the `MessageDeduplicationId` parameter for the `Publish`
|
769
880
|
# action.
|
881
|
+
# ^
|
882
|
+
#
|
883
|
+
# * `FifoThroughputScope` – Enables higher throughput for your FIFO
|
884
|
+
# topic by adjusting the scope of deduplication. This attribute has
|
885
|
+
# two possible values:
|
886
|
+
#
|
887
|
+
# * `Topic` – The scope of message deduplication is across the entire
|
888
|
+
# topic. This is the default value and maintains existing behavior,
|
889
|
+
# with a maximum throughput of 3000 messages per second or 20MB per
|
890
|
+
# second, whichever comes first.
|
891
|
+
#
|
892
|
+
# * `MessageGroup` – The scope of deduplication is within each
|
893
|
+
# individual message group, which enables higher throughput per
|
894
|
+
# topic subject to regional quotas. For more information on quotas
|
895
|
+
# or to request an increase, see [Amazon SNS service quotas][6] in
|
896
|
+
# the Amazon Web Services General Reference.
|
770
897
|
#
|
771
898
|
#
|
772
899
|
#
|
@@ -775,6 +902,7 @@ module Aws::SNS
|
|
775
902
|
# [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
776
903
|
# [4]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
777
904
|
# [5]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
|
905
|
+
# [6]: https://docs.aws.amazon.com/general/latest/gr/sns.html
|
778
906
|
#
|
779
907
|
# @option params [Array<Types::Tag>] :tags
|
780
908
|
# The list of tags to add to a new topic.
|
@@ -838,7 +966,7 @@ module Aws::SNS
|
|
838
966
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
839
967
|
#
|
840
968
|
# @option params [required, String] :endpoint_arn
|
841
|
-
# EndpointArn of endpoint to delete.
|
969
|
+
# `EndpointArn` of endpoint to delete.
|
842
970
|
#
|
843
971
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
844
972
|
#
|
@@ -867,7 +995,7 @@ module Aws::SNS
|
|
867
995
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
868
996
|
#
|
869
997
|
# @option params [required, String] :platform_application_arn
|
870
|
-
# PlatformApplicationArn of platform application object to delete.
|
998
|
+
# `PlatformApplicationArn` of platform application object to delete.
|
871
999
|
#
|
872
1000
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
873
1001
|
#
|
@@ -994,7 +1122,7 @@ module Aws::SNS
|
|
994
1122
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
995
1123
|
#
|
996
1124
|
# @option params [required, String] :endpoint_arn
|
997
|
-
# EndpointArn for GetEndpointAttributes input.
|
1125
|
+
# `EndpointArn` for `GetEndpointAttributes` input.
|
998
1126
|
#
|
999
1127
|
# @return [Types::GetEndpointAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1000
1128
|
#
|
@@ -1030,7 +1158,7 @@ module Aws::SNS
|
|
1030
1158
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1031
1159
|
#
|
1032
1160
|
# @option params [required, String] :platform_application_arn
|
1033
|
-
# PlatformApplicationArn for GetPlatformApplicationAttributesInput.
|
1161
|
+
# `PlatformApplicationArn` for GetPlatformApplicationAttributesInput.
|
1034
1162
|
#
|
1035
1163
|
# @return [Types::GetPlatformApplicationAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1036
1164
|
#
|
@@ -1209,12 +1337,12 @@ module Aws::SNS
|
|
1209
1337
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1210
1338
|
#
|
1211
1339
|
# @option params [required, String] :platform_application_arn
|
1212
|
-
# PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
|
1340
|
+
# `PlatformApplicationArn` for `ListEndpointsByPlatformApplicationInput`
|
1213
1341
|
# action.
|
1214
1342
|
#
|
1215
1343
|
# @option params [String] :next_token
|
1216
|
-
# NextToken string is used when calling
|
1217
|
-
# ListEndpointsByPlatformApplication action to retrieve additional
|
1344
|
+
# `NextToken` string is used when calling
|
1345
|
+
# `ListEndpointsByPlatformApplication` action to retrieve additional
|
1218
1346
|
# records that are available after the first page results.
|
1219
1347
|
#
|
1220
1348
|
# @return [Types::ListEndpointsByPlatformApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1360,9 +1488,9 @@ module Aws::SNS
|
|
1360
1488
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1361
1489
|
#
|
1362
1490
|
# @option params [String] :next_token
|
1363
|
-
# NextToken string is used when calling ListPlatformApplications
|
1364
|
-
# to retrieve additional records that are available after the
|
1365
|
-
# results.
|
1491
|
+
# `NextToken` string is used when calling `ListPlatformApplications`
|
1492
|
+
# action to retrieve additional records that are available after the
|
1493
|
+
# first page results.
|
1366
1494
|
#
|
1367
1495
|
# @return [Types::ListPlatformApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1368
1496
|
#
|
@@ -1742,9 +1870,8 @@ module Aws::SNS
|
|
1742
1870
|
# is delivered to email endpoints. This field will also be included, if
|
1743
1871
|
# present, in the standard JSON messages delivered to other endpoints.
|
1744
1872
|
#
|
1745
|
-
# Constraints: Subjects must be
|
1746
|
-
#
|
1747
|
-
# characters; and must be less than 100 characters long.
|
1873
|
+
# Constraints: Subjects must be UTF-8 text with no line breaks or
|
1874
|
+
# control characters, and less than 100 characters long.
|
1748
1875
|
#
|
1749
1876
|
# @option params [String] :message_structure
|
1750
1877
|
# Set `MessageStructure` to `json` if you want to send a different
|
@@ -1767,25 +1894,55 @@ module Aws::SNS
|
|
1767
1894
|
# Message attributes for Publish action.
|
1768
1895
|
#
|
1769
1896
|
# @option params [String] :message_deduplication_id
|
1770
|
-
# This parameter applies only to FIFO (first-in-first-out) topics. The
|
1771
|
-
#
|
1772
|
-
#
|
1773
|
-
#
|
1774
|
-
#
|
1775
|
-
# Every message must have a unique `MessageDeduplicationId`, which is
|
1776
|
-
#
|
1777
|
-
#
|
1778
|
-
#
|
1779
|
-
#
|
1780
|
-
#
|
1781
|
-
#
|
1782
|
-
#
|
1783
|
-
#
|
1897
|
+
# * This parameter applies only to FIFO (first-in-first-out) topics. The
|
1898
|
+
# `MessageDeduplicationId` can contain up to 128 alphanumeric
|
1899
|
+
# characters `(a-z, A-Z, 0-9)` and punctuation ``
|
1900
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
1901
|
+
#
|
1902
|
+
# * Every message must have a unique `MessageDeduplicationId`, which is
|
1903
|
+
# a token used for deduplication of sent messages within the 5 minute
|
1904
|
+
# minimum deduplication interval.
|
1905
|
+
#
|
1906
|
+
# * The scope of deduplication depends on the `FifoThroughputScope`
|
1907
|
+
# attribute, when set to `Topic` the message deduplication scope is
|
1908
|
+
# across the entire topic, when set to `MessageGroup` the message
|
1909
|
+
# deduplication scope is within each individual message group.
|
1910
|
+
#
|
1911
|
+
# * If a message with a particular `MessageDeduplicationId` is sent
|
1912
|
+
# successfully, subsequent messages within the deduplication scope and
|
1913
|
+
# interval, with the same `MessageDeduplicationId`, are accepted
|
1914
|
+
# successfully but aren't delivered.
|
1915
|
+
#
|
1916
|
+
# * Every message must have a unique `MessageDeduplicationId`:
|
1917
|
+
#
|
1918
|
+
# * You may provide a `MessageDeduplicationId` explicitly.
|
1919
|
+
#
|
1920
|
+
# * If you aren't able to provide a `MessageDeduplicationId` and you
|
1921
|
+
# enable `ContentBasedDeduplication` for your topic, Amazon SNS uses
|
1922
|
+
# a SHA-256 hash to generate the `MessageDeduplicationId` using the
|
1923
|
+
# body of the message (but not the attributes of the message).
|
1924
|
+
#
|
1925
|
+
# * If you don't provide a `MessageDeduplicationId` and the topic
|
1926
|
+
# doesn't have `ContentBasedDeduplication` set, the action fails
|
1927
|
+
# with an error.
|
1928
|
+
#
|
1929
|
+
# * If the topic has a `ContentBasedDeduplication` set, your
|
1930
|
+
# `MessageDeduplicationId` overrides the generated one.
|
1931
|
+
# * When `ContentBasedDeduplication` is in effect, messages with
|
1932
|
+
# identical content sent within the deduplication scope and interval
|
1933
|
+
# are treated as duplicates and only one copy of the message is
|
1934
|
+
# delivered.
|
1935
|
+
#
|
1936
|
+
# * If you send one message with `ContentBasedDeduplication` enabled,
|
1937
|
+
# and then another message with a `MessageDeduplicationId` that is the
|
1938
|
+
# same as the one generated for the first `MessageDeduplicationId`,
|
1939
|
+
# the two messages are treated as duplicates, within the deduplication
|
1940
|
+
# scope and interval, and only one copy of the message is delivered.
|
1784
1941
|
#
|
1785
1942
|
# @option params [String] :message_group_id
|
1786
1943
|
# This parameter applies only to FIFO (first-in-first-out) topics. The
|
1787
1944
|
# `MessageGroupId` can contain up to 128 alphanumeric characters `(a-z,
|
1788
|
-
# A-Z, 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_
|
1945
|
+
# A-Z, 0-9)` and punctuation `` (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
1789
1946
|
#
|
1790
1947
|
# The `MessageGroupId` is a tag that specifies that a message belongs to
|
1791
1948
|
# a specific message group. Messages that belong to the same message
|
@@ -1803,7 +1960,7 @@ module Aws::SNS
|
|
1803
1960
|
# resp = client.publish({
|
1804
1961
|
# topic_arn: "topicARN",
|
1805
1962
|
# target_arn: "String",
|
1806
|
-
# phone_number: "
|
1963
|
+
# phone_number: "PhoneNumber",
|
1807
1964
|
# message: "message", # required
|
1808
1965
|
# subject: "subject",
|
1809
1966
|
# message_structure: "messageStructure",
|
@@ -1999,7 +2156,7 @@ module Aws::SNS
|
|
1999
2156
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
2000
2157
|
#
|
2001
2158
|
# @option params [required, String] :endpoint_arn
|
2002
|
-
# EndpointArn used for SetEndpointAttributes action.
|
2159
|
+
# EndpointArn used for `SetEndpointAttributes` action.
|
2003
2160
|
#
|
2004
2161
|
# @option params [required, Hash<String,String>] :attributes
|
2005
2162
|
# A map of the endpoint attributes. Attributes in this map include the
|
@@ -2052,7 +2209,8 @@ module Aws::SNS
|
|
2052
2209
|
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
|
2053
2210
|
#
|
2054
2211
|
# @option params [required, String] :platform_application_arn
|
2055
|
-
# PlatformApplicationArn for SetPlatformApplicationAttributes
|
2212
|
+
# `PlatformApplicationArn` for `SetPlatformApplicationAttributes`
|
2213
|
+
# action.
|
2056
2214
|
#
|
2057
2215
|
# @option params [required, Hash<String,String>] :attributes
|
2058
2216
|
# A map of the platform application attributes. Attributes in this map
|
@@ -2069,8 +2227,16 @@ module Aws::SNS
|
|
2069
2227
|
# * For Apple Services using token credentials, `PlatformCredential`
|
2070
2228
|
# is signing key.
|
2071
2229
|
#
|
2072
|
-
# * For GCM (Firebase Cloud Messaging),
|
2073
|
-
# key
|
2230
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there is
|
2231
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
|
2232
|
+
#
|
2233
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials, there
|
2234
|
+
# is no `PlatformPrincipal`. The `PlatformCredential` is a JSON
|
2235
|
+
# formatted private key file. When using the Amazon Web Services
|
2236
|
+
# CLI, the file must be in string format and special characters must
|
2237
|
+
# be ignored. To format the file correctly, Amazon SNS recommends
|
2238
|
+
# using the following command: `` SERVICE_JSON=`jq @json <<< cat
|
2239
|
+
# service.json` ``.
|
2074
2240
|
# ^
|
2075
2241
|
#
|
2076
2242
|
# * `PlatformPrincipal` – The principal received from the notification
|
@@ -2287,7 +2453,6 @@ module Aws::SNS
|
|
2287
2453
|
# message attributes.
|
2288
2454
|
#
|
2289
2455
|
# * `MessageBody` – The filter is applied on the message body.
|
2290
|
-
#
|
2291
2456
|
# * `RawMessageDelivery` – When set to `true`, enables raw message
|
2292
2457
|
# delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
|
2293
2458
|
# for the endpoints to process JSON formatting, which is otherwise
|
@@ -2300,20 +2465,18 @@ module Aws::SNS
|
|
2300
2465
|
# service that powers the subscribed endpoint becomes unavailable) are
|
2301
2466
|
# held in the dead-letter queue for further analysis or reprocessing.
|
2302
2467
|
#
|
2303
|
-
# The following attribute applies only to Amazon
|
2304
|
-
#
|
2468
|
+
# The following attribute applies only to Amazon Data Firehose delivery
|
2469
|
+
# stream subscriptions:
|
2305
2470
|
#
|
2306
2471
|
# * `SubscriptionRoleArn` – The ARN of the IAM role that has the
|
2307
2472
|
# following:
|
2308
2473
|
#
|
2309
|
-
# * Permission to write to the
|
2474
|
+
# * Permission to write to the Firehose delivery stream
|
2310
2475
|
#
|
2311
2476
|
# * Amazon SNS listed as a trusted entity
|
2312
|
-
#
|
2313
|
-
#
|
2314
|
-
#
|
2315
|
-
# see [Fanout to Kinesis Data Firehose delivery streams][1] in the
|
2316
|
-
# *Amazon SNS Developer Guide*.
|
2477
|
+
# Specifying a valid ARN for this attribute is required for Firehose
|
2478
|
+
# delivery stream subscriptions. For more information, see [Fanout to
|
2479
|
+
# Firehose delivery streams][1] in the *Amazon SNS Developer Guide*.
|
2317
2480
|
#
|
2318
2481
|
#
|
2319
2482
|
#
|
@@ -2391,7 +2554,6 @@ module Aws::SNS
|
|
2391
2554
|
# * `HTTPFailureFeedbackRoleArn` – Indicates failed message delivery
|
2392
2555
|
# status for an Amazon SNS topic that is subscribed to an HTTP
|
2393
2556
|
# endpoint.
|
2394
|
-
#
|
2395
2557
|
# * Amazon Kinesis Data Firehose
|
2396
2558
|
#
|
2397
2559
|
# * `FirehoseSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -2405,7 +2567,6 @@ module Aws::SNS
|
|
2405
2567
|
# * `FirehoseFailureFeedbackRoleArn` – Indicates failed message
|
2406
2568
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2407
2569
|
# Amazon Kinesis Data Firehose endpoint.
|
2408
|
-
#
|
2409
2570
|
# * Lambda
|
2410
2571
|
#
|
2411
2572
|
# * `LambdaSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -2419,7 +2580,6 @@ module Aws::SNS
|
|
2419
2580
|
# * `LambdaFailureFeedbackRoleArn` – Indicates failed message delivery
|
2420
2581
|
# status for an Amazon SNS topic that is subscribed to an Lambda
|
2421
2582
|
# endpoint.
|
2422
|
-
#
|
2423
2583
|
# * Platform application endpoint
|
2424
2584
|
#
|
2425
2585
|
# * `ApplicationSuccessFeedbackRoleArn` – Indicates successful message
|
@@ -2433,7 +2593,6 @@ module Aws::SNS
|
|
2433
2593
|
# * `ApplicationFailureFeedbackRoleArn` – Indicates failed message
|
2434
2594
|
# delivery status for an Amazon SNS topic that is subscribed to an
|
2435
2595
|
# Amazon Web Services application endpoint.
|
2436
|
-
#
|
2437
2596
|
# <note markdown="1"> In addition to being able to configure topic attributes for message
|
2438
2597
|
# delivery status of notification messages sent to Amazon SNS
|
2439
2598
|
# application endpoints, you can also configure application attributes
|
@@ -2470,7 +2629,7 @@ module Aws::SNS
|
|
2470
2629
|
#
|
2471
2630
|
# </note>
|
2472
2631
|
#
|
2473
|
-
# The following attribute applies only to [server-side-encryption][2]
|
2632
|
+
# The following attribute applies only to [server-side-encryption][2]:
|
2474
2633
|
#
|
2475
2634
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2476
2635
|
# master key (CMK) for Amazon SNS or a custom CMK. For more
|
@@ -2483,7 +2642,10 @@ module Aws::SNS
|
|
2483
2642
|
# confirmation messages sent by Amazon SNS. By default,
|
2484
2643
|
# `SignatureVersion` is set to `1`.
|
2485
2644
|
#
|
2486
|
-
# The following attribute applies only to [FIFO topics][5]
|
2645
|
+
# The following attribute applies only to [FIFO topics][5]:
|
2646
|
+
#
|
2647
|
+
# * `ArchivePolicy` – The policy that sets the retention period for
|
2648
|
+
# messages stored in the message archive of an Amazon SNS FIFO topic.
|
2487
2649
|
#
|
2488
2650
|
# * `ContentBasedDeduplication` – Enables content-based deduplication
|
2489
2651
|
# for FIFO topics.
|
@@ -2500,6 +2662,22 @@ module Aws::SNS
|
|
2500
2662
|
# (Optional) To override the generated value, you can specify a
|
2501
2663
|
# value for the `MessageDeduplicationId` parameter for the `Publish`
|
2502
2664
|
# action.
|
2665
|
+
# ^
|
2666
|
+
#
|
2667
|
+
# * `FifoThroughputScope` – Enables higher throughput for your FIFO
|
2668
|
+
# topic by adjusting the scope of deduplication. This attribute has
|
2669
|
+
# two possible values:
|
2670
|
+
#
|
2671
|
+
# * `Topic` – The scope of message deduplication is across the entire
|
2672
|
+
# topic. This is the default value and maintains existing behavior,
|
2673
|
+
# with a maximum throughput of 3000 messages per second or 20MB per
|
2674
|
+
# second, whichever comes first.
|
2675
|
+
#
|
2676
|
+
# * `MessageGroup` – The scope of deduplication is within each
|
2677
|
+
# individual message group, which enables higher throughput per
|
2678
|
+
# topic subject to regional quotas. For more information on quotas
|
2679
|
+
# or to request an increase, see [Amazon SNS service quotas][7] in
|
2680
|
+
# the Amazon Web Services General Reference.
|
2503
2681
|
#
|
2504
2682
|
#
|
2505
2683
|
#
|
@@ -2509,6 +2687,7 @@ module Aws::SNS
|
|
2509
2687
|
# [4]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
2510
2688
|
# [5]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
2511
2689
|
# [6]: https://docs.aws.amazon.com/sns/latest/api/API_Publish.html
|
2690
|
+
# [7]: https://docs.aws.amazon.com/general/latest/gr/sns.html
|
2512
2691
|
#
|
2513
2692
|
# @option params [String] :attribute_value
|
2514
2693
|
# The new value for the attribute.
|
@@ -2538,7 +2717,7 @@ module Aws::SNS
|
|
2538
2717
|
# `ConfirmSubscription` action to confirm the subscription.
|
2539
2718
|
#
|
2540
2719
|
# You call the `ConfirmSubscription` action with the token from the
|
2541
|
-
# subscription response. Confirmation tokens are valid for
|
2720
|
+
# subscription response. Confirmation tokens are valid for two days.
|
2542
2721
|
#
|
2543
2722
|
# This action is throttled at 100 transactions per second (TPS).
|
2544
2723
|
#
|
@@ -2617,7 +2796,6 @@ module Aws::SNS
|
|
2617
2796
|
# message attributes.
|
2618
2797
|
#
|
2619
2798
|
# * `MessageBody` – The filter is applied on the message body.
|
2620
|
-
#
|
2621
2799
|
# * `RawMessageDelivery` – When set to `true`, enables raw message
|
2622
2800
|
# delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need
|
2623
2801
|
# for the endpoints to process JSON formatting, which is otherwise
|
@@ -2630,24 +2808,44 @@ module Aws::SNS
|
|
2630
2808
|
# service that powers the subscribed endpoint becomes unavailable) are
|
2631
2809
|
# held in the dead-letter queue for further analysis or reprocessing.
|
2632
2810
|
#
|
2633
|
-
# The following attribute applies only to Amazon
|
2634
|
-
#
|
2811
|
+
# The following attribute applies only to Amazon Data Firehose delivery
|
2812
|
+
# stream subscriptions:
|
2635
2813
|
#
|
2636
2814
|
# * `SubscriptionRoleArn` – The ARN of the IAM role that has the
|
2637
2815
|
# following:
|
2638
2816
|
#
|
2639
|
-
# * Permission to write to the
|
2817
|
+
# * Permission to write to the Firehose delivery stream
|
2640
2818
|
#
|
2641
2819
|
# * Amazon SNS listed as a trusted entity
|
2820
|
+
# Specifying a valid ARN for this attribute is required for Firehose
|
2821
|
+
# delivery stream subscriptions. For more information, see [Fanout to
|
2822
|
+
# Firehose delivery streams][1] in the *Amazon SNS Developer Guide*.
|
2823
|
+
#
|
2824
|
+
# The following attributes apply only to [FIFO topics][2]:
|
2825
|
+
#
|
2826
|
+
# * `ReplayPolicy` – Adds or updates an inline policy document for a
|
2827
|
+
# subscription to replay messages stored in the specified Amazon SNS
|
2828
|
+
# topic.
|
2829
|
+
#
|
2830
|
+
# * `ReplayStatus` – Retrieves the status of the subscription message
|
2831
|
+
# replay, which can be one of the following:
|
2832
|
+
#
|
2833
|
+
# * `Completed` – The replay has successfully redelivered all
|
2834
|
+
# messages, and is now delivering newly published messages. If an
|
2835
|
+
# ending point was specified in the `ReplayPolicy` then the
|
2836
|
+
# subscription will no longer receive newly published messages.
|
2837
|
+
#
|
2838
|
+
# * `In progress` – The replay is currently replaying the selected
|
2839
|
+
# messages.
|
2840
|
+
#
|
2841
|
+
# * `Failed` – The replay was unable to complete.
|
2642
2842
|
#
|
2643
|
-
#
|
2644
|
-
# Data Firehose delivery stream subscriptions. For more information,
|
2645
|
-
# see [Fanout to Kinesis Data Firehose delivery streams][1] in the
|
2646
|
-
# *Amazon SNS Developer Guide*.
|
2843
|
+
# * `Pending` – The default state while the replay initiates.
|
2647
2844
|
#
|
2648
2845
|
#
|
2649
2846
|
#
|
2650
2847
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
|
2848
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
2651
2849
|
#
|
2652
2850
|
# @option params [Boolean] :return_subscription_arn
|
2653
2851
|
# Sets whether the response from the `Subscribe` request includes the
|
@@ -2862,14 +3060,19 @@ module Aws::SNS
|
|
2862
3060
|
# @api private
|
2863
3061
|
def build_request(operation_name, params = {})
|
2864
3062
|
handlers = @handlers.for(operation_name)
|
3063
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
3064
|
+
Aws::Telemetry.module_to_tracer_name('Aws::SNS')
|
3065
|
+
)
|
2865
3066
|
context = Seahorse::Client::RequestContext.new(
|
2866
3067
|
operation_name: operation_name,
|
2867
3068
|
operation: config.api.operation(operation_name),
|
2868
3069
|
client: self,
|
2869
3070
|
params: params,
|
2870
|
-
config: config
|
3071
|
+
config: config,
|
3072
|
+
tracer: tracer
|
3073
|
+
)
|
2871
3074
|
context[:gem_name] = 'aws-sdk-sns'
|
2872
|
-
context[:gem_version] = '1.
|
3075
|
+
context[:gem_version] = '1.96.0'
|
2873
3076
|
Seahorse::Client::Request.new(handlers, context)
|
2874
3077
|
end
|
2875
3078
|
|