aws-sdk-sns 1.71.0 → 1.72.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sns/client.rb +39 -22
- data/lib/aws-sdk-sns/client_api.rb +2 -2
- 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/resource.rb +2 -1
- data/lib/aws-sdk-sns/topic.rb +1 -1
- data/lib/aws-sdk-sns/types.rb +65 -46
- data/lib/aws-sdk-sns.rb +1 -1
- data/sig/types.rbs +8 -8
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0b194a3c3e0c5682ba2bfc963ed6d2aa96b8e3d0a0abf544c9da63d08c1f90e4
|
4
|
+
data.tar.gz: ff463f73f8c0288dbba5a4658515c698c20cd18ce18bc249a610e7b064474743
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 535e997cf735ef7aac7a1242680548c1e2f63ec8c97582debf06274e522a0b16537dd5cbb64643d93f2ad5f07f91c74b0b742bdcf26030770a235741888143f3
|
7
|
+
data.tar.gz: 3684f4876803add044cf6bc734dc83f96ab7a1c5ed5adcdcaeeddcc1a81174d42dcd9cd32b319be2e5d7905deb4d0aeffe5b97a4cac0e82092301ff9a4c10935
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.72.0
|
data/lib/aws-sdk-sns/client.rb
CHANGED
@@ -535,8 +535,15 @@ module Aws::SNS
|
|
535
535
|
# `PlatformPrincipal` is `signing key ID` and `PlatformCredential` is
|
536
536
|
# `signing key`.
|
537
537
|
#
|
538
|
-
# * For
|
539
|
-
# `PlatformPrincipal
|
538
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there is
|
539
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
|
540
|
+
#
|
541
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials, there is
|
542
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is a JSON formatted
|
543
|
+
# private key file. When using the Amazon Web Services CLI, the file
|
544
|
+
# must be in string format and special characters must be ignored. To
|
545
|
+
# format the file correctly, Amazon SNS recommends using the following
|
546
|
+
# command: `` SERVICE_JSON=`jq @json <<< cat service.json` ``.
|
540
547
|
#
|
541
548
|
# * For `MPNS`, `PlatformPrincipal` is `TLS certificate` and
|
542
549
|
# `PlatformCredential` is `private key`.
|
@@ -558,7 +565,8 @@ module Aws::SNS
|
|
558
565
|
# (Firebase Cloud Messaging).
|
559
566
|
#
|
560
567
|
# @option params [required, Hash<String,String>] :attributes
|
561
|
-
# For a list of attributes, see [SetPlatformApplicationAttributes
|
568
|
+
# For a list of attributes, see [ `SetPlatformApplicationAttributes`
|
569
|
+
# ][1].
|
562
570
|
#
|
563
571
|
#
|
564
572
|
#
|
@@ -614,8 +622,8 @@ module Aws::SNS
|
|
614
622
|
# [2]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html
|
615
623
|
#
|
616
624
|
# @option params [required, String] :platform_application_arn
|
617
|
-
# PlatformApplicationArn returned from CreatePlatformApplication is
|
618
|
-
# to create a an endpoint.
|
625
|
+
# `PlatformApplicationArn` returned from CreatePlatformApplication is
|
626
|
+
# used to create a an endpoint.
|
619
627
|
#
|
620
628
|
# @option params [required, String] :token
|
621
629
|
# Unique identifier created by the notification service for an app on a
|
@@ -630,7 +638,7 @@ module Aws::SNS
|
|
630
638
|
# not use this data. The data must be in UTF-8 format and less than 2KB.
|
631
639
|
#
|
632
640
|
# @option params [Hash<String,String>] :attributes
|
633
|
-
# For a list of attributes, see [SetEndpointAttributes][1].
|
641
|
+
# For a list of attributes, see [ `SetEndpointAttributes` ][1].
|
634
642
|
#
|
635
643
|
#
|
636
644
|
#
|
@@ -864,7 +872,7 @@ module Aws::SNS
|
|
864
872
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
865
873
|
#
|
866
874
|
# @option params [required, String] :endpoint_arn
|
867
|
-
# EndpointArn of endpoint to delete.
|
875
|
+
# `EndpointArn` of endpoint to delete.
|
868
876
|
#
|
869
877
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
870
878
|
#
|
@@ -893,7 +901,7 @@ module Aws::SNS
|
|
893
901
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
894
902
|
#
|
895
903
|
# @option params [required, String] :platform_application_arn
|
896
|
-
# PlatformApplicationArn of platform application object to delete.
|
904
|
+
# `PlatformApplicationArn` of platform application object to delete.
|
897
905
|
#
|
898
906
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
899
907
|
#
|
@@ -1020,7 +1028,7 @@ module Aws::SNS
|
|
1020
1028
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1021
1029
|
#
|
1022
1030
|
# @option params [required, String] :endpoint_arn
|
1023
|
-
# EndpointArn for GetEndpointAttributes input.
|
1031
|
+
# `EndpointArn` for `GetEndpointAttributes` input.
|
1024
1032
|
#
|
1025
1033
|
# @return [Types::GetEndpointAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1026
1034
|
#
|
@@ -1056,7 +1064,7 @@ module Aws::SNS
|
|
1056
1064
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1057
1065
|
#
|
1058
1066
|
# @option params [required, String] :platform_application_arn
|
1059
|
-
# PlatformApplicationArn for GetPlatformApplicationAttributesInput.
|
1067
|
+
# `PlatformApplicationArn` for GetPlatformApplicationAttributesInput.
|
1060
1068
|
#
|
1061
1069
|
# @return [Types::GetPlatformApplicationAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1062
1070
|
#
|
@@ -1235,12 +1243,12 @@ module Aws::SNS
|
|
1235
1243
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1236
1244
|
#
|
1237
1245
|
# @option params [required, String] :platform_application_arn
|
1238
|
-
# PlatformApplicationArn for ListEndpointsByPlatformApplicationInput
|
1246
|
+
# `PlatformApplicationArn` for `ListEndpointsByPlatformApplicationInput`
|
1239
1247
|
# action.
|
1240
1248
|
#
|
1241
1249
|
# @option params [String] :next_token
|
1242
|
-
# NextToken string is used when calling
|
1243
|
-
# ListEndpointsByPlatformApplication action to retrieve additional
|
1250
|
+
# `NextToken` string is used when calling
|
1251
|
+
# `ListEndpointsByPlatformApplication` action to retrieve additional
|
1244
1252
|
# records that are available after the first page results.
|
1245
1253
|
#
|
1246
1254
|
# @return [Types::ListEndpointsByPlatformApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1386,9 +1394,9 @@ module Aws::SNS
|
|
1386
1394
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
1387
1395
|
#
|
1388
1396
|
# @option params [String] :next_token
|
1389
|
-
# NextToken string is used when calling ListPlatformApplications
|
1390
|
-
# to retrieve additional records that are available after the
|
1391
|
-
# results.
|
1397
|
+
# `NextToken` string is used when calling `ListPlatformApplications`
|
1398
|
+
# action to retrieve additional records that are available after the
|
1399
|
+
# first page results.
|
1392
1400
|
#
|
1393
1401
|
# @return [Types::ListPlatformApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1394
1402
|
#
|
@@ -1829,7 +1837,7 @@ module Aws::SNS
|
|
1829
1837
|
# resp = client.publish({
|
1830
1838
|
# topic_arn: "topicARN",
|
1831
1839
|
# target_arn: "String",
|
1832
|
-
# phone_number: "
|
1840
|
+
# phone_number: "PhoneNumber",
|
1833
1841
|
# message: "message", # required
|
1834
1842
|
# subject: "subject",
|
1835
1843
|
# message_structure: "messageStructure",
|
@@ -2025,7 +2033,7 @@ module Aws::SNS
|
|
2025
2033
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html
|
2026
2034
|
#
|
2027
2035
|
# @option params [required, String] :endpoint_arn
|
2028
|
-
# EndpointArn used for SetEndpointAttributes action.
|
2036
|
+
# EndpointArn used for `SetEndpointAttributes` action.
|
2029
2037
|
#
|
2030
2038
|
# @option params [required, Hash<String,String>] :attributes
|
2031
2039
|
# A map of the endpoint attributes. Attributes in this map include the
|
@@ -2078,7 +2086,8 @@ module Aws::SNS
|
|
2078
2086
|
# [2]: https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html
|
2079
2087
|
#
|
2080
2088
|
# @option params [required, String] :platform_application_arn
|
2081
|
-
# PlatformApplicationArn for SetPlatformApplicationAttributes
|
2089
|
+
# `PlatformApplicationArn` for `SetPlatformApplicationAttributes`
|
2090
|
+
# action.
|
2082
2091
|
#
|
2083
2092
|
# @option params [required, Hash<String,String>] :attributes
|
2084
2093
|
# A map of the platform application attributes. Attributes in this map
|
@@ -2095,8 +2104,16 @@ module Aws::SNS
|
|
2095
2104
|
# * For Apple Services using token credentials, `PlatformCredential`
|
2096
2105
|
# is signing key.
|
2097
2106
|
#
|
2098
|
-
# * For GCM (Firebase Cloud Messaging),
|
2099
|
-
# key
|
2107
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there is
|
2108
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
|
2109
|
+
#
|
2110
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials, there
|
2111
|
+
# is no `PlatformPrincipal`. The `PlatformCredential` is a JSON
|
2112
|
+
# formatted private key file. When using the Amazon Web Services
|
2113
|
+
# CLI, the file must be in string format and special characters must
|
2114
|
+
# be ignored. To format the file correctly, Amazon SNS recommends
|
2115
|
+
# using the following command: `` SERVICE_JSON=`jq @json <<< cat
|
2116
|
+
# service.json` ``.
|
2100
2117
|
# ^
|
2101
2118
|
#
|
2102
2119
|
# * `PlatformPrincipal` – The principal received from the notification
|
@@ -2917,7 +2934,7 @@ module Aws::SNS
|
|
2917
2934
|
params: params,
|
2918
2935
|
config: config)
|
2919
2936
|
context[:gem_name] = 'aws-sdk-sns'
|
2920
|
-
context[:gem_version] = '1.
|
2937
|
+
context[:gem_version] = '1.72.0'
|
2921
2938
|
Seahorse::Client::Request.new(handlers, context)
|
2922
2939
|
end
|
2923
2940
|
|
@@ -465,7 +465,7 @@ module Aws::SNS
|
|
465
465
|
OptedOutException.struct_class = Types::OptedOutException
|
466
466
|
|
467
467
|
PhoneNumberInformation.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
468
|
-
PhoneNumberInformation.add_member(:phone_number, Shapes::ShapeRef.new(shape:
|
468
|
+
PhoneNumberInformation.add_member(:phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, location_name: "PhoneNumber"))
|
469
469
|
PhoneNumberInformation.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "Status"))
|
470
470
|
PhoneNumberInformation.add_member(:iso_2_country_code, Shapes::ShapeRef.new(shape: Iso2CountryCode, location_name: "Iso2CountryCode"))
|
471
471
|
PhoneNumberInformation.add_member(:route_type, Shapes::ShapeRef.new(shape: RouteType, location_name: "RouteType"))
|
@@ -511,7 +511,7 @@ module Aws::SNS
|
|
511
511
|
|
512
512
|
PublishInput.add_member(:topic_arn, Shapes::ShapeRef.new(shape: topicARN, location_name: "TopicArn"))
|
513
513
|
PublishInput.add_member(:target_arn, Shapes::ShapeRef.new(shape: String, location_name: "TargetArn"))
|
514
|
-
PublishInput.add_member(:phone_number, Shapes::ShapeRef.new(shape:
|
514
|
+
PublishInput.add_member(:phone_number, Shapes::ShapeRef.new(shape: PhoneNumber, location_name: "PhoneNumber"))
|
515
515
|
PublishInput.add_member(:message, Shapes::ShapeRef.new(shape: message, required: true, location_name: "Message"))
|
516
516
|
PublishInput.add_member(:subject, Shapes::ShapeRef.new(shape: subject, location_name: "Subject"))
|
517
517
|
PublishInput.add_member(:message_structure, Shapes::ShapeRef.new(shape: messageStructure, location_name: "MessageStructure"))
|
@@ -45,6 +45,14 @@ module Aws::SNS
|
|
45
45
|
# * `ApplePlatformBundleID` – The app identifier used to configure
|
46
46
|
# token-based authentication.
|
47
47
|
#
|
48
|
+
# * `AuthenticationMethod` – Returns the credential type used when
|
49
|
+
# sending push notifications from application to APNS/APNS\_Sandbox,
|
50
|
+
# or application to GCM.
|
51
|
+
#
|
52
|
+
# * APNS – Returns the token or certificate.
|
53
|
+
#
|
54
|
+
# * GCM – Returns the token or key.
|
55
|
+
#
|
48
56
|
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
|
49
57
|
# notifications should be sent.
|
50
58
|
#
|
@@ -122,7 +130,7 @@ module Aws::SNS
|
|
122
130
|
# Arbitrary user data to associate with the endpoint. Amazon SNS does
|
123
131
|
# not use this data. The data must be in UTF-8 format and less than 2KB.
|
124
132
|
# @option options [Hash<String,String>] :attributes
|
125
|
-
# For a list of attributes, see [SetEndpointAttributes][1].
|
133
|
+
# For a list of attributes, see [ `SetEndpointAttributes` ][1].
|
126
134
|
#
|
127
135
|
#
|
128
136
|
#
|
@@ -175,8 +183,16 @@ module Aws::SNS
|
|
175
183
|
# * For Apple Services using token credentials, `PlatformCredential`
|
176
184
|
# is signing key.
|
177
185
|
#
|
178
|
-
# * For GCM (Firebase Cloud Messaging),
|
179
|
-
# key
|
186
|
+
# * For GCM (Firebase Cloud Messaging) using key credentials, there is
|
187
|
+
# no `PlatformPrincipal`. The `PlatformCredential` is `API key`.
|
188
|
+
#
|
189
|
+
# * For GCM (Firebase Cloud Messaging) using token credentials, there
|
190
|
+
# is no `PlatformPrincipal`. The `PlatformCredential` is a JSON
|
191
|
+
# formatted private key file. When using the Amazon Web Services
|
192
|
+
# CLI, the file must be in string format and special characters must
|
193
|
+
# be ignored. To format the file correctly, Amazon SNS recommends
|
194
|
+
# using the following command: `` SERVICE_JSON=`jq @json <<< cat
|
195
|
+
# service.json` ``.
|
180
196
|
# ^
|
181
197
|
#
|
182
198
|
# * `PlatformPrincipal` – The principal received from the notification
|
@@ -114,7 +114,7 @@ module Aws::SNS
|
|
114
114
|
#
|
115
115
|
# platform_endpoint.publish({
|
116
116
|
# topic_arn: "topicARN",
|
117
|
-
# phone_number: "
|
117
|
+
# phone_number: "PhoneNumber",
|
118
118
|
# message: "message", # required
|
119
119
|
# subject: "subject",
|
120
120
|
# message_structure: "messageStructure",
|
data/lib/aws-sdk-sns/resource.rb
CHANGED
@@ -54,7 +54,8 @@ module Aws::SNS
|
|
54
54
|
# APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
|
55
55
|
# (Firebase Cloud Messaging).
|
56
56
|
# @option options [required, Hash<String,String>] :attributes
|
57
|
-
# For a list of attributes, see [SetPlatformApplicationAttributes
|
57
|
+
# For a list of attributes, see [ `SetPlatformApplicationAttributes`
|
58
|
+
# ][1].
|
58
59
|
#
|
59
60
|
#
|
60
61
|
#
|
data/lib/aws-sdk-sns/topic.rb
CHANGED
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
|
|
@@ -462,10 +463,10 @@ module Aws::SNS
|
|
462
463
|
include Aws::Structure
|
463
464
|
end
|
464
465
|
|
465
|
-
# Input for DeleteEndpoint action.
|
466
|
+
# Input for `DeleteEndpoint` action.
|
466
467
|
#
|
467
468
|
# @!attribute [rw] endpoint_arn
|
468
|
-
# EndpointArn of endpoint to delete.
|
469
|
+
# `EndpointArn` of endpoint to delete.
|
469
470
|
# @return [String]
|
470
471
|
#
|
471
472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeleteEndpointInput AWS API Documentation
|
@@ -476,10 +477,10 @@ module Aws::SNS
|
|
476
477
|
include Aws::Structure
|
477
478
|
end
|
478
479
|
|
479
|
-
# Input for DeletePlatformApplication action.
|
480
|
+
# Input for `DeletePlatformApplication` action.
|
480
481
|
#
|
481
482
|
# @!attribute [rw] platform_application_arn
|
482
|
-
# PlatformApplicationArn of platform application object to delete.
|
483
|
+
# `PlatformApplicationArn` of platform application object to delete.
|
483
484
|
# @return [String]
|
484
485
|
#
|
485
486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/DeletePlatformApplicationInput AWS API Documentation
|
@@ -498,7 +499,7 @@ module Aws::SNS
|
|
498
499
|
#
|
499
500
|
class DeleteSMSSandboxPhoneNumberInput < Struct.new(
|
500
501
|
:phone_number)
|
501
|
-
SENSITIVE = []
|
502
|
+
SENSITIVE = [:phone_number]
|
502
503
|
include Aws::Structure
|
503
504
|
end
|
504
505
|
|
@@ -611,10 +612,10 @@ module Aws::SNS
|
|
611
612
|
include Aws::Structure
|
612
613
|
end
|
613
614
|
|
614
|
-
# Input for GetEndpointAttributes action.
|
615
|
+
# Input for `GetEndpointAttributes` action.
|
615
616
|
#
|
616
617
|
# @!attribute [rw] endpoint_arn
|
617
|
-
# EndpointArn for GetEndpointAttributes input.
|
618
|
+
# `EndpointArn` for `GetEndpointAttributes` input.
|
618
619
|
# @return [String]
|
619
620
|
#
|
620
621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetEndpointAttributesInput AWS API Documentation
|
@@ -625,7 +626,7 @@ module Aws::SNS
|
|
625
626
|
include Aws::Structure
|
626
627
|
end
|
627
628
|
|
628
|
-
# Response from GetEndpointAttributes of the EndpointArn
|
629
|
+
# Response from `GetEndpointAttributes` of the `EndpointArn`.
|
629
630
|
#
|
630
631
|
# @!attribute [rw] attributes
|
631
632
|
# Attributes include the following:
|
@@ -657,10 +658,10 @@ module Aws::SNS
|
|
657
658
|
include Aws::Structure
|
658
659
|
end
|
659
660
|
|
660
|
-
# Input for GetPlatformApplicationAttributes action.
|
661
|
+
# Input for `GetPlatformApplicationAttributes` action.
|
661
662
|
#
|
662
663
|
# @!attribute [rw] platform_application_arn
|
663
|
-
# PlatformApplicationArn for GetPlatformApplicationAttributesInput.
|
664
|
+
# `PlatformApplicationArn` for GetPlatformApplicationAttributesInput.
|
664
665
|
# @return [String]
|
665
666
|
#
|
666
667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetPlatformApplicationAttributesInput AWS API Documentation
|
@@ -671,7 +672,7 @@ module Aws::SNS
|
|
671
672
|
include Aws::Structure
|
672
673
|
end
|
673
674
|
|
674
|
-
# Response for GetPlatformApplicationAttributes action.
|
675
|
+
# Response for `GetPlatformApplicationAttributes` action.
|
675
676
|
#
|
676
677
|
# @!attribute [rw] attributes
|
677
678
|
# Attributes include the following:
|
@@ -685,6 +686,14 @@ module Aws::SNS
|
|
685
686
|
# * `ApplePlatformBundleID` – The app identifier used to configure
|
686
687
|
# token-based authentication.
|
687
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
|
+
#
|
688
697
|
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
|
689
698
|
# notifications should be sent.
|
690
699
|
#
|
@@ -1157,16 +1166,16 @@ module Aws::SNS
|
|
1157
1166
|
include Aws::Structure
|
1158
1167
|
end
|
1159
1168
|
|
1160
|
-
# Input for ListEndpointsByPlatformApplication action.
|
1169
|
+
# Input for `ListEndpointsByPlatformApplication` action.
|
1161
1170
|
#
|
1162
1171
|
# @!attribute [rw] platform_application_arn
|
1163
|
-
# PlatformApplicationArn for
|
1164
|
-
# action.
|
1172
|
+
# `PlatformApplicationArn` for
|
1173
|
+
# `ListEndpointsByPlatformApplicationInput` action.
|
1165
1174
|
# @return [String]
|
1166
1175
|
#
|
1167
1176
|
# @!attribute [rw] next_token
|
1168
|
-
# NextToken string is used when calling
|
1169
|
-
# ListEndpointsByPlatformApplication action to retrieve additional
|
1177
|
+
# `NextToken` string is used when calling
|
1178
|
+
# `ListEndpointsByPlatformApplication` action to retrieve additional
|
1170
1179
|
# records that are available after the first page results.
|
1171
1180
|
# @return [String]
|
1172
1181
|
#
|
@@ -1179,16 +1188,16 @@ module Aws::SNS
|
|
1179
1188
|
include Aws::Structure
|
1180
1189
|
end
|
1181
1190
|
|
1182
|
-
# Response for ListEndpointsByPlatformApplication action.
|
1191
|
+
# Response for `ListEndpointsByPlatformApplication` action.
|
1183
1192
|
#
|
1184
1193
|
# @!attribute [rw] endpoints
|
1185
|
-
# Endpoints returned for ListEndpointsByPlatformApplication action.
|
1194
|
+
# Endpoints returned for `ListEndpointsByPlatformApplication` action.
|
1186
1195
|
# @return [Array<Types::Endpoint>]
|
1187
1196
|
#
|
1188
1197
|
# @!attribute [rw] next_token
|
1189
|
-
# NextToken string is returned when calling
|
1190
|
-
# ListEndpointsByPlatformApplication action if additional records
|
1191
|
-
# 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.
|
1192
1201
|
# @return [String]
|
1193
1202
|
#
|
1194
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplicationResponse AWS API Documentation
|
@@ -1276,10 +1285,10 @@ module Aws::SNS
|
|
1276
1285
|
include Aws::Structure
|
1277
1286
|
end
|
1278
1287
|
|
1279
|
-
# Input for ListPlatformApplications action.
|
1288
|
+
# Input for `ListPlatformApplications` action.
|
1280
1289
|
#
|
1281
1290
|
# @!attribute [rw] next_token
|
1282
|
-
# NextToken string is used when calling ListPlatformApplications
|
1291
|
+
# `NextToken` string is used when calling `ListPlatformApplications`
|
1283
1292
|
# action to retrieve additional records that are available after the
|
1284
1293
|
# first page results.
|
1285
1294
|
# @return [String]
|
@@ -1292,17 +1301,17 @@ module Aws::SNS
|
|
1292
1301
|
include Aws::Structure
|
1293
1302
|
end
|
1294
1303
|
|
1295
|
-
# Response for ListPlatformApplications action.
|
1304
|
+
# Response for `ListPlatformApplications` action.
|
1296
1305
|
#
|
1297
1306
|
# @!attribute [rw] platform_applications
|
1298
|
-
# Platform applications returned when calling
|
1299
|
-
# action.
|
1307
|
+
# Platform applications returned when calling
|
1308
|
+
# `ListPlatformApplications` action.
|
1300
1309
|
# @return [Array<Types::PlatformApplication>]
|
1301
1310
|
#
|
1302
1311
|
# @!attribute [rw] next_token
|
1303
|
-
# NextToken string is returned when calling
|
1304
|
-
# action if additional records are
|
1305
|
-
# results.
|
1312
|
+
# `NextToken` string is returned when calling
|
1313
|
+
# `ListPlatformApplications` action if additional records are
|
1314
|
+
# available after the first page results.
|
1306
1315
|
# @return [String]
|
1307
1316
|
#
|
1308
1317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListPlatformApplicationsResponse AWS API Documentation
|
@@ -1555,7 +1564,7 @@ module Aws::SNS
|
|
1555
1564
|
#
|
1556
1565
|
class OptInPhoneNumberInput < Struct.new(
|
1557
1566
|
:phone_number)
|
1558
|
-
SENSITIVE = []
|
1567
|
+
SENSITIVE = [:phone_number]
|
1559
1568
|
include Aws::Structure
|
1560
1569
|
end
|
1561
1570
|
|
@@ -1616,7 +1625,7 @@ module Aws::SNS
|
|
1616
1625
|
:iso_2_country_code,
|
1617
1626
|
:route_type,
|
1618
1627
|
:number_capabilities)
|
1619
|
-
SENSITIVE = []
|
1628
|
+
SENSITIVE = [:phone_number]
|
1620
1629
|
include Aws::Structure
|
1621
1630
|
end
|
1622
1631
|
|
@@ -2020,7 +2029,7 @@ module Aws::SNS
|
|
2020
2029
|
:message_attributes,
|
2021
2030
|
:message_deduplication_id,
|
2022
2031
|
:message_group_id)
|
2023
|
-
SENSITIVE = []
|
2032
|
+
SENSITIVE = [:phone_number]
|
2024
2033
|
include Aws::Structure
|
2025
2034
|
end
|
2026
2035
|
|
@@ -2156,14 +2165,14 @@ module Aws::SNS
|
|
2156
2165
|
class SMSSandboxPhoneNumber < Struct.new(
|
2157
2166
|
:phone_number,
|
2158
2167
|
:status)
|
2159
|
-
SENSITIVE = []
|
2168
|
+
SENSITIVE = [:phone_number]
|
2160
2169
|
include Aws::Structure
|
2161
2170
|
end
|
2162
2171
|
|
2163
|
-
# Input for SetEndpointAttributes action.
|
2172
|
+
# Input for `SetEndpointAttributes` action.
|
2164
2173
|
#
|
2165
2174
|
# @!attribute [rw] endpoint_arn
|
2166
|
-
# EndpointArn used for SetEndpointAttributes action.
|
2175
|
+
# EndpointArn used for `SetEndpointAttributes` action.
|
2167
2176
|
# @return [String]
|
2168
2177
|
#
|
2169
2178
|
# @!attribute [rw] attributes
|
@@ -2194,10 +2203,11 @@ module Aws::SNS
|
|
2194
2203
|
include Aws::Structure
|
2195
2204
|
end
|
2196
2205
|
|
2197
|
-
# Input for SetPlatformApplicationAttributes action.
|
2206
|
+
# Input for `SetPlatformApplicationAttributes` action.
|
2198
2207
|
#
|
2199
2208
|
# @!attribute [rw] platform_application_arn
|
2200
|
-
# PlatformApplicationArn for SetPlatformApplicationAttributes
|
2209
|
+
# `PlatformApplicationArn` for `SetPlatformApplicationAttributes`
|
2210
|
+
# action.
|
2201
2211
|
# @return [String]
|
2202
2212
|
#
|
2203
2213
|
# @!attribute [rw] attributes
|
@@ -2215,8 +2225,17 @@ module Aws::SNS
|
|
2215
2225
|
# * For Apple Services using token credentials, `PlatformCredential`
|
2216
2226
|
# is signing key.
|
2217
2227
|
#
|
2218
|
-
# * For GCM (Firebase Cloud Messaging)
|
2219
|
-
#
|
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` ``.
|
2220
2239
|
# ^
|
2221
2240
|
#
|
2222
2241
|
# * `PlatformPrincipal` – The principal received from the notification
|
@@ -3099,7 +3118,7 @@ module Aws::SNS
|
|
3099
3118
|
class VerifySMSSandboxPhoneNumberInput < Struct.new(
|
3100
3119
|
:phone_number,
|
3101
3120
|
:one_time_password)
|
3102
|
-
SENSITIVE = []
|
3121
|
+
SENSITIVE = [:phone_number]
|
3103
3122
|
include Aws::Structure
|
3104
3123
|
end
|
3105
3124
|
|
data/lib/aws-sdk-sns.rb
CHANGED
data/sig/types.rbs
CHANGED
@@ -41,7 +41,7 @@ module Aws::SNS
|
|
41
41
|
|
42
42
|
class CheckIfPhoneNumberIsOptedOutInput
|
43
43
|
attr_accessor phone_number: ::String
|
44
|
-
SENSITIVE: []
|
44
|
+
SENSITIVE: [:phone_number]
|
45
45
|
end
|
46
46
|
|
47
47
|
class CheckIfPhoneNumberIsOptedOutResponse
|
@@ -94,7 +94,7 @@ module Aws::SNS
|
|
94
94
|
class CreateSMSSandboxPhoneNumberInput
|
95
95
|
attr_accessor phone_number: ::String
|
96
96
|
attr_accessor 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")
|
97
|
-
SENSITIVE: []
|
97
|
+
SENSITIVE: [:phone_number]
|
98
98
|
end
|
99
99
|
|
100
100
|
class CreateSMSSandboxPhoneNumberResult < Aws::EmptyStructure
|
@@ -125,7 +125,7 @@ module Aws::SNS
|
|
125
125
|
|
126
126
|
class DeleteSMSSandboxPhoneNumberInput
|
127
127
|
attr_accessor phone_number: ::String
|
128
|
-
SENSITIVE: []
|
128
|
+
SENSITIVE: [:phone_number]
|
129
129
|
end
|
130
130
|
|
131
131
|
class DeleteSMSSandboxPhoneNumberResult < Aws::EmptyStructure
|
@@ -401,7 +401,7 @@ module Aws::SNS
|
|
401
401
|
|
402
402
|
class OptInPhoneNumberInput
|
403
403
|
attr_accessor phone_number: ::String
|
404
|
-
SENSITIVE: []
|
404
|
+
SENSITIVE: [:phone_number]
|
405
405
|
end
|
406
406
|
|
407
407
|
class OptInPhoneNumberResponse < Aws::EmptyStructure
|
@@ -419,7 +419,7 @@ module Aws::SNS
|
|
419
419
|
attr_accessor iso_2_country_code: ::String
|
420
420
|
attr_accessor route_type: ("Transactional" | "Promotional" | "Premium")
|
421
421
|
attr_accessor number_capabilities: ::Array[("SMS" | "MMS" | "VOICE")]
|
422
|
-
SENSITIVE: []
|
422
|
+
SENSITIVE: [:phone_number]
|
423
423
|
end
|
424
424
|
|
425
425
|
class PlatformApplication
|
@@ -473,7 +473,7 @@ module Aws::SNS
|
|
473
473
|
attr_accessor message_attributes: ::Hash[::String, Types::MessageAttributeValue]
|
474
474
|
attr_accessor message_deduplication_id: ::String
|
475
475
|
attr_accessor message_group_id: ::String
|
476
|
-
SENSITIVE: []
|
476
|
+
SENSITIVE: [:phone_number]
|
477
477
|
end
|
478
478
|
|
479
479
|
class PublishResponse
|
@@ -507,7 +507,7 @@ module Aws::SNS
|
|
507
507
|
class SMSSandboxPhoneNumber
|
508
508
|
attr_accessor phone_number: ::String
|
509
509
|
attr_accessor status: ("Pending" | "Verified")
|
510
|
-
SENSITIVE: []
|
510
|
+
SENSITIVE: [:phone_number]
|
511
511
|
end
|
512
512
|
|
513
513
|
class SetEndpointAttributesInput
|
@@ -655,7 +655,7 @@ module Aws::SNS
|
|
655
655
|
class VerifySMSSandboxPhoneNumberInput
|
656
656
|
attr_accessor phone_number: ::String
|
657
657
|
attr_accessor one_time_password: ::String
|
658
|
-
SENSITIVE: []
|
658
|
+
SENSITIVE: [:phone_number]
|
659
659
|
end
|
660
660
|
|
661
661
|
class VerifySMSSandboxPhoneNumberResult < Aws::EmptyStructure
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-sns
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.72.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-02-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|