aws-sdk-sns 1.27.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sns.rb +3 -2
- data/lib/aws-sdk-sns/client.rb +136 -99
- data/lib/aws-sdk-sns/platform_application.rb +17 -16
- data/lib/aws-sdk-sns/resource.rb +1 -1
- data/lib/aws-sdk-sns/subscription.rb +6 -1
- data/lib/aws-sdk-sns/topic.rb +14 -13
- data/lib/aws-sdk-sns/types.rb +39 -33
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ea4426c2b03ba5b4ae9bacf79b6642667a345c50519bbcfdb1decffab1a83d79
|
4
|
+
data.tar.gz: 3a3b5dee8291694fbb39cdffbcda6d2dbfb33369b9d9724bd2ebbf53d7cd86a8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4ea954b627d0f60b12a3ad5f3d60b01dff2c5c813649c6f93936dbfe71d177317eac0eb5e3c5400097377bb394e278eae95fd87e683921ab27af5a3bbc5c8733
|
7
|
+
data.tar.gz: de71a626b65ff7f70cd0e2955b1d3599dee5c90cc621738f776516539dd84e43dd69f686ada01ddd412a023745bd18db5f9f178defb13a601591e206f3b2cef9
|
data/lib/aws-sdk-sns.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -48,9 +49,9 @@ require_relative 'aws-sdk-sns/customizations'
|
|
48
49
|
#
|
49
50
|
# See {Errors} for more information.
|
50
51
|
#
|
51
|
-
#
|
52
|
+
# @!group service
|
52
53
|
module Aws::SNS
|
53
54
|
|
54
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.32.0'
|
55
56
|
|
56
57
|
end
|
data/lib/aws-sdk-sns/client.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::SNS
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::SNS
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -429,25 +444,34 @@ module Aws::SNS
|
|
429
444
|
end
|
430
445
|
|
431
446
|
# Creates a platform application object for one of the supported push
|
432
|
-
# notification services, such as APNS and
|
433
|
-
# mobile apps may register. You must
|
434
|
-
# PlatformCredential attributes when
|
435
|
-
# `CreatePlatformApplication` action.
|
436
|
-
#
|
437
|
-
# PlatformPrincipal
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
445
|
-
#
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
447
|
+
# notification services, such as APNS and GCM (Firebase Cloud
|
448
|
+
# Messaging), to which devices and mobile apps may register. You must
|
449
|
+
# specify `PlatformPrincipal` and `PlatformCredential` attributes when
|
450
|
+
# using the `CreatePlatformApplication` action.
|
451
|
+
#
|
452
|
+
# `PlatformPrincipal` and `PlatformCredential` are received from the
|
453
|
+
# notification service.
|
454
|
+
#
|
455
|
+
# * For `ADM`, `PlatformPrincipal` is `client id` and
|
456
|
+
# `PlatformCredential` is `client secret`.
|
457
|
+
#
|
458
|
+
# * For `Baidu`, `PlatformPrincipal` is `API key` and
|
459
|
+
# `PlatformCredential` is `secret key`.
|
460
|
+
#
|
461
|
+
# * For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
|
462
|
+
# certificate` and `PlatformCredential` is `private key`.
|
463
|
+
#
|
464
|
+
# * For `GCM` (Firebase Cloud Messaging), there is no
|
465
|
+
# `PlatformPrincipal` and the `PlatformCredential` is `API key`.
|
466
|
+
#
|
467
|
+
# * For `MPNS`, `PlatformPrincipal` is `TLS certificate` and
|
468
|
+
# `PlatformCredential` is `private key`.
|
469
|
+
#
|
470
|
+
# * For `WNS`, `PlatformPrincipal` is `Package Security Identifier` and
|
471
|
+
# `PlatformCredential` is `secret key`.
|
472
|
+
#
|
473
|
+
# You can use the returned `PlatformApplicationArn` as an attribute for
|
474
|
+
# the `CreatePlatformEndpoint` action.
|
451
475
|
#
|
452
476
|
# @option params [required, String] :name
|
453
477
|
# Application names must be made up of only uppercase and lowercase
|
@@ -456,7 +480,7 @@ module Aws::SNS
|
|
456
480
|
#
|
457
481
|
# @option params [required, String] :platform
|
458
482
|
# The following platforms are supported: ADM (Amazon Device Messaging),
|
459
|
-
# APNS (Apple Push Notification Service), APNS\_SANDBOX, and
|
483
|
+
# APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
|
460
484
|
# (Firebase Cloud Messaging).
|
461
485
|
#
|
462
486
|
# @option params [required, Hash<String,String>] :attributes
|
@@ -494,16 +518,16 @@ module Aws::SNS
|
|
494
518
|
end
|
495
519
|
|
496
520
|
# Creates an endpoint for a device and mobile app on one of the
|
497
|
-
# supported push notification services, such as
|
498
|
-
# `CreatePlatformEndpoint` requires the
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
521
|
+
# supported push notification services, such as GCM (Firebase Cloud
|
522
|
+
# Messaging) and APNS. `CreatePlatformEndpoint` requires the
|
523
|
+
# `PlatformApplicationArn` that is returned from
|
524
|
+
# `CreatePlatformApplication`. You can use the returned `EndpointArn` to
|
525
|
+
# send a message to a mobile app or by the `Subscribe` action for
|
526
|
+
# subscription to a topic. The `CreatePlatformEndpoint` action is
|
527
|
+
# idempotent, so if the requester already owns an endpoint with the same
|
528
|
+
# device token and attributes, that endpoint's ARN is returned without
|
529
|
+
# creating a new endpoint. For more information, see [Using Amazon SNS
|
530
|
+
# Mobile Push Notifications][1].
|
507
531
|
#
|
508
532
|
# When using `CreatePlatformEndpoint` with Baidu, two attributes must be
|
509
533
|
# provided: ChannelId and UserId. The token field must also contain the
|
@@ -524,8 +548,8 @@ module Aws::SNS
|
|
524
548
|
# device. The specific name for Token will vary, depending on which
|
525
549
|
# notification service is being used. For example, when using APNS as
|
526
550
|
# the notification service, you need the device token. Alternatively,
|
527
|
-
# when using
|
528
|
-
# registration ID.
|
551
|
+
# when using GCM (Firebase Cloud Messaging) or ADM, the device token
|
552
|
+
# equivalent is called the registration ID.
|
529
553
|
#
|
530
554
|
# @option params [String] :custom_user_data
|
531
555
|
# Arbitrary user data to associate with the endpoint. Amazon SNS does
|
@@ -685,8 +709,9 @@ module Aws::SNS
|
|
685
709
|
end
|
686
710
|
|
687
711
|
# Deletes a platform application object for one of the supported push
|
688
|
-
# notification services, such as APNS and
|
689
|
-
# [Using Amazon SNS Mobile Push
|
712
|
+
# notification services, such as APNS and GCM (Firebase Cloud
|
713
|
+
# Messaging). For more information, see [Using Amazon SNS Mobile Push
|
714
|
+
# Notifications][1].
|
690
715
|
#
|
691
716
|
#
|
692
717
|
#
|
@@ -738,8 +763,9 @@ module Aws::SNS
|
|
738
763
|
end
|
739
764
|
|
740
765
|
# Retrieves the endpoint attributes for a device on one of the supported
|
741
|
-
# push notification services, such as
|
742
|
-
# information, see [Using Amazon SNS Mobile Push
|
766
|
+
# push notification services, such as GCM (Firebase Cloud Messaging) and
|
767
|
+
# APNS. For more information, see [Using Amazon SNS Mobile Push
|
768
|
+
# Notifications][1].
|
743
769
|
#
|
744
770
|
#
|
745
771
|
#
|
@@ -773,8 +799,9 @@ module Aws::SNS
|
|
773
799
|
end
|
774
800
|
|
775
801
|
# Retrieves the attributes of the platform application object for the
|
776
|
-
# supported push notification services, such as APNS and
|
777
|
-
# information, see [Using Amazon SNS Mobile
|
802
|
+
# supported push notification services, such as APNS and GCM (Firebase
|
803
|
+
# Cloud Messaging). For more information, see [Using Amazon SNS Mobile
|
804
|
+
# Push Notifications][1].
|
778
805
|
#
|
779
806
|
#
|
780
807
|
#
|
@@ -908,11 +935,11 @@ module Aws::SNS
|
|
908
935
|
end
|
909
936
|
|
910
937
|
# Lists the endpoints and endpoint attributes for devices in a supported
|
911
|
-
# push notification service, such as
|
912
|
-
# `ListEndpointsByPlatformApplication` are
|
913
|
-
# limited list of endpoints, up to 100. If
|
914
|
-
# available after the first page results, then a
|
915
|
-
# be returned. To receive the next page, you call
|
938
|
+
# push notification service, such as GCM (Firebase Cloud Messaging) and
|
939
|
+
# APNS. The results for `ListEndpointsByPlatformApplication` are
|
940
|
+
# paginated and return a limited list of endpoints, up to 100. If
|
941
|
+
# additional records are available after the first page results, then a
|
942
|
+
# NextToken string will be returned. To receive the next page, you call
|
916
943
|
# `ListEndpointsByPlatformApplication` again using the NextToken string
|
917
944
|
# received from the previous call. When there are no more records to
|
918
945
|
# return, NextToken will be null. For more information, see [Using
|
@@ -1007,14 +1034,15 @@ module Aws::SNS
|
|
1007
1034
|
end
|
1008
1035
|
|
1009
1036
|
# Lists the platform application objects for the supported push
|
1010
|
-
# notification services, such as APNS and
|
1011
|
-
# `ListPlatformApplications` are paginated
|
1012
|
-
# applications, up to 100. If additional
|
1013
|
-
# first page results, then a NextToken
|
1014
|
-
# receive the next page, you call
|
1015
|
-
# NextToken string received from
|
1016
|
-
#
|
1017
|
-
# see [Using Amazon SNS
|
1037
|
+
# notification services, such as APNS and GCM (Firebase Cloud
|
1038
|
+
# Messaging). The results for `ListPlatformApplications` are paginated
|
1039
|
+
# and return a limited list of applications, up to 100. If additional
|
1040
|
+
# records are available after the first page results, then a NextToken
|
1041
|
+
# string will be returned. To receive the next page, you call
|
1042
|
+
# `ListPlatformApplications` using the NextToken string received from
|
1043
|
+
# the previous call. When there are no more records to return,
|
1044
|
+
# `NextToken` will be null. For more information, see [Using Amazon SNS
|
1045
|
+
# Mobile Push Notifications][1].
|
1018
1046
|
#
|
1019
1047
|
# This action is throttled at 15 transactions per second (TPS).
|
1020
1048
|
#
|
@@ -1245,8 +1273,9 @@ module Aws::SNS
|
|
1245
1273
|
req.send_request(options)
|
1246
1274
|
end
|
1247
1275
|
|
1248
|
-
# Sends a message to an Amazon SNS topic
|
1249
|
-
#
|
1276
|
+
# Sends a message to an Amazon SNS topic, a text message (SMS message)
|
1277
|
+
# directly to a phone number, or a message to a mobile platform endpoint
|
1278
|
+
# (when you specify the `TargetArn`).
|
1250
1279
|
#
|
1251
1280
|
# If you send a message to a topic, Amazon SNS delivers the message to
|
1252
1281
|
# each endpoint that is subscribed to the topic. The format of the
|
@@ -1265,6 +1294,9 @@ module Aws::SNS
|
|
1265
1294
|
# For more information about formatting messages, see [Send Custom
|
1266
1295
|
# Platform-Specific Payloads in Messages to Mobile Devices][1].
|
1267
1296
|
#
|
1297
|
+
# You can publish messages only to topics and endpoints in the same AWS
|
1298
|
+
# Region.
|
1299
|
+
#
|
1268
1300
|
#
|
1269
1301
|
#
|
1270
1302
|
# [1]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html
|
@@ -1433,8 +1465,9 @@ module Aws::SNS
|
|
1433
1465
|
end
|
1434
1466
|
|
1435
1467
|
# Sets the attributes for an endpoint for a device on one of the
|
1436
|
-
# supported push notification services, such as
|
1437
|
-
# information, see [Using Amazon SNS
|
1468
|
+
# supported push notification services, such as GCM (Firebase Cloud
|
1469
|
+
# Messaging) and APNS. For more information, see [Using Amazon SNS
|
1470
|
+
# Mobile Push Notifications][1].
|
1438
1471
|
#
|
1439
1472
|
#
|
1440
1473
|
#
|
@@ -1482,11 +1515,11 @@ module Aws::SNS
|
|
1482
1515
|
end
|
1483
1516
|
|
1484
1517
|
# Sets the attributes of the platform application object for the
|
1485
|
-
# supported push notification services, such as APNS and
|
1486
|
-
# information, see [Using Amazon SNS Mobile
|
1487
|
-
# information on configuring attributes for
|
1488
|
-
# [Using Amazon SNS Application Attributes
|
1489
|
-
# Status][2].
|
1518
|
+
# supported push notification services, such as APNS and GCM (Firebase
|
1519
|
+
# Cloud Messaging). For more information, see [Using Amazon SNS Mobile
|
1520
|
+
# Push Notifications][1]. For information on configuring attributes for
|
1521
|
+
# message delivery status, see [Using Amazon SNS Application Attributes
|
1522
|
+
# for Message Delivery Status][2].
|
1490
1523
|
#
|
1491
1524
|
#
|
1492
1525
|
#
|
@@ -1501,26 +1534,27 @@ module Aws::SNS
|
|
1501
1534
|
# include the following:
|
1502
1535
|
#
|
1503
1536
|
# * `PlatformCredential` – The credential received from the notification
|
1504
|
-
# service. For APNS
|
1505
|
-
#
|
1506
|
-
# PlatformCredential is
|
1537
|
+
# service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
|
1538
|
+
# `private key`. For `GCM` (Firebase Cloud Messaging),
|
1539
|
+
# `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential`
|
1540
|
+
# is `client secret`.
|
1507
1541
|
#
|
1508
1542
|
# * `PlatformPrincipal` – The principal received from the notification
|
1509
|
-
# service. For APNS
|
1510
|
-
# certificate
|
1511
|
-
# PlatformPrincipal is
|
1543
|
+
# service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
|
1544
|
+
# certificate`. For `GCM` (Firebase Cloud Messaging), there is no
|
1545
|
+
# `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
|
1512
1546
|
#
|
1513
|
-
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
|
1514
|
-
# notifications
|
1547
|
+
# * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
|
1548
|
+
# notifications are sent.
|
1515
1549
|
#
|
1516
|
-
# * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
|
1517
|
-
# notifications
|
1550
|
+
# * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
|
1551
|
+
# notifications are sent.
|
1518
1552
|
#
|
1519
|
-
# * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
|
1520
|
-
# notifications
|
1553
|
+
# * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
|
1554
|
+
# notifications are sent.
|
1521
1555
|
#
|
1522
|
-
# * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
|
1523
|
-
# notifications
|
1556
|
+
# * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
|
1557
|
+
# notifications are sent upon Direct Publish delivery failure
|
1524
1558
|
# (permanent) to one of the application's endpoints.
|
1525
1559
|
#
|
1526
1560
|
# * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
|
@@ -1777,11 +1811,13 @@ module Aws::SNS
|
|
1777
1811
|
req.send_request(options)
|
1778
1812
|
end
|
1779
1813
|
|
1780
|
-
#
|
1781
|
-
#
|
1782
|
-
# owner must
|
1783
|
-
# the
|
1784
|
-
#
|
1814
|
+
# Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
|
1815
|
+
# HTTP/S or email, or if the endpoint and the topic are not in the same
|
1816
|
+
# AWS account, the endpoint owner must the `ConfirmSubscription` action
|
1817
|
+
# to confirm the subscription.
|
1818
|
+
#
|
1819
|
+
# You call the `ConfirmSubscription` action with the token from the
|
1820
|
+
# subscription response. Confirmation tokens are valid for three days.
|
1785
1821
|
#
|
1786
1822
|
# This action is throttled at 100 transactions per second (TPS).
|
1787
1823
|
#
|
@@ -1813,11 +1849,11 @@ module Aws::SNS
|
|
1813
1849
|
# The endpoint that you want to receive notifications. Endpoints vary by
|
1814
1850
|
# protocol:
|
1815
1851
|
#
|
1816
|
-
# * For the `http` protocol, the endpoint is
|
1817
|
-
# `http://`
|
1852
|
+
# * For the `http` protocol, the (public) endpoint is a URL beginning
|
1853
|
+
# with `http://`
|
1818
1854
|
#
|
1819
|
-
# * For the `https` protocol, the endpoint is a URL beginning
|
1820
|
-
# `https://`
|
1855
|
+
# * For the `https` protocol, the (public) endpoint is a URL beginning
|
1856
|
+
# with `https://`
|
1821
1857
|
#
|
1822
1858
|
# * For the `email` protocol, the endpoint is an email address
|
1823
1859
|
#
|
@@ -1864,16 +1900,17 @@ module Aws::SNS
|
|
1864
1900
|
# Sets whether the response from the `Subscribe` request includes the
|
1865
1901
|
# subscription ARN, even if the subscription is not yet confirmed.
|
1866
1902
|
#
|
1867
|
-
# * If you
|
1868
|
-
#
|
1903
|
+
# * If you set this parameter to `true`, the response includes the ARN
|
1904
|
+
# in all cases, even if the subscription is not yet confirmed. In
|
1905
|
+
# addition to the ARN for confirmed subscriptions, the response also
|
1906
|
+
# includes the `pending subscription` ARN value for subscriptions that
|
1907
|
+
# aren't yet confirmed. A subscription becomes confirmed when the
|
1908
|
+
# subscriber calls the `ConfirmSubscription` action with a
|
1909
|
+
# confirmation token.
|
1910
|
+
#
|
1911
|
+
# ^
|
1869
1912
|
#
|
1870
|
-
# * If you don't have the subscription ARN returned, in addition to the
|
1871
|
-
# ARN for confirmed subscriptions, the response also includes the
|
1872
|
-
# `pending subscription` ARN value for subscriptions that aren't yet
|
1873
|
-
# confirmed. A subscription becomes confirmed when the subscriber
|
1874
|
-
# calls the `ConfirmSubscription` action with a confirmation token.
|
1875
1913
|
#
|
1876
|
-
# If you set this parameter to `true`, .
|
1877
1914
|
#
|
1878
1915
|
# The default value is `false`.
|
1879
1916
|
#
|
@@ -2034,7 +2071,7 @@ module Aws::SNS
|
|
2034
2071
|
params: params,
|
2035
2072
|
config: config)
|
2036
2073
|
context[:gem_name] = 'aws-sdk-sns'
|
2037
|
-
context[:gem_version] = '1.
|
2074
|
+
context[:gem_version] = '1.32.0'
|
2038
2075
|
Seahorse::Client::Request.new(handlers, context)
|
2039
2076
|
end
|
2040
2077
|
|
@@ -105,8 +105,8 @@ module Aws::SNS
|
|
105
105
|
# device. The specific name for Token will vary, depending on which
|
106
106
|
# notification service is being used. For example, when using APNS as
|
107
107
|
# the notification service, you need the device token. Alternatively,
|
108
|
-
# when using
|
109
|
-
# registration ID.
|
108
|
+
# when using GCM (Firebase Cloud Messaging) or ADM, the device token
|
109
|
+
# equivalent is called the registration ID.
|
110
110
|
# @option options [String] :custom_user_data
|
111
111
|
# Arbitrary user data to associate with the endpoint. Amazon SNS does
|
112
112
|
# not use this data. The data must be in UTF-8 format and less than 2KB.
|
@@ -150,26 +150,27 @@ module Aws::SNS
|
|
150
150
|
# include the following:
|
151
151
|
#
|
152
152
|
# * `PlatformCredential` – The credential received from the notification
|
153
|
-
# service. For APNS
|
154
|
-
#
|
155
|
-
# PlatformCredential is
|
153
|
+
# service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
|
154
|
+
# `private key`. For `GCM` (Firebase Cloud Messaging),
|
155
|
+
# `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential`
|
156
|
+
# is `client secret`.
|
156
157
|
#
|
157
158
|
# * `PlatformPrincipal` – The principal received from the notification
|
158
|
-
# service. For APNS
|
159
|
-
# certificate
|
160
|
-
# PlatformPrincipal is
|
159
|
+
# service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
|
160
|
+
# certificate`. For `GCM` (Firebase Cloud Messaging), there is no
|
161
|
+
# `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
|
161
162
|
#
|
162
|
-
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
|
163
|
-
# notifications
|
163
|
+
# * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
|
164
|
+
# notifications are sent.
|
164
165
|
#
|
165
|
-
# * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
|
166
|
-
# notifications
|
166
|
+
# * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
|
167
|
+
# notifications are sent.
|
167
168
|
#
|
168
|
-
# * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
|
169
|
-
# notifications
|
169
|
+
# * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
|
170
|
+
# notifications are sent.
|
170
171
|
#
|
171
|
-
# * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
|
172
|
-
# notifications
|
172
|
+
# * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
|
173
|
+
# notifications are sent upon Direct Publish delivery failure
|
173
174
|
# (permanent) to one of the application's endpoints.
|
174
175
|
#
|
175
176
|
# * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
|
data/lib/aws-sdk-sns/resource.rb
CHANGED
@@ -51,7 +51,7 @@ module Aws::SNS
|
|
51
51
|
# between 1 and 256 characters long.
|
52
52
|
# @option options [required, String] :platform
|
53
53
|
# The following platforms are supported: ADM (Amazon Device Messaging),
|
54
|
-
# APNS (Apple Push Notification Service), APNS\_SANDBOX, and
|
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
57
|
# For a list of attributes, see [SetPlatformApplicationAttributes][1]
|
@@ -48,7 +48,8 @@ module Aws::SNS
|
|
48
48
|
# and account system defaults.
|
49
49
|
#
|
50
50
|
# * `FilterPolicy` – The filter policy JSON that is assigned to the
|
51
|
-
# subscription.
|
51
|
+
# subscription. For more information, see [Amazon SNS Message
|
52
|
+
# Filtering][1] in the *Amazon SNS Developer Guide*.
|
52
53
|
#
|
53
54
|
# * `Owner` – The AWS account ID of the subscription's owner.
|
54
55
|
#
|
@@ -70,6 +71,10 @@ module Aws::SNS
|
|
70
71
|
# * `SubscriptionArn` – The subscription's ARN.
|
71
72
|
#
|
72
73
|
# * `TopicArn` – The topic ARN that the subscription is associated with.
|
74
|
+
#
|
75
|
+
#
|
76
|
+
#
|
77
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
|
73
78
|
# @return [Hash<String,String>]
|
74
79
|
def attributes
|
75
80
|
data[:attributes]
|
data/lib/aws-sdk-sns/topic.rb
CHANGED
@@ -59,7 +59,7 @@ module Aws::SNS
|
|
59
59
|
#
|
60
60
|
# * `TopicArn` – The topic's ARN.
|
61
61
|
#
|
62
|
-
# * `EffectiveDeliveryPolicy` –
|
62
|
+
# * `EffectiveDeliveryPolicy` – The JSON serialization of the effective
|
63
63
|
# delivery policy, taking system defaults into account.
|
64
64
|
#
|
65
65
|
# The following attribute applies only to [server-side-encryption][1]\:
|
@@ -388,11 +388,11 @@ module Aws::SNS
|
|
388
388
|
# The endpoint that you want to receive notifications. Endpoints vary by
|
389
389
|
# protocol:
|
390
390
|
#
|
391
|
-
# * For the `http` protocol, the endpoint is
|
392
|
-
# `http://`
|
391
|
+
# * For the `http` protocol, the (public) endpoint is a URL beginning
|
392
|
+
# with `http://`
|
393
393
|
#
|
394
|
-
# * For the `https` protocol, the endpoint is a URL beginning
|
395
|
-
# `https://`
|
394
|
+
# * For the `https` protocol, the (public) endpoint is a URL beginning
|
395
|
+
# with `https://`
|
396
396
|
#
|
397
397
|
# * For the `email` protocol, the endpoint is an email address
|
398
398
|
#
|
@@ -437,16 +437,17 @@ module Aws::SNS
|
|
437
437
|
# Sets whether the response from the `Subscribe` request includes the
|
438
438
|
# subscription ARN, even if the subscription is not yet confirmed.
|
439
439
|
#
|
440
|
-
# * If you
|
441
|
-
#
|
440
|
+
# * If you set this parameter to `true`, the response includes the ARN
|
441
|
+
# in all cases, even if the subscription is not yet confirmed. In
|
442
|
+
# addition to the ARN for confirmed subscriptions, the response also
|
443
|
+
# includes the `pending subscription` ARN value for subscriptions that
|
444
|
+
# aren't yet confirmed. A subscription becomes confirmed when the
|
445
|
+
# subscriber calls the `ConfirmSubscription` action with a
|
446
|
+
# confirmation token.
|
447
|
+
#
|
448
|
+
# ^
|
442
449
|
#
|
443
|
-
# * If you don't have the subscription ARN returned, in addition to the
|
444
|
-
# ARN for confirmed subscriptions, the response also includes the
|
445
|
-
# `pending subscription` ARN value for subscriptions that aren't yet
|
446
|
-
# confirmed. A subscription becomes confirmed when the subscriber
|
447
|
-
# calls the `ConfirmSubscription` action with a confirmation token.
|
448
450
|
#
|
449
|
-
# If you set this parameter to `true`, .
|
450
451
|
#
|
451
452
|
# The default value is `false`.
|
452
453
|
# @return [Subscription]
|
data/lib/aws-sdk-sns/types.rb
CHANGED
@@ -207,7 +207,7 @@ module Aws::SNS
|
|
207
207
|
# @!attribute [rw] platform
|
208
208
|
# The following platforms are supported: ADM (Amazon Device
|
209
209
|
# Messaging), APNS (Apple Push Notification Service), APNS\_SANDBOX,
|
210
|
-
# and
|
210
|
+
# and GCM (Firebase Cloud Messaging).
|
211
211
|
# @return [String]
|
212
212
|
#
|
213
213
|
# @!attribute [rw] attributes
|
@@ -266,8 +266,8 @@ module Aws::SNS
|
|
266
266
|
# a device. The specific name for Token will vary, depending on which
|
267
267
|
# notification service is being used. For example, when using APNS as
|
268
268
|
# the notification service, you need the device token. Alternatively,
|
269
|
-
# when using
|
270
|
-
# registration ID.
|
269
|
+
# when using GCM (Firebase Cloud Messaging) or ADM, the device token
|
270
|
+
# equivalent is called the registration ID.
|
271
271
|
# @return [String]
|
272
272
|
#
|
273
273
|
# @!attribute [rw] custom_user_data
|
@@ -680,7 +680,8 @@ module Aws::SNS
|
|
680
680
|
# delivery policy and account system defaults.
|
681
681
|
#
|
682
682
|
# * `FilterPolicy` – The filter policy JSON that is assigned to the
|
683
|
-
# subscription.
|
683
|
+
# subscription. For more information, see [Amazon SNS Message
|
684
|
+
# Filtering][1] in the *Amazon SNS Developer Guide*.
|
684
685
|
#
|
685
686
|
# * `Owner` – The AWS account ID of the subscription's owner.
|
686
687
|
#
|
@@ -704,6 +705,10 @@ module Aws::SNS
|
|
704
705
|
#
|
705
706
|
# * `TopicArn` – The topic ARN that the subscription is associated
|
706
707
|
# with.
|
708
|
+
#
|
709
|
+
#
|
710
|
+
#
|
711
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
|
707
712
|
# @return [Hash<String,String>]
|
708
713
|
#
|
709
714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
|
@@ -763,7 +768,7 @@ module Aws::SNS
|
|
763
768
|
#
|
764
769
|
# * `TopicArn` – The topic's ARN.
|
765
770
|
#
|
766
|
-
# * `EffectiveDeliveryPolicy` –
|
771
|
+
# * `EffectiveDeliveryPolicy` – The JSON serialization of the
|
767
772
|
# effective delivery policy, taking system defaults into account.
|
768
773
|
#
|
769
774
|
# The following attribute applies only to
|
@@ -1641,26 +1646,28 @@ module Aws::SNS
|
|
1641
1646
|
# include the following:
|
1642
1647
|
#
|
1643
1648
|
# * `PlatformCredential` – The credential received from the
|
1644
|
-
# notification service. For APNS
|
1645
|
-
# is private key
|
1646
|
-
#
|
1649
|
+
# notification service. For `APNS` and `APNS_SANDBOX`,
|
1650
|
+
# `PlatformCredential` is `private key`. For `GCM` (Firebase Cloud
|
1651
|
+
# Messaging), `PlatformCredential` is `API key`. For `ADM`,
|
1652
|
+
# `PlatformCredential` is `client secret`.
|
1647
1653
|
#
|
1648
1654
|
# * `PlatformPrincipal` – The principal received from the notification
|
1649
|
-
# service. For APNS
|
1650
|
-
# certificate
|
1651
|
-
# ADM
|
1655
|
+
# service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is
|
1656
|
+
# `SSL certificate`. For `GCM` (Firebase Cloud Messaging), there is
|
1657
|
+
# no `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client
|
1658
|
+
# id`.
|
1652
1659
|
#
|
1653
|
-
# * `EventEndpointCreated` – Topic ARN to which EndpointCreated
|
1654
|
-
# notifications
|
1660
|
+
# * `EventEndpointCreated` – Topic ARN to which `EndpointCreated`
|
1661
|
+
# event notifications are sent.
|
1655
1662
|
#
|
1656
|
-
# * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted
|
1657
|
-
# notifications
|
1663
|
+
# * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted`
|
1664
|
+
# event notifications are sent.
|
1658
1665
|
#
|
1659
|
-
# * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
|
1660
|
-
# notifications
|
1666
|
+
# * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
|
1667
|
+
# notifications are sent.
|
1661
1668
|
#
|
1662
|
-
# * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure
|
1663
|
-
# notifications
|
1669
|
+
# * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure`
|
1670
|
+
# event notifications are sent upon Direct Publish delivery failure
|
1664
1671
|
# (permanent) to one of the application's endpoints.
|
1665
1672
|
#
|
1666
1673
|
# * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
|
@@ -1971,11 +1978,11 @@ module Aws::SNS
|
|
1971
1978
|
# The endpoint that you want to receive notifications. Endpoints vary
|
1972
1979
|
# by protocol:
|
1973
1980
|
#
|
1974
|
-
# * For the `http` protocol, the endpoint is
|
1975
|
-
# `http://`
|
1981
|
+
# * For the `http` protocol, the (public) endpoint is a URL beginning
|
1982
|
+
# with `http://`
|
1976
1983
|
#
|
1977
|
-
# * For the `https` protocol, the endpoint is a URL beginning
|
1978
|
-
# `https://`
|
1984
|
+
# * For the `https` protocol, the (public) endpoint is a URL beginning
|
1985
|
+
# with `https://`
|
1979
1986
|
#
|
1980
1987
|
# * For the `email` protocol, the endpoint is an email address
|
1981
1988
|
#
|
@@ -2026,18 +2033,17 @@ module Aws::SNS
|
|
2026
2033
|
# Sets whether the response from the `Subscribe` request includes the
|
2027
2034
|
# subscription ARN, even if the subscription is not yet confirmed.
|
2028
2035
|
#
|
2029
|
-
# * If you
|
2030
|
-
#
|
2031
|
-
# confirmed
|
2032
|
-
#
|
2033
|
-
#
|
2034
|
-
# the
|
2035
|
-
# the `pending subscription` ARN value for subscriptions that
|
2036
|
-
# aren't yet confirmed. A subscription becomes confirmed when the
|
2037
|
-
# subscriber calls the `ConfirmSubscription` action with a
|
2036
|
+
# * If you set this parameter to `true`, the response includes the ARN
|
2037
|
+
# in all cases, even if the subscription is not yet confirmed. In
|
2038
|
+
# addition to the ARN for confirmed subscriptions, the response also
|
2039
|
+
# includes the `pending subscription` ARN value for subscriptions
|
2040
|
+
# that aren't yet confirmed. A subscription becomes confirmed when
|
2041
|
+
# the subscriber calls the `ConfirmSubscription` action with a
|
2038
2042
|
# confirmation token.
|
2039
2043
|
#
|
2040
|
-
#
|
2044
|
+
# ^
|
2045
|
+
#
|
2046
|
+
#
|
2041
2047
|
#
|
2042
2048
|
# The default value is `false`.
|
2043
2049
|
# @return [Boolean]
|
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.32.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: 2020-
|
11
|
+
date: 2020-09-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|