aws-sdk-sns 1.27.0 → 1.28.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2e420b3d08d0c2d46addf6ce03251cf1ca15930b1a54fb9aad929c2e5219a5ff
4
- data.tar.gz: 7a067cd5575fff7df274e2ea527883a768b83dec740f3cf227671df0c25ebcf0
3
+ metadata.gz: 45b8acdaa8ab119ccffadab846b65abd4c95c10d4721cf74a5ff3f6ab601f2bf
4
+ data.tar.gz: f289d6e41b035a989bf9c6a7eea842d29914ea012572d293b04c3c2a92bf6d59
5
5
  SHA512:
6
- metadata.gz: 6cebf5d3089c06670fe66f035e014b75440f9beef0feac1f4462bb1e5f019232184361d89a2523abe06fb504aa36a798dad0ab01662501f096f54743add2bd0b
7
- data.tar.gz: 5615bb54a09c0401b759663723737e90ddf8ded86e7b259e0523d72f07cfd0512067fe5fa497ffc3bf46679873d8537fd131bfe7da02064da19b2dcced04fb5a
6
+ metadata.gz: a4efacd88554360f4ab4a1f08589b4ee5a8794f9a77eb470f3a0c9f5859ab0cf87944cf5772e5d9e27f8e753795c4eda5749b5224c1f3758c1c03ea84a38ff1b
7
+ data.tar.gz: 391eb3b717fec77c7e07fa22ca56126c426b7dc5d2dd39d76ca30ae456bb2e62b15af6f3a036ee345a485819717d0fcf39e6ef90812e926480cbec0783e04294
@@ -51,6 +51,6 @@ require_relative 'aws-sdk-sns/customizations'
51
51
  # @service
52
52
  module Aws::SNS
53
53
 
54
- GEM_VERSION = '1.27.0'
54
+ GEM_VERSION = '1.28.0'
55
55
 
56
56
  end
@@ -429,25 +429,34 @@ module Aws::SNS
429
429
  end
430
430
 
431
431
  # Creates a platform application object for one of the supported push
432
- # notification services, such as APNS and FCM, to which devices and
433
- # mobile apps may register. You must specify PlatformPrincipal and
434
- # PlatformCredential attributes when using the
435
- # `CreatePlatformApplication` action. The PlatformPrincipal is received
436
- # from the notification service. For APNS/APNS\_SANDBOX,
437
- # PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal
438
- # is not applicable. For ADM, PlatformPrincipal is "client id". The
439
- # PlatformCredential is also received from the notification service. For
440
- # WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
441
- # PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal
442
- # is "API key".
443
- #
444
- # For APNS/APNS\_SANDBOX, PlatformCredential is "private key". For
445
- # FCM, PlatformCredential is "API key". For ADM, PlatformCredential is
446
- # "client secret". For WNS, PlatformCredential is "secret key". For
447
- # MPNS, PlatformCredential is "private key". For Baidu,
448
- # PlatformCredential is "secret key". The PlatformApplicationArn that
449
- # is returned when using `CreatePlatformApplication` is then used as an
450
- # attribute for the `CreatePlatformEndpoint` action.
432
+ # notification services, such as APNS and GCM (Firebase Cloud
433
+ # Messaging), to which devices and mobile apps may register. You must
434
+ # specify `PlatformPrincipal` and `PlatformCredential` attributes when
435
+ # using the `CreatePlatformApplication` action.
436
+ #
437
+ # `PlatformPrincipal` and `PlatformCredential` are received from the
438
+ # notification service.
439
+ #
440
+ # * For `ADM`, `PlatformPrincipal` is `client id` and
441
+ # `PlatformCredential` is `client secret`.
442
+ #
443
+ # * For `Baidu`, `PlatformPrincipal` is `API key` and
444
+ # `PlatformCredential` is `secret key`.
445
+ #
446
+ # * For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
447
+ # certificate` and `PlatformCredential` is `private key`.
448
+ #
449
+ # * For `GCM` (Firebase Cloud Messaging), there is no
450
+ # `PlatformPrincipal` and the `PlatformCredential` is `API key`.
451
+ #
452
+ # * For `MPNS`, `PlatformPrincipal` is `TLS certificate` and
453
+ # `PlatformCredential` is `private key`.
454
+ #
455
+ # * For `WNS`, `PlatformPrincipal` is `Package Security Identifier` and
456
+ # `PlatformCredential` is `secret key`.
457
+ #
458
+ # You can use the returned `PlatformApplicationArn` as an attribute for
459
+ # the `CreatePlatformEndpoint` action.
451
460
  #
