aws-sdk-sns 1.66.0 → 1.75.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 +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/lib/aws-sdk-sns/types.rb
CHANGED
@@ -123,7 +123,7 @@ module Aws::SNS
|
|
123
123
|
#
|
124
124
|
class CheckIfPhoneNumberIsOptedOutInput < Struct.new(
|
125
125
|
:phone_number)
|
126
|
-
SENSITIVE = []
|
126
|
+
SENSITIVE = [:phone_number]
|
127
127
|
include Aws::Structure
|
128
128
|
end
|
129
129
|
|
@@ -232,7 +232,8 @@ module Aws::SNS
|
|
232
232
|
# @return [String]
|
233
233
|
#
|
234
234
|
# @!attribute [rw] attributes
|
235
|
-
# For a list of attributes, see [SetPlatformApplicationAttributes
|
235
|
+
# For a list of attributes, see [ `SetPlatformApplicationAttributes`
|
236
|
+
# ][1].
|
236
237
|
#
|
237
238
|
#
|
238
239
|
#
|
@@ -252,7 +253,7 @@ module Aws::SNS
|
|
252
253
|
# Response from CreatePlatformApplication action.
|
253
254
|
#
|
254
255
|
# @!attribute [rw] platform_application_arn
|
255
|
-
# PlatformApplicationArn is returned.
|
256
|
+
# `PlatformApplicationArn` is returned.
|
256
257
|
# @return [String]
|
257
258
|
#
|
258
259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/CreatePlatformApplicationResponse AWS API Documentation
|
@@ -266,7 +267,7 @@ module Aws::SNS
|
|
266
267
|
# Input for CreatePlatformEndpoint action.
|
267
268
|
#
|
268
269
|
# @!attribute [rw] platform_application_arn
|
269
|
-
# PlatformApplicationArn returned from CreatePlatformApplication is
|
270
|
+
# `PlatformApplicationArn` returned from CreatePlatformApplication is
|
270
271
|
# used to create a an endpoint.
|
271
272
|
# @return [String]
|
272
273
|
#
|
@@ -286,7 +287,7 @@ module Aws::SNS
|
|
286
287
|
# @return [String]
|
287
288
|
#
|
288
289
|
# @!attribute [rw] attributes
|
289
|
-
# For a list of attributes, see [SetEndpointAttributes][1].
|
290
|
+
# For a list of attributes, see [ `SetEndpointAttributes` ][1].
|
290
291
|
#
|
291
292
|
#
|
292
293
|
#
|
@@ -320,7 +321,7 @@ module Aws::SNS
|
|
320
321
|
class CreateSMSSandboxPhoneNumberInput < Struct.new(
|
321
322
|
:phone_number,
|
322
323
|
:language_code)
|
323
|
-
SENSITIVE = []
|
324
|
+
SENSITIVE = [:phone_number]
|
324
325
|
include Aws::Structure
|
325
326
|
end
|
326
327
|
|
@@ -384,7 +385,13 @@ module Aws::SNS
|
|
384
385
|
#
|
385
386
|
# The following attributes apply only to [FIFO topics][4]:
|
386
387
|
#
|
387
|
-
# * `
|
388
|
+
# * `ArchivePolicy` – Adds or updates an inline policy document to
|
389
|
+
# archive messages stored in the specified Amazon SNS topic.
|
390
|
+
#
|
391
|
+
# * `BeginningArchiveTime` – The earliest starting point at which a
|
392
|
+
# message in the topic’s archive can be replayed from. This point in
|
393
|
+
# time is based on the configured message retention period set by
|
394
|
+
# the topic’s message archiving policy.
|
388
395
|
#
|
389
396
|
# * `ContentBasedDeduplication` – Enables content-based deduplication
|
390
397
|
# for FIFO topics.
|
@@ -456,10 +463,10 @@ module Aws::SNS
|
|
456
463
|
include Aws::Structure
|
457
464
|
end
|
458
465
|
|
459
|
-
# Input for DeleteEndpoint action.
|
466
|
+
# Input for `DeleteEndpoint` action.
|
460
467
|
#
|
461
468
|
# @!attribute [rw] endpoint_arn
|
462
|
-
# EndpointArn of endpoint to delete.
|
469
|
+
# `EndpointArn` of endpoint to delete.
|
463
470
|
# @return [String]
|
464
471
|
#
|
465
472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointInput AWS API Documentation
|
@@ -470,10 +477,10 @@ module Aws::SNS
|
|
470
477
|
include Aws::Structure
|
471
478
|
end
|
472
479
|
|
473
|
-
# Input for DeletePlatformApplication action.
|
480
|
+
# Input for `DeletePlatformApplication` action.
|
474
481
|
#
|
475
482
|
# @!attribute [rw] platform_application_arn
|
476
|
-
# PlatformApplicationArn of platform application object to delete.
|
483
|
+
# `PlatformApplicationArn` of platform application object to delete.
|
477
484
|
# @return [String]
|
478
485
|
#
|
479
486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationInput AWS API Documentation
|
@@ -492,7 +499,7 @@ module Aws::SNS
|
|
492
499
|
#
|
493
500
|
class DeleteSMSSandboxPhoneNumberInput < Struct.new(
|
494
501
|
:phone_number)
|
495
|
-
SENSITIVE = []
|
502
|
+
SENSITIVE = [:phone_number]
|
496
503
|
include Aws::Structure
|
497
504
|
end
|
498
505
|
|
@@ -605,10 +612,10 @@ module Aws::SNS
|
|
605
612
|
include Aws::Structure
|
606
613
|
end
|
607
614
|
|
608
|
-
# Input for GetEndpointAttributes action.
|
615
|
+
# Input for `GetEndpointAttributes` action.
|
609
616
|
#
|
610
617
|
# @!attribute [rw] endpoint_arn
|
611
|
-
# EndpointArn for GetEndpointAttributes input.
|
618
|
+
# `EndpointArn` for `GetEndpointAttributes` input.
|
612
619
|
# @return [String]
|
613
620
|
#
|
614
621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesInput AWS API Documentation
|
@@ -619,7 +626,7 @@ module Aws::SNS
|
|
619
626
|
include Aws::Structure
|
620
627
|
end
|
621
628
|
|
622
|
-
# Response from GetEndpointAttributes of the EndpointArn
|
629
|
+
# Response from `GetEndpointAttributes` of the `EndpointArn`.
|
623
630
|
#
|
624
631
|
# @!attribute [rw] attributes
|
625
632
|
# Attributes include the following:
|
@@ -651,10 +658,10 @@ module Aws::SNS
|
|
651
658
|
include Aws::Structure
|
652
659
|
end
|
653
660
|
|
654
|
-
# Input for GetPlatformApplicationAttributes action.
|
661
|
+
# Input for `GetPlatformApplicationAttributes` action.
|
655
662
|
#
|
656
663
|
# @!attribute [rw] platform_application_arn
|
657
|
-
# PlatformApplicationArn for GetPlatformApplicationAttributesInput.
|
664
|
+
# `PlatformApplicationArn` for GetPlatformApplicationAttributesInput.
|
658
665
|
# @return [String]
|
659
666
|
#
|
660
667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesInput AWS API Documentation
|
@@ -665,7 +672,7 @@ module Aws::SNS
|
|
665
672
|
include Aws::Structure
|
666
673
|
end
|
667
674
|
|
668
|
-
# Response for GetPlatformApplicationAttributes action.
|
675
|
+
# Response for `GetPlatformApplicationAttributes` action.
|
669
676
|
#
|
670
677
|
# @!attribute [rw] attributes
|
671
678
|
# Attributes include the following:
|
@@ -679,6 +686,14 @@ module Aws::SNS
|
|
679
686
|
# * `ApplePlatformBundleID` – The app identifier used to configure
|
680
687
|
# token-based authentication.
|
681
688
|
#
|
689
|
+
# * `AuthenticationMethod` – Returns the credential type used when
|
690
|
+
# sending push notifications from application to APNS/APNS\_Sandbox,
|
691
|
+
# or application to GCM.
|
692
|
+
#
|
693
|
+
# * APNS – Returns the token or certificate.
|
694
|
+
#
|
695
|
+
# * GCM – Returns the token or key.
|
696
|
+
#
|
682
697
|
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
|
683
698
|
# notifications should be sent.
|
684
699
|
#
|
@@ -1042,6 +1057,20 @@ module Aws::SNS
|
|
1042
1057
|
include Aws::Structure
|
1043
1058
|
end
|
1044
1059
|
|
1060
|
+
# Indicates that the specified state is not a valid state for an event
|
1061
|
+
# source.
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] message
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/InvalidStateException AWS API Documentation
|
1067
|
+
#
|
1068
|
+
class InvalidStateException < Struct.new(
|
1069
|
+
:message)
|
1070
|
+
SENSITIVE = []
|
1071
|
+
include Aws::Structure
|
1072
|
+
end
|
1073
|
+
|
1045
1074
|
# The ciphertext references a key that doesn't exist or that you don't
|
1046
1075
|
# have access to.
|
1047
1076
|
#
|
@@ -1056,8 +1085,8 @@ module Aws::SNS
|
|
1056
1085
|
include Aws::Structure
|
1057
1086
|
end
|
1058
1087
|
|
1059
|
-
# The request was rejected because the specified
|
1060
|
-
#
|
1088
|
+
# The request was rejected because the specified Amazon Web Services KMS
|
1089
|
+
# key isn't enabled.
|
1061
1090
|
#
|
1062
1091
|
# @!attribute [rw] message
|
1063
1092
|
# @return [String]
|
@@ -1071,9 +1100,9 @@ module Aws::SNS
|
|
1071
1100
|
end
|
1072
1101
|
|
1073
1102
|
# The request was rejected because the state of the specified resource
|
1074
|
-
# isn't valid for this request. For more information, see [
|
1075
|
-
#
|
1076
|
-
#
|
1103
|
+
# isn't valid for this request. For more information, see [Key states
|
1104
|
+
# of Amazon Web Services KMS keys][1] in the *Key Management Service
|
1105
|
+
# Developer Guide*.
|
1077
1106
|
#
|
1078
1107
|
#
|
1079
1108
|
#
|
@@ -1137,16 +1166,16 @@ module Aws::SNS
|
|
1137
1166
|
include Aws::Structure
|
1138
1167
|
end
|
1139
1168
|
|
1140
|
-
# Input for ListEndpointsByPlatformApplication action.
|
1169
|
+
# Input for `ListEndpointsByPlatformApplication` action.
|
1141
1170
|
#
|
1142
1171
|
# @!attribute [rw] platform_application_arn
|
1143
|
-
# PlatformApplicationArn for
|
1144
|
-
# action.
|
1172
|
+
# `PlatformApplicationArn` for
|
1173
|
+
# `ListEndpointsByPlatformApplicationInput` action.
|
1145
1174
|
# @return [String]
|
1146
1175
|
#
|
1147
1176
|
# @!attribute [rw] next_token
|
1148
|
-
# NextToken string is used when calling
|
1149
|
-
# ListEndpointsByPlatformApplication action to retrieve additional
|
1177
|
+
# `NextToken` string is used when calling
|
1178
|
+
# `ListEndpointsByPlatformApplication` action to retrieve additional
|
1150
1179
|
# records that are available after the first page results.
|
1151
1180
|
# @return [String]
|
1152
1181
|
#
|
@@ -1159,16 +1188,16 @@ module Aws::SNS
|
|
1159
1188
|
include Aws::Structure
|
1160
1189
|
end
|
1161
1190
|
|
1162
|
-
# Response for ListEndpointsByPlatformApplication action.
|
1191
|
+
# Response for `ListEndpointsByPlatformApplication` action.
|
1163
1192
|
#
|
1164
1193
|
# @!attribute [rw] endpoints
|
1165
|
-
# Endpoints returned for ListEndpointsByPlatformApplication action.
|
1194
|
+
# Endpoints returned for `ListEndpointsByPlatformApplication` action.
|
1166
1195
|
# @return [Array<Types::Endpoint>]
|
1167
1196
|
#
|
1168
1197
|
# @!attribute [rw] next_token
|
1169
|
-
# NextToken string is returned when calling
|
1170
|
-
# ListEndpointsByPlatformApplication action if additional records
|
1171
|
-
# available after the first page results.
|
1198
|
+
# `NextToken` string is returned when calling
|
1199
|
+
# `ListEndpointsByPlatformApplication` action if additional records
|
1200
|
+
# are available after the first page results.
|
1172
1201
|
# @return [String]
|
1173
1202
|
#
|
1174
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationResponse AWS API Documentation
|
@@ -1256,10 +1285,10 @@ module Aws::SNS
|
|
1256
1285
|
include Aws::Structure
|
1257
1286
|
end
|
1258
1287
|
|
1259
|
-
# Input for ListPlatformApplications action.
|
1288
|
+
# Input for `ListPlatformApplications` action.
|
1260
1289
|
#
|
1261
1290
|
# @!attribute [rw] next_token
|
1262
|
-
# NextToken string is used when calling ListPlatformApplications
|
1291
|
+
# `NextToken` string is used when calling `ListPlatformApplications`
|
1263
1292
|
# action to retrieve additional records that are available after the
|
1264
1293
|
# first page results.
|
1265
1294
|
# @return [String]
|
@@ -1272,17 +1301,17 @@ module Aws::SNS
|
|
1272
1301
|
include Aws::Structure
|
1273
1302
|
end
|
1274
1303
|
|
1275
|
-
# Response for ListPlatformApplications action.
|
1304
|
+
# Response for `ListPlatformApplications` action.
|
1276
1305
|
#
|
1277
1306
|
# @!attribute [rw] platform_applications
|
1278
|
-
# Platform applications returned when calling
|
1279
|
-
# action.
|
1307
|
+
# Platform applications returned when calling
|
1308
|
+
# `ListPlatformApplications` action.
|
1280
1309
|
# @return [Array<Types::PlatformApplication>]
|
1281
1310
|
#
|
1282
1311
|
# @!attribute [rw] next_token
|
1283
|
-
# NextToken string is returned when calling
|
1284
|
-
# action if additional records are
|
1285
|
-
# results.
|
1312
|
+
# `NextToken` string is returned when calling
|
1313
|
+
# `ListPlatformApplications` action if additional records are
|
1314
|
+
# available after the first page results.
|
1286
1315
|
# @return [String]
|
1287
1316
|
#
|
1288
1317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsResponse AWS API Documentation
|
@@ -1535,7 +1564,7 @@ module Aws::SNS
|
|
1535
1564
|
#
|
1536
1565
|
class OptInPhoneNumberInput < Struct.new(
|
1537
1566
|
:phone_number)
|
1538
|
-
SENSITIVE = []
|
1567
|
+
SENSITIVE = [:phone_number]
|
1539
1568
|
include Aws::Structure
|
1540
1569
|
end
|
1541
1570
|
|
@@ -1596,7 +1625,7 @@ module Aws::SNS
|
|
1596
1625
|
:iso_2_country_code,
|
1597
1626
|
:route_type,
|
1598
1627
|
:number_capabilities)
|
1599
|
-
SENSITIVE = []
|
1628
|
+
SENSITIVE = [:phone_number]
|
1600
1629
|
include Aws::Structure
|
1601
1630
|
end
|
1602
1631
|
|
@@ -2000,7 +2029,7 @@ module Aws::SNS
|
|
2000
2029
|
:message_attributes,
|
2001
2030
|
:message_deduplication_id,
|
2002
2031
|
:message_group_id)
|
2003
|
-
SENSITIVE = []
|
2032
|
+
SENSITIVE = [:phone_number]
|
2004
2033
|
include Aws::Structure
|
2005
2034
|
end
|
2006
2035
|
|
@@ -2079,6 +2108,20 @@ module Aws::SNS
|
|
2079
2108
|
include Aws::Structure
|
2080
2109
|
end
|
2081
2110
|
|
2111
|
+
# Indicates that the request parameter has exceeded the maximum number
|
2112
|
+
# of concurrent message replays.
|
2113
|
+
#
|
2114
|
+
# @!attribute [rw] message
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ReplayLimitExceededException AWS API Documentation
|
2118
|
+
#
|
2119
|
+
class ReplayLimitExceededException < Struct.new(
|
2120
|
+
:message)
|
2121
|
+
SENSITIVE = []
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
2082
2125
|
# Can’t perform the action on the specified resource. Make sure that the
|
2083
2126
|
# resource exists.
|
2084
2127
|
#
|
@@ -2122,14 +2165,14 @@ module Aws::SNS
|
|
2122
2165
|
class SMSSandboxPhoneNumber < Struct.new(
|
2123
2166
|
:phone_number,
|
2124
2167
|
:status)
|
2125
|
-
SENSITIVE = []
|
2168
|
+
SENSITIVE = [:phone_number]
|
2126
2169
|
include Aws::Structure
|
2127
2170
|
end
|
2128
2171
|
|
2129
|
-
# Input for SetEndpointAttributes action.
|
2172
|
+
# Input for `SetEndpointAttributes` action.
|
2130
2173
|
#
|
2131
2174
|
# @!attribute [rw] endpoint_arn
|
2132
|
-
# EndpointArn used for SetEndpointAttributes action.
|
2175
|
+
# EndpointArn used for `SetEndpointAttributes` action.
|
2133
2176
|
# @return [String]
|
2134
2177
|
#
|
2135
2178
|
# @!attribute [rw] attributes
|
@@ -2160,10 +2203,11 @@ module Aws::SNS
|
|
2160
2203
|
include Aws::Structure
|
2161
2204
|
end
|
2162
2205
|
|
2163
|
-
# Input for SetPlatformApplicationAttributes action.
|
2206
|
+
# Input for `SetPlatformApplicationAttributes` action.
|
2164
2207
|
#
|
2165
2208
|
# @!attribute [rw] platform_application_arn
|
2166
|
-
# PlatformApplicationArn for SetPlatformApplicationAttributes
|
2209
|
+
# `PlatformApplicationArn` for `SetPlatformApplicationAttributes`
|
2210
|
+
# action.
|
2167
2211
|
# @return [String]
|
2168
2212
|
#
|
2169
2213
|
# @!attribute [rw] attributes
|
@@ -2181,8 +2225,17 @@ module Aws::SNS
|
|
2181
2225
|
# * For Apple Services using token credentials, `PlatformCredential`
|
2182
2226
|
# is signing key.
|
2183
2227
|
#
|
2184
|
-
# * For GCM (Firebase Cloud Messaging)
|
2185
|
-
#
|
2228
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there
|
2229
|
+
# is no `PlatformPrincipal`. The `PlatformCredential` is `API
|
2230
|
+
# key`.
|
2231
|
+
#
|
2232
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials,
|
2233
|
+
# there is no `PlatformPrincipal`. The `PlatformCredential` is a
|
2234
|
+
# JSON formatted private key file. When using the Amazon Web
|
2235
|
+
# Services CLI, the file must be in string format and special
|
2236
|
+
# characters must be ignored. To format the file correctly, Amazon
|
2237
|
+
# SNS recommends using the following command: `` SERVICE_JSON=`jq
|
2238
|
+
# @json <<< cat service.json` ``.
|
2186
2239
|
# ^
|
2187
2240
|
#
|
2188
2241
|
# * `PlatformPrincipal` – The principal received from the notification
|
@@ -2723,9 +2776,31 @@ module Aws::SNS
|
|
2723
2776
|
# see [Fanout to Kinesis Data Firehose delivery streams][1] in the
|
2724
2777
|
# *Amazon SNS Developer Guide*.
|
2725
2778
|
#
|
2779
|
+
# The following attributes apply only to [FIFO topics][2]:
|
2780
|
+
#
|
2781
|
+
# * `ReplayPolicy` – Adds or updates an inline policy document for a
|
2782
|
+
# subscription to replay messages stored in the specified Amazon SNS
|
2783
|
+
# topic.
|
2784
|
+
#
|
2785
|
+
# * `ReplayStatus` – Retrieves the status of the subscription message
|
2786
|
+
# replay, which can be one of the following:
|
2787
|
+
#
|
2788
|
+
# * `Completed` – The replay has successfully redelivered all
|
2789
|
+
# messages, and is now delivering newly published messages. If an
|
2790
|
+
# ending point was specified in the `ReplayPolicy` then the
|
2791
|
+
# subscription will no longer receive newly published messages.
|
2792
|
+
#
|
2793
|
+
# * `In progress` – The replay is currently replaying the selected
|
2794
|
+
# messages.
|
2795
|
+
#
|
2796
|
+
# * `Failed` – The replay was unable to complete.
|
2797
|
+
#
|
2798
|
+
# * `Pending` – The default state while the replay initiates.
|
2799
|
+
#
|
2726
2800
|
#
|
2727
2801
|
#
|
2728
2802
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html
|
2803
|
+
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html
|
2729
2804
|
# @return [Hash<String,String>]
|
2730
2805
|
#
|
2731
2806
|
# @!attribute [rw] return_subscription_arn
|
@@ -3043,7 +3118,7 @@ module Aws::SNS
|
|
3043
3118
|
class VerifySMSSandboxPhoneNumberInput < Struct.new(
|
3044
3119
|
:phone_number,
|
3045
3120
|
:one_time_password)
|
3046
|
-
SENSITIVE = []
|
3121
|
+
SENSITIVE = [:phone_number]
|
3047
3122
|
include Aws::Structure
|
3048
3123
|
end
|
3049
3124
|
|