452
461
  # @option params [required, String] :name
453
462
  # Application names must be made up of only uppercase and lowercase
@@ -456,7 +465,7 @@ module Aws::SNS
456
465
  #
457
466
  # @option params [required, String] :platform
458
467
  # The following platforms are supported: ADM (Amazon Device Messaging),
459
- # APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
468
+ # APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
460
469
  # (Firebase Cloud Messaging).
461
470
  #
462
471
  # @option params [required, Hash<String,String>] :attributes
@@ -494,16 +503,16 @@ module Aws::SNS
494
503
  end
495
504
 
496
505
  # Creates an endpoint for a device and mobile app on one of the
497
- # supported push notification services, such as FCM and APNS.
498
- # `CreatePlatformEndpoint` requires the PlatformApplicationArn that is
499
- # returned from `CreatePlatformApplication`. The EndpointArn that is
500
- # returned when using `CreatePlatformEndpoint` can then be used by the
501
- # `Publish` action to send a message to a mobile app or by the
502
- # `Subscribe` action for subscription to a topic. The
503
- # `CreatePlatformEndpoint` action is idempotent, so if the requester
504
- # already owns an endpoint with the same device token and attributes,
505
- # that endpoint's ARN is returned without creating a new endpoint. For
506
- # more information, see [Using Amazon SNS Mobile Push Notifications][1].
506
+ # supported push notification services, such as GCM (Firebase Cloud
507
+ # Messaging) and APNS. `CreatePlatformEndpoint` requires the
508
+ # `PlatformApplicationArn` that is returned from
509
+ # `CreatePlatformApplication`. You can use the returned `EndpointArn` to
510
+ # send a message to a mobile app or by the `Subscribe` action for
511
+ # subscription to a topic. The `CreatePlatformEndpoint` action is
512
+ # idempotent, so if the requester already owns an endpoint with the same
513
+ # device token and attributes, that endpoint's ARN is returned without
514
+ # creating a new endpoint. For more information, see [Using Amazon SNS
515
+ # Mobile Push Notifications][1].
507
516
  #
508
517
  # When using `CreatePlatformEndpoint` with Baidu, two attributes must be
509
518
  # provided: ChannelId and UserId. The token field must also contain the
@@ -524,8 +533,8 @@ module Aws::SNS
524
533
  # device. The specific name for Token will vary, depending on which
525
534
  # notification service is being used. For example, when using APNS as
526
535
  # the notification service, you need the device token. Alternatively,
527
- # when using FCM or ADM, the device token equivalent is called the
528
- # registration ID.
536
+ # when using GCM (Firebase Cloud Messaging) or ADM, the device token
537
+ # equivalent is called the registration ID.
529
538
  #
530
539
  # @option params [String] :custom_user_data
531
540
  # Arbitrary user data to associate with the endpoint. Amazon SNS does
@@ -567,10 +576,11 @@ module Aws::SNS
567
576
  end
568
577
 
569
578
  # Creates a topic to which notifications can be published. Users can
570
- # create at most 100,000 topics. For more information, see
571
- # [https://aws.amazon.com/sns][1]. This action is idempotent, so if the
572
- # requester already owns a topic with the specified name, that topic's
573
- # ARN is returned without creating a new topic.
579
+ # create at most 100,000 standard topics (at most 1,000 FIFO topics).
580
+ # For more information, see [https://aws.amazon.com/sns][1]. This action
581
+ # is idempotent, so if the requester already owns a topic with the
582
+ # specified name, that topic's ARN is returned without creating a new
583
+ # topic.
574
584
  #
575
585
  #
576
586
  #
@@ -583,6 +593,9 @@ module Aws::SNS
583
593
  # lowercase ASCII letters, numbers, underscores, and hyphens, and must
584
594
  # be between 1 and 256 characters long.
585
595
  #
596
+ # For a FIFO (first-in-first-out) topic, the name must end with the
597
+ # `.fifo` suffix.
598
+ #
586
599
  # @option params [Hash<String,String>] :attributes
587
600
  # A map of attributes with their corresponding values.
588
601
  #
@@ -595,18 +608,34 @@ module Aws::SNS
595
608
  # * `DisplayName` – The display name to use for a topic with SMS
596
609
  # subscriptions.
597
610
  #
611
+ # * `FifoTopic` – Set to true to create a FIFO topic.
612
+ #
598
613
  # * `Policy` – The policy that defines who can access your topic. By
599
614
  # default, only the topic owner can publish or subscribe to the topic.
600
615
  #
601
616
  # The following attribute applies only to [server-side-encryption][1]\:
602
617
  #
603
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
618
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
604
619
  # (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
605
620
  # Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
606
621
  # Management Service API Reference*.
607
622
  #
608
623
  # ^
609
624
  #
625
+ # The following attribute applies only to FIFO topics:
626
+ #
627
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
628
+ # Amazon SNS uses a SHA-256 hash to generate the
629
+ # `MessageDeduplicationId` using the body of the message (but not the
630
+ # attributes of the message).
631
+ #
632
+ # * When `ContentBasedDeduplication` is in effect, messages with
633
+ # identical content sent within the deduplication interval are treated
634
+ # as duplicates and only one copy of the message is delivered.
635
+ #
636
+ # * If the queue has `ContentBasedDeduplication` set, your
637
+ # `MessageDeduplicationId` overrides the generated one.
638
+ #
610
639
  #
611
640
  #
612
641
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -685,8 +714,9 @@ module Aws::SNS
685
714
  end
686
715
 
687
716
  # Deletes a platform application object for one of the supported push
688
- # notification services, such as APNS and FCM. For more information, see
689
- # [Using Amazon SNS Mobile Push Notifications][1].
717
+ # notification services, such as APNS and GCM (Firebase Cloud
718
+ # Messaging). For more information, see [Using Amazon SNS Mobile Push
719
+ # Notifications][1].
690
720
  #
691
721
  #
692
722
  #
@@ -738,8 +768,9 @@ module Aws::SNS
738
768
  end
739
769
 
740
770
  # Retrieves the endpoint attributes for a device on one of the supported
741
- # push notification services, such as FCM and APNS. For more
742
- # information, see [Using Amazon SNS Mobile Push Notifications][1].
771
+ # push notification services, such as GCM (Firebase Cloud Messaging) and
772
+ # APNS. For more information, see [Using Amazon SNS Mobile Push
773
+ # Notifications][1].
743
774
  #
744
775
  #
745
776
  #
@@ -773,8 +804,9 @@ module Aws::SNS
773
804
  end
774
805
 
775
806
  # Retrieves the attributes of the platform application object for the
776
- # supported push notification services, such as APNS and FCM. For more
777
- # information, see [Using Amazon SNS Mobile Push Notifications][1].
807
+ # supported push notification services, such as APNS and GCM (Firebase
808
+ # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
809
+ # Push Notifications][1].
778
810
  #
779
811
  #
780
812
  #
@@ -908,11 +940,11 @@ module Aws::SNS
908
940
  end
909
941
 
910
942
  # Lists the endpoints and endpoint attributes for devices in a supported
911
- # push notification service, such as FCM and APNS. The results for
912
- # `ListEndpointsByPlatformApplication` are paginated and return a
913
- # limited list of endpoints, up to 100. If additional records are
914
- # available after the first page results, then a NextToken string will
915
- # be returned. To receive the next page, you call
943
+ # push notification service, such as GCM (Firebase Cloud Messaging) and
944
+ # APNS. The results for `ListEndpointsByPlatformApplication` are
945
+ # paginated and return a limited list of endpoints, up to 100. If
946
+ # additional records are available after the first page results, then a
947
+ # NextToken string will be returned. To receive the next page, you call
916
948
  # `ListEndpointsByPlatformApplication` again using the NextToken string
917
949
  # received from the previous call. When there are no more records to
918
950
  # return, NextToken will be null. For more information, see [Using
@@ -1007,14 +1039,15 @@ module Aws::SNS
1007
1039
  end
1008
1040
 
1009
1041
  # Lists the platform application objects for the supported push
1010
- # notification services, such as APNS and FCM. The results for
1011
- # `ListPlatformApplications` are paginated and return a limited list of
1012
- # applications, up to 100. If additional records are available after the
1013
- # first page results, then a NextToken string will be returned. To
1014
- # receive the next page, you call `ListPlatformApplications` using the
1015
- # NextToken string received from the previous call. When there are no
1016
- # more records to return, NextToken will be null. For more information,
1017
- # see [Using Amazon SNS Mobile Push Notifications][1].
1042
+ # notification services, such as APNS and GCM (Firebase Cloud
1043
+ # Messaging). The results for `ListPlatformApplications` are paginated
1044
+ # and return a limited list of applications, up to 100. If additional
1045
+ # records are available after the first page results, then a NextToken
1046
+ # string will be returned. To receive the next page, you call
1047
+ # `ListPlatformApplications` using the NextToken string received from
1048
+ # the previous call. When there are no more records to return,
1049
+ # `NextToken` will be null. For more information, see [Using Amazon SNS
1050
+ # Mobile Push Notifications][1].
1018
1051
  #
1019
1052
  # This action is throttled at 15 transactions per second (TPS).
1020
1053
  #
@@ -1245,8 +1278,9 @@ module Aws::SNS
1245
1278
  req.send_request(options)
1246
1279
  end
1247
1280
 
1248
- # Sends a message to an Amazon SNS topic or sends a text message (SMS
1249
- # message) directly to a phone number.
1281
+ # Sends a message to an Amazon SNS topic, a text message (SMS message)
1282
+ # directly to a phone number, or a message to a mobile platform endpoint
1283
+ # (when you specify the `TargetArn`).
1250
1284
  #
1251
1285
  # If you send a message to a topic, Amazon SNS delivers the message to
1252
1286
  # each endpoint that is subscribed to the topic. The format of the
@@ -1265,6 +1299,9 @@ module Aws::SNS
1265
1299
  # For more information about formatting messages, see [Send Custom
1266
1300
  # Platform-Specific Payloads in Messages to Mobile Devices][1].
1267
1301
  #
1302
+ # You can publish messages only to topics and endpoints in the same AWS
1303
+ # Region.
1304
+ #
1268
1305
  #
1269
1306
  #
1270
1307
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html
@@ -1433,8 +1470,9 @@ module Aws::SNS
1433
1470
  end
1434
1471
 
1435
1472
  # Sets the attributes for an endpoint for a device on one of the
1436
- # supported push notification services, such as FCM and APNS. For more
1437
- # information, see [Using Amazon SNS Mobile Push Notifications][1].
1473
+ # supported push notification services, such as GCM (Firebase Cloud
1474
+ # Messaging) and APNS. For more information, see [Using Amazon SNS
1475
+ # Mobile Push Notifications][1].
1438
1476
  #
1439
1477
  #
1440
1478
  #
@@ -1482,11 +1520,11 @@ module Aws::SNS
1482
1520
  end
1483
1521
 
1484
1522
  # Sets the attributes of the platform application object for the
1485
- # supported push notification services, such as APNS and FCM. For more
1486
- # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
1487
- # information on configuring attributes for message delivery status, see
1488
- # [Using Amazon SNS Application Attributes for Message Delivery
1489
- # Status][2].
1523
+ # supported push notification services, such as APNS and GCM (Firebase
1524
+ # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
1525
+ # Push Notifications][1]. For information on configuring attributes for
1526
+ # message delivery status, see [Using Amazon SNS Application Attributes
1527
+ # for Message Delivery Status][2].
1490
1528
  #
1491
1529
  #
1492
1530
  #
@@ -1501,26 +1539,27 @@ module Aws::SNS
1501
1539
  # include the following:
1502
1540
  #
1503
1541
  # * `PlatformCredential` – The credential received from the notification
1504
- # service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
1505
- # For FCM, PlatformCredential is "API key". For ADM,
1506
- # PlatformCredential is "client secret".
1542
+ # service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
1543
+ # `private key`. For `GCM` (Firebase Cloud Messaging),
1544
+ # `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential`
1545
+ # is `client secret`.
1507
1546
  #
1508
1547
  # * `PlatformPrincipal` – The principal received from the notification
1509
- # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
1510
- # certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
1511
- # PlatformPrincipal is "client id".
1548
+ # service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
1549
+ # certificate`. For `GCM` (Firebase Cloud Messaging), there is no
1550
+ # `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
1512
1551
  #
1513
- # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
1514
- # notifications should be sent.
1552
+ # * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
1553
+ # notifications are sent.
1515
1554
  #
1516
- # * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
1517
- # notifications should be sent.
1555
+ # * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
1556
+ # notifications are sent.
1518
1557
  #
1519
- # * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
1520
- # notifications should be sent.
1558
+ # * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
1559
+ # notifications are sent.
1521
1560
  #
1522
- # * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
1523
- # notifications should be sent upon Direct Publish delivery failure
1561
+ # * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
1562
+ # notifications are sent upon Direct Publish delivery failure
1524
1563
  # (permanent) to one of the application's endpoints.
1525
1564
  #
1526
1565
  # * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
@@ -1742,13 +1781,27 @@ module Aws::SNS
1742
1781
  #
1743
1782
  # The following attribute applies only to [server-side-encryption][1]\:
1744
1783
  #
1745
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
1784
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
1746
1785
  # (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
1747
1786
  # Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
1748
1787
  # Management Service API Reference*.
1749
1788
  #
1750
1789
  # ^
1751
1790
  #
1791
+ # The following attribute applies only to FIFO topics:
1792
+ #
1793
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
1794
+ # Amazon SNS uses a SHA-256 hash to generate the
1795
+ # `MessageDeduplicationId` using the body of the message (but not the
1796
+ # attributes of the message).
1797
+ #
1798
+ # * When `ContentBasedDeduplication` is in effect, messages with
1799
+ # identical content sent within the deduplication interval are treated
1800
+ # as duplicates and only one copy of the message is delivered.
1801
+ #
1802
+ # * If the queue has `ContentBasedDeduplication` set, your
1803
+ # `MessageDeduplicationId` overrides the generated one.
1804
+ #
1752
1805
  #
1753
1806
  #
1754
1807
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -1777,11 +1830,13 @@ module Aws::SNS
1777
1830
  req.send_request(options)
1778
1831
  end
1779
1832
 
1780
- # Prepares to subscribe an endpoint by sending the endpoint a
1781
- # confirmation message. To actually create a subscription, the endpoint
1782
- # owner must call the `ConfirmSubscription` action with the token from
1783
- # the confirmation message. Confirmation tokens are valid for three
1784
- # days.
1833
+ # Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
1834
+ # HTTP/S or email, or if the endpoint and the topic are not in the same
1835
+ # AWS account, the endpoint owner must the `ConfirmSubscription` action
1836
+ # to confirm the subscription.
1837
+ #
1838
+ # You call the `ConfirmSubscription` action with the token from the
1839
+ # subscription response. Confirmation tokens are valid for three days.
1785
1840
  #
1786
1841
  # This action is throttled at 100 transactions per second (TPS).
1787
1842
  #
@@ -1813,11 +1868,11 @@ module Aws::SNS
1813
1868
  # The endpoint that you want to receive notifications. Endpoints vary by
1814
1869
  # protocol:
1815
1870
  #
1816
- # * For the `http` protocol, the endpoint is an URL beginning with
1817
- # `http://`
1871
+ # * For the `http` protocol, the (public) endpoint is a URL beginning
1872
+ # with `http://`
1818
1873
  #
1819
- # * For the `https` protocol, the endpoint is a URL beginning with
1820
- # `https://`
1874
+ # * For the `https` protocol, the (public) endpoint is a URL beginning
1875
+ # with `https://`
1821
1876
  #
1822
1877
  # * For the `email` protocol, the endpoint is an email address
1823
1878
  #
@@ -1864,16 +1919,17 @@ module Aws::SNS
1864
1919
  # Sets whether the response from the `Subscribe` request includes the
1865
1920
  # subscription ARN, even if the subscription is not yet confirmed.
1866
1921
  #
1867
- # * If you have the subscription ARN returned, the response includes the
1868
- # ARN in all cases, even if the subscription is not yet confirmed.
1922
+ # * If you set this parameter to `true`, the response includes the ARN
1923
+ # in all cases, even if the subscription is not yet confirmed. In
1924
+ # addition to the ARN for confirmed subscriptions, the response also
1925
+ # includes the `pending subscription` ARN value for subscriptions that
1926
+ # aren't yet confirmed. A subscription becomes confirmed when the
1927
+ # subscriber calls the `ConfirmSubscription` action with a
1928
+ # confirmation token.
1929
+ #
1930
+ # ^
1869
1931
  #
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
1932
  #
1876
- # If you set this parameter to `true`, .
1877
1933
  #
1878
1934
  # The default value is `false`.
1879
1935
  #
@@ -2034,7 +2090,7 @@ module Aws::SNS
2034
2090
  params: params,
2035
2091
  config: config)
2036
2092
  context[:gem_name] = 'aws-sdk-sns'
2037
- context[:gem_version] = '1.27.0'
2093
+ context[:gem_version] = '1.28.0'
2038
2094
  Seahorse::Client::Request.new(handlers, context)
2039
2095
  end
2040
2096
 
@@ -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 FCM or ADM, the device token equivalent is called the
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/APNS\_SANDBOX, PlatformCredential is private key.
154
- # For FCM, PlatformCredential is "API key". For ADM,
155
- # PlatformCredential is "client secret".
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/APNS\_SANDBOX, PlatformPrincipal is SSL
159
- # certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
160
- # PlatformPrincipal is "client id".
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 should be sent.
163
+ # * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
164
+ # notifications are sent.
164
165
  #
165
- # * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
166
- # notifications should be sent.
166
+ # * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
167
+ # notifications are sent.
167
168
  #
168
- # * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
169
- # notifications should be sent.
169
+ # * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
170
+ # notifications are sent.
170
171
  #
171
- # * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
172
- # notifications should be sent upon Direct Publish delivery failure
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
@@ -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 FCM
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]
@@ -89,6 +89,9 @@ module Aws::SNS
89
89
  # Constraints: Topic names must be made up of only uppercase and
90
90
  # lowercase ASCII letters, numbers, underscores, and hyphens, and must
91
91
  # be between 1 and 256 characters long.
92
+ #
93
+ # For a FIFO (first-in-first-out) topic, the name must end with the
94
+ # `.fifo` suffix.
92
95
  # @option options [Hash<String,String>] :attributes
93
96
  # A map of attributes with their corresponding values.
94
97
  #
@@ -101,18 +104,34 @@ module Aws::SNS
101
104
  # * `DisplayName` – The display name to use for a topic with SMS
102
105
  # subscriptions.
103
106
  #
107
+ # * `FifoTopic` – Set to true to create a FIFO topic.
108
+ #
104
109
  # * `Policy` – The policy that defines who can access your topic. By
105
110
  # default, only the topic owner can publish or subscribe to the topic.
106
111
  #
107
112
  # The following attribute applies only to [server-side-encryption][1]\:
108
113
  #
109
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
114
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
110
115
  # (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
111
116
  # Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
112
117
  # Management Service API Reference*.
113
118
  #
114
119
  # ^
115
120
  #
121
+ # The following attribute applies only to FIFO topics:
122
+ #
123
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
124
+ # Amazon SNS uses a SHA-256 hash to generate the
125
+ # `MessageDeduplicationId` using the body of the message (but not the
126
+ # attributes of the message).
127
+ #
128
+ # * When `ContentBasedDeduplication` is in effect, messages with
129
+ # identical content sent within the deduplication interval are treated
130
+ # as duplicates and only one copy of the message is delivered.
131
+ #
132
+ # * If the queue has `ContentBasedDeduplication` set, your
133
+ # `MessageDeduplicationId` overrides the generated one.
134
+ #
116
135
  #
117
136
  #
118
137
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -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]
@@ -59,7 +59,7 @@ module Aws::SNS
59
59
  #
60
60
  # * `TopicArn` – The topic's ARN.
61
61
  #
62
- # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the effective
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]\:
@@ -332,13 +332,27 @@ module Aws::SNS
332
332
  #
333
333
  # The following attribute applies only to [server-side-encryption][1]\:
334
334
  #
335
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
335
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
336
336
  # (CMK) for Amazon SNS or a custom CMK. For more information, see [Key
337
337
  # Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
338
338
  # Management Service API Reference*.
339
339
  #
340
340
  # ^
341
341
  #
342
+ # The following attribute applies only to FIFO topics:
343
+ #
344
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
345
+ # Amazon SNS uses a SHA-256 hash to generate the
346
+ # `MessageDeduplicationId` using the body of the message (but not the
347
+ # attributes of the message).
348
+ #
349
+ # * When `ContentBasedDeduplication` is in effect, messages with
350
+ # identical content sent within the deduplication interval are treated
351
+ # as duplicates and only one copy of the message is delivered.
352
+ #
353
+ # * If the queue has `ContentBasedDeduplication` set, your
354
+ # `MessageDeduplicationId` overrides the generated one.
355
+ #
342
356
  #
343
357
  #
344
358
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -388,11 +402,11 @@ module Aws::SNS
388
402
  # The endpoint that you want to receive notifications. Endpoints vary by
389
403
  # protocol:
390
404
  #
391
- # * For the `http` protocol, the endpoint is an URL beginning with
392
- # `http://`
405
+ # * For the `http` protocol, the (public) endpoint is a URL beginning
406
+ # with `http://`
393
407
  #
394
- # * For the `https` protocol, the endpoint is a URL beginning with
395
- # `https://`
408
+ # * For the `https` protocol, the (public) endpoint is a URL beginning
409
+ # with `https://`
396
410
  #
397
411
  # * For the `email` protocol, the endpoint is an email address
398
412
  #
@@ -437,16 +451,17 @@ module Aws::SNS
437
451
  # Sets whether the response from the `Subscribe` request includes the
438
452
  # subscription ARN, even if the subscription is not yet confirmed.
439
453
  #
440
- # * If you have the subscription ARN returned, the response includes the
441
- # ARN in all cases, even if the subscription is not yet confirmed.
454
+ # * If you set this parameter to `true`, the response includes the ARN
455
+ # in all cases, even if the subscription is not yet confirmed. In
456
+ # addition to the ARN for confirmed subscriptions, the response also
457
+ # includes the `pending subscription` ARN value for subscriptions that
458
+ # aren't yet confirmed. A subscription becomes confirmed when the
459
+ # subscriber calls the `ConfirmSubscription` action with a
460
+ # confirmation token.
461
+ #
462
+ # ^
442
463
  #
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
464
  #
449
- # If you set this parameter to `true`, .
450
465
  #
451
466
  # The default value is `false`.
452
467
  # @return [Subscription]
@@ -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 FCM (Firebase Cloud Messaging).
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 FCM or ADM, the device token equivalent is called the
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
@@ -319,6 +319,9 @@ module Aws::SNS
319
319
  # Constraints: Topic names must be made up of only uppercase and
320
320
  # lowercase ASCII letters, numbers, underscores, and hyphens, and must
321
321
  # be between 1 and 256 characters long.
322
+ #
323
+ # For a FIFO (first-in-first-out) topic, the name must end with the
324
+ # `.fifo` suffix.
322
325
  # @return [String]
323
326
  #
324
327
  # @!attribute [rw] attributes
@@ -333,6 +336,8 @@ module Aws::SNS
333
336
  # * `DisplayName` – The display name to use for a topic with SMS
334
337
  # subscriptions.
335
338
  #
339
+ # * `FifoTopic` – Set to true to create a FIFO topic.
340
+ #
336
341
  # * `Policy` – The policy that defines who can access your topic. By
337
342
  # default, only the topic owner can publish or subscribe to the
338
343
  # topic.
@@ -340,13 +345,28 @@ module Aws::SNS
340
345
  # The following attribute applies only to
341
346
  # [server-side-encryption][1]\:
342
347
  #
343
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
348
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
344
349
  # (CMK) for Amazon SNS or a custom CMK. For more information, see
345
350
  # [Key Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
346
351
  # Management Service API Reference*.
347
352
  #
348
353
  # ^
349
354
  #
355
+ # The following attribute applies only to FIFO topics:
356
+ #
357
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
358
+ # Amazon SNS uses a SHA-256 hash to generate the
359
+ # `MessageDeduplicationId` using the body of the message (but not
360
+ # the attributes of the message).
361
+ #
362
+ # * When `ContentBasedDeduplication` is in effect, messages with
363
+ # identical content sent within the deduplication interval are
364
+ # treated as duplicates and only one copy of the message is
365
+ # delivered.
366
+ #
367
+ # * If the queue has `ContentBasedDeduplication` set, your
368
+ # `MessageDeduplicationId` overrides the generated one.
369
+ #
350
370
  #
351
371
  #
352
372
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -680,7 +700,8 @@ module Aws::SNS
680
700
  # delivery policy and account system defaults.
681
701
  #
682
702
  # * `FilterPolicy` – The filter policy JSON that is assigned to the
683
- # subscription.
703
+ # subscription. For more information, see [Amazon SNS Message
704
+ # Filtering][1] in the *Amazon SNS Developer Guide*.
684
705
  #
685
706
  # * `Owner` – The AWS account ID of the subscription's owner.
686
707
  #
@@ -704,6 +725,10 @@ module Aws::SNS
704
725
  #
705
726
  # * `TopicArn` – The topic ARN that the subscription is associated
706
727
  # with.
728
+ #
729
+ #
730
+ #
731
+ # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html
707
732
  # @return [Hash<String,String>]
708
733
  #
709
734
  # @see http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/GetSubscriptionAttributesResponse AWS API Documentation
@@ -763,7 +788,7 @@ module Aws::SNS
763
788
  #
764
789
  # * `TopicArn` – The topic's ARN.
765
790
  #
766
- # * `EffectiveDeliveryPolicy` – Yhe JSON serialization of the
791
+ # * `EffectiveDeliveryPolicy` – The JSON serialization of the
767
792
  # effective delivery policy, taking system defaults into account.
768
793
  #
769
794
  # The following attribute applies only to
@@ -1641,26 +1666,28 @@ module Aws::SNS
1641
1666
  # include the following:
1642
1667
  #
1643
1668
  # * `PlatformCredential` – The credential received from the
1644
- # notification service. For APNS/APNS\_SANDBOX, PlatformCredential
1645
- # is private key. For FCM, PlatformCredential is "API key". For
1646
- # ADM, PlatformCredential is "client secret".
1669
+ # notification service. For `APNS` and `APNS_SANDBOX`,
1670
+ # `PlatformCredential` is `private key`. For `GCM` (Firebase Cloud
1671
+ # Messaging), `PlatformCredential` is `API key`. For `ADM`,
1672
+ # `PlatformCredential` is `client secret`.
1647
1673
  #
1648
1674
  # * `PlatformPrincipal` – The principal received from the notification
1649
- # service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
1650
- # certificate. For FCM, PlatformPrincipal is not applicable. For
1651
- # ADM, PlatformPrincipal is "client id".
1675
+ # service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is
1676
+ # `SSL certificate`. For `GCM` (Firebase Cloud Messaging), there is
1677
+ # no `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client
1678
+ # id`.
1652
1679
  #
1653
- # * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
1654
- # notifications should be sent.
1680
+ # * `EventEndpointCreated` – Topic ARN to which `EndpointCreated`
1681
+ # event notifications are sent.
1655
1682
  #
1656
- # * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
1657
- # notifications should be sent.
1683
+ # * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted`
1684
+ # event notifications are sent.
1658
1685
  #
1659
- # * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
1660
- # notifications should be sent.
1686
+ # * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
1687
+ # notifications are sent.
1661
1688
  #
1662
- # * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
1663
- # notifications should be sent upon Direct Publish delivery failure
1689
+ # * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure`
1690
+ # event notifications are sent upon Direct Publish delivery failure
1664
1691
  # (permanent) to one of the application's endpoints.
1665
1692
  #
1666
1693
  # * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
@@ -1884,13 +1911,28 @@ module Aws::SNS
1884
1911
  # The following attribute applies only to
1885
1912
  # [server-side-encryption][1]\:
1886
1913
  #
1887
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
1914
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
1888
1915
  # (CMK) for Amazon SNS or a custom CMK. For more information, see
1889
1916
  # [Key Terms][2]. For more examples, see [KeyId][3] in the *AWS Key
1890
1917
  # Management Service API Reference*.
1891
1918
  #
1892
1919
  # ^
1893
1920
  #
1921
+ # The following attribute applies only to FIFO topics:
1922
+ #
1923
+ # * `ContentBasedDeduplication` – Enables content-based deduplication.
1924
+ # Amazon SNS uses a SHA-256 hash to generate the
1925
+ # `MessageDeduplicationId` using the body of the message (but not
1926
+ # the attributes of the message).
1927
+ #
1928
+ # * When `ContentBasedDeduplication` is in effect, messages with
1929
+ # identical content sent within the deduplication interval are
1930
+ # treated as duplicates and only one copy of the message is
1931
+ # delivered.
1932
+ #
1933
+ # * If the queue has `ContentBasedDeduplication` set, your
1934
+ # `MessageDeduplicationId` overrides the generated one.
1935
+ #
1894
1936
  #
1895
1937
  #
1896
1938
  # [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html
@@ -1971,11 +2013,11 @@ module Aws::SNS
1971
2013
  # The endpoint that you want to receive notifications. Endpoints vary
1972
2014
  # by protocol:
1973
2015
  #
1974
- # * For the `http` protocol, the endpoint is an URL beginning with
1975
- # `http://`
2016
+ # * For the `http` protocol, the (public) endpoint is a URL beginning
2017
+ # with `http://`
1976
2018
  #
1977
- # * For the `https` protocol, the endpoint is a URL beginning with
1978
- # `https://`
2019
+ # * For the `https` protocol, the (public) endpoint is a URL beginning
2020
+ # with `https://`
1979
2021
  #
1980
2022
  # * For the `email` protocol, the endpoint is an email address
1981
2023
  #
@@ -2026,18 +2068,17 @@ module Aws::SNS
2026
2068
  # Sets whether the response from the `Subscribe` request includes the
2027
2069
  # subscription ARN, even if the subscription is not yet confirmed.
2028
2070
  #
2029
- # * If you have the subscription ARN returned, the response includes
2030
- # the ARN in all cases, even if the subscription is not yet
2031
- # confirmed.
2032
- #
2033
- # * If you don't have the subscription ARN returned, in addition to
2034
- # the ARN for confirmed subscriptions, the response also includes
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
2071
+ # * If you set this parameter to `true`, the response includes the ARN
2072
+ # in all cases, even if the subscription is not yet confirmed. In
2073
+ # addition to the ARN for confirmed subscriptions, the response also
2074
+ # includes the `pending subscription` ARN value for subscriptions
2075
+ # that aren't yet confirmed. A subscription becomes confirmed when
2076
+ # the subscriber calls the `ConfirmSubscription` action with a
2038
2077
  # confirmation token.
2039
2078
  #
2040
- # If you set this parameter to `true`, .
2079
+ # ^
2080
+ #
2081
+ #
2041
2082
  #
2042
2083
  # The default value is `false`.
2043
2084
  # @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.27.0
4
+ version: 1.28.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-07-02 00:00:00.000000000 Z
11
+ date: 2020-07-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core