aws-sdk-sns 1.25.1 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02741654d8939aec618d96bb80220e255fb66faef992bec0fdc4ad921d22ff72
-  data.tar.gz: 4cdc7d31a87fde8ff0ea5d6f4e773b869bea0dc6e6a28ca8ee7286a2d4411b69
+  metadata.gz: 7e668714dc4d73930de81431ca74a1450d96645a4c28d9c1c597f6266e4dc484
+  data.tar.gz: 468f0a09f42d130fb172a3a012898322eb3e18cd3bf516c843d9866ab7da8f2b
 SHA512:
-  metadata.gz: dd0c740d5a80fc45757ef8b75e5600dd6b350734dddc7488628326a1290cefac5eddb130cb9773952a8df06699609f3b757f225b5dc70b5f8c5c2591b9f6ca26
-  data.tar.gz: 87c4a3b6354db0e6ee67a21c8597957372e2807bca86fa77b955bb0d4a8a6e48d4e5a2793eccb19bad01edd5f37629ca7abc75b982017ef33542c8f60d45757d
+  metadata.gz: d4864308e82b91bbe2df517c69b327cafc56671c7437f34071e4c60e109a8e945e8df601ca5619596c839a44ee4856b0b30f8faa502643a295a1e10a1a042717
+  data.tar.gz: f11d25301facbaf4836fedd3d3b022cac89232389875fc466dbc078cde1c1ad7ff95c1a7dcdf56b670f29551716ed704cd6d0dd8a69902aa6755f74cf36ab158

data/lib/aws-sdk-sns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -46,9 +48,9 @@ require_relative 'aws-sdk-sns/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::SNS
 
-  GEM_VERSION = '1.25.1'
+  GEM_VERSION = '1.30.0'
 
 end

data/lib/aws-sdk-sns/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::SNS
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::SNS
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -427,25 +444,34 @@ module Aws::SNS
     end
 
     # Creates a platform application object for one of the supported push
-    # notification services, such as APNS and FCM, to which devices and
-    # mobile apps may register. You must specify PlatformPrincipal and
-    # PlatformCredential attributes when using the
-    # `CreatePlatformApplication` action. The PlatformPrincipal is received
-    # from the notification service. For APNS/APNS\_SANDBOX,
-    # PlatformPrincipal is "SSL certificate". For FCM, PlatformPrincipal
-    # is not applicable. For ADM, PlatformPrincipal is "client id". The
-    # PlatformCredential is also received from the notification service. For
-    # WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
-    # PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal
-    # is "API key".
-    #
-    # For APNS/APNS\_SANDBOX, PlatformCredential is "private key". For
-    # FCM, PlatformCredential is "API key". For ADM, PlatformCredential is
-    # "client secret". For WNS, PlatformCredential is "secret key". For
-    # MPNS, PlatformCredential is "private key". For Baidu,
-    # PlatformCredential is "secret key". The PlatformApplicationArn that
-    # is returned when using `CreatePlatformApplication` is then used as an
-    # attribute for the `CreatePlatformEndpoint` action.
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging), to which devices and mobile apps may register. You must
+    # specify `PlatformPrincipal` and `PlatformCredential` attributes when
+    # using the `CreatePlatformApplication` action.
+    #
+    # `PlatformPrincipal` and `PlatformCredential` are received from the
+    # notification service.
+    #
+    # * For `ADM`, `PlatformPrincipal` is `client id` and
+    #   `PlatformCredential` is `client secret`.
+    #
+    # * For `Baidu`, `PlatformPrincipal` is `API key` and
+    #   `PlatformCredential` is `secret key`.
+    #
+    # * For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
+    #   certificate` and `PlatformCredential` is `private key`.
+    #
+    # * For `GCM` (Firebase Cloud Messaging), there is no
+    #   `PlatformPrincipal` and the `PlatformCredential` is `API key`.
+    #
+    # * For `MPNS`, `PlatformPrincipal` is `TLS certificate` and
+    #   `PlatformCredential` is `private key`.
+    #
+    # * For `WNS`, `PlatformPrincipal` is `Package Security Identifier` and
+    #   `PlatformCredential` is `secret key`.
+    #
+    # You can use the returned `PlatformApplicationArn` as an attribute for
+    # the `CreatePlatformEndpoint` action.
     #
     # @option params [required, String] :name
     #   Application names must be made up of only uppercase and lowercase
@@ -454,7 +480,7 @@ module Aws::SNS
     #
     # @option params [required, String] :platform
     #   The following platforms are supported: ADM (Amazon Device Messaging),
-    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and FCM
+    #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM
     #   (Firebase Cloud Messaging).
     #
     # @option params [required, Hash<String,String>] :attributes
@@ -492,16 +518,16 @@ module Aws::SNS
     end
 
     # Creates an endpoint for a device and mobile app on one of the
-    # supported push notification services, such as FCM and APNS.
-    # `CreatePlatformEndpoint` requires the PlatformApplicationArn that is
-    # returned from `CreatePlatformApplication`. The EndpointArn that is
-    # returned when using `CreatePlatformEndpoint` can then be used by the
-    # `Publish` action to send a message to a mobile app or by the
-    # `Subscribe` action for subscription to a topic. The
-    # `CreatePlatformEndpoint` action is idempotent, so if the requester
-    # already owns an endpoint with the same device token and attributes,
-    # that endpoint's ARN is returned without creating a new endpoint. For
-    # more information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as GCM (Firebase Cloud
+    # Messaging) and APNS. `CreatePlatformEndpoint` requires the
+    # `PlatformApplicationArn` that is returned from
+    # `CreatePlatformApplication`. You can use the returned `EndpointArn` to
+    # send a message to a mobile app or by the `Subscribe` action for
+    # subscription to a topic. The `CreatePlatformEndpoint` action is
+    # idempotent, so if the requester already owns an endpoint with the same
+    # device token and attributes, that endpoint's ARN is returned without
+    # creating a new endpoint. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     # When using `CreatePlatformEndpoint` with Baidu, two attributes must be
     # provided: ChannelId and UserId. The token field must also contain the
@@ -522,8 +548,8 @@ module Aws::SNS
     #   device. The specific name for Token will vary, depending on which
     #   notification service is being used. For example, when using APNS as
     #   the notification service, you need the device token. Alternatively,
-    #   when using FCM or ADM, the device token equivalent is called the
-    #   registration ID.
+    #   when using GCM (Firebase Cloud Messaging) or ADM, the device token
+    #   equivalent is called the registration ID.
     #
     # @option params [String] :custom_user_data
     #   Arbitrary user data to associate with the endpoint. Amazon SNS does
@@ -683,8 +709,9 @@ module Aws::SNS
     end
 
     # Deletes a platform application object for one of the supported push
-    # notification services, such as APNS and FCM. For more information, see
-    # [Using Amazon SNS Mobile Push Notifications][1].
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging). For more information, see [Using Amazon SNS Mobile Push
+    # Notifications][1].
     #
     #
     #
@@ -736,8 +763,9 @@ module Aws::SNS
     end
 
     # Retrieves the endpoint attributes for a device on one of the supported
-    # push notification services, such as FCM and APNS. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # push notification services, such as GCM (Firebase Cloud Messaging) and
+    # APNS. For more information, see [Using Amazon SNS Mobile Push
+    # Notifications][1].
     #
     #
     #
@@ -771,8 +799,9 @@ module Aws::SNS
     end
 
     # Retrieves the attributes of the platform application object for the
-    # supported push notification services, such as APNS and FCM. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as APNS and GCM (Firebase
+    # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
+    # Push Notifications][1].
     #
     #
     #
@@ -906,11 +935,11 @@ module Aws::SNS
     end
 
     # Lists the endpoints and endpoint attributes for devices in a supported
-    # push notification service, such as FCM and APNS. The results for
-    # `ListEndpointsByPlatformApplication` are paginated and return a
-    # limited list of endpoints, up to 100. If additional records are
-    # available after the first page results, then a NextToken string will
-    # be returned. To receive the next page, you call
+    # push notification service, such as GCM (Firebase Cloud Messaging) and
+    # APNS. The results for `ListEndpointsByPlatformApplication` are
+    # paginated and return a limited list of endpoints, up to 100. If
+    # additional records are available after the first page results, then a
+    # NextToken string will be returned. To receive the next page, you call
     # `ListEndpointsByPlatformApplication` again using the NextToken string
     # received from the previous call. When there are no more records to
     # return, NextToken will be null. For more information, see [Using
@@ -1005,14 +1034,15 @@ module Aws::SNS
     end
 
     # Lists the platform application objects for the supported push
-    # notification services, such as APNS and FCM. The results for
-    # `ListPlatformApplications` are paginated and return a limited list of
-    # applications, up to 100. If additional records are available after the
-    # first page results, then a NextToken string will be returned. To
-    # receive the next page, you call `ListPlatformApplications` using the
-    # NextToken string received from the previous call. When there are no
-    # more records to return, NextToken will be null. For more information,
-    # see [Using Amazon SNS Mobile Push Notifications][1].
+    # notification services, such as APNS and GCM (Firebase Cloud
+    # Messaging). The results for `ListPlatformApplications` are paginated
+    # and return a limited list of applications, up to 100. If additional
+    # records are available after the first page results, then a NextToken
+    # string will be returned. To receive the next page, you call
+    # `ListPlatformApplications` using the NextToken string received from
+    # the previous call. When there are no more records to return,
+    # `NextToken` will be null. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     # This action is throttled at 15 transactions per second (TPS).
     #
@@ -1243,8 +1273,9 @@ module Aws::SNS
       req.send_request(options)
     end
 
-    # Sends a message to an Amazon SNS topic or sends a text message (SMS
-    # message) directly to a phone number.
+    # Sends a message to an Amazon SNS topic, a text message (SMS message)
+    # directly to a phone number, or a message to a mobile platform endpoint
+    # (when you specify the `TargetArn`).
     #
     # If you send a message to a topic, Amazon SNS delivers the message to
     # each endpoint that is subscribed to the topic. The format of the
@@ -1263,6 +1294,9 @@ module Aws::SNS
     # For more information about formatting messages, see [Send Custom
     # Platform-Specific Payloads in Messages to Mobile Devices][1].
     #
+    # You can publish messages only to topics and endpoints in the same AWS
+    # Region.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html
@@ -1431,8 +1465,9 @@ module Aws::SNS
     end
 
     # Sets the attributes for an endpoint for a device on one of the
-    # supported push notification services, such as FCM and APNS. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1].
+    # supported push notification services, such as GCM (Firebase Cloud
+    # Messaging) and APNS. For more information, see [Using Amazon SNS
+    # Mobile Push Notifications][1].
     #
     #
     #
@@ -1480,11 +1515,11 @@ module Aws::SNS
     end
 
     # Sets the attributes of the platform application object for the
-    # supported push notification services, such as APNS and FCM. For more
-    # information, see [Using Amazon SNS Mobile Push Notifications][1]. For
-    # information on configuring attributes for message delivery status, see
-    # [Using Amazon SNS Application Attributes for Message Delivery
-    # Status][2].
+    # supported push notification services, such as APNS and GCM (Firebase
+    # Cloud Messaging). For more information, see [Using Amazon SNS Mobile
+    # Push Notifications][1]. For information on configuring attributes for
+    # message delivery status, see [Using Amazon SNS Application Attributes
+    # for Message Delivery Status][2].
     #
     #
     #
@@ -1499,26 +1534,27 @@ module Aws::SNS
     #   include the following:
     #
     #   * `PlatformCredential` – The credential received from the notification
-    #     service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
-    #     For FCM, PlatformCredential is "API key". For ADM,
-    #     PlatformCredential is "client secret".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
+    #     `private key`. For `GCM` (Firebase Cloud Messaging),
+    #     `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential`
+    #     is `client secret`.
     #
     #   * `PlatformPrincipal` – The principal received from the notification
-    #     service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
-    #     certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
-    #     PlatformPrincipal is "client id".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
+    #     certificate`. For `GCM` (Firebase Cloud Messaging), there is no
+    #     `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
     #
-    #   * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
-    #     notifications should be sent.
+    #   * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
-    #     notifications should be sent.
+    #   * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
-    #     notifications should be sent.
+    #   * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
+    #     notifications are sent.
     #
-    #   * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
-    #     notifications should be sent upon Direct Publish delivery failure
+    #   * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
+    #     notifications are sent upon Direct Publish delivery failure
     #     (permanent) to one of the application's endpoints.
     #
     #   * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS
@@ -1775,11 +1811,13 @@ module Aws::SNS
       req.send_request(options)
     end
 
-    # Prepares to subscribe an endpoint by sending the endpoint a
-    # confirmation message. To actually create a subscription, the endpoint
-    # owner must call the `ConfirmSubscription` action with the token from
-    # the confirmation message. Confirmation tokens are valid for three
-    # days.
+    # Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
+    # HTTP/S or email, or if the endpoint and the topic are not in the same
+    # AWS account, the endpoint owner must the `ConfirmSubscription` action
+    # to confirm the subscription.
+    #
+    # You call the `ConfirmSubscription` action with the token from the
+    # subscription response. Confirmation tokens are valid for three days.
     #
     # This action is throttled at 100 transactions per second (TPS).
     #
@@ -1811,11 +1849,11 @@ module Aws::SNS
     #   The endpoint that you want to receive notifications. Endpoints vary by
     #   protocol:
     #
-    #   * For the `http` protocol, the endpoint is an URL beginning with
-    #     `http://`
+    #   * For the `http` protocol, the (public) endpoint is a URL beginning
+    #     with `http://`
     #
-    #   * For the `https` protocol, the endpoint is a URL beginning with
-    #     `https://`
+    #   * For the `https` protocol, the (public) endpoint is a URL beginning
+    #     with `https://`
     #
     #   * For the `email` protocol, the endpoint is an email address
     #
@@ -1862,16 +1900,17 @@ module Aws::SNS
     #   Sets whether the response from the `Subscribe` request includes the
     #   subscription ARN, even if the subscription is not yet confirmed.
     #
-    #   * If you have the subscription ARN returned, the response includes the
-    #     ARN in all cases, even if the subscription is not yet confirmed.
+    #   * If you set this parameter to `true`, the response includes the ARN
+    #     in all cases, even if the subscription is not yet confirmed. In
+    #     addition to the ARN for confirmed subscriptions, the response also
+    #     includes the `pending subscription` ARN value for subscriptions that
+    #     aren't yet confirmed. A subscription becomes confirmed when the
+    #     subscriber calls the `ConfirmSubscription` action with a
+    #     confirmation token.
+    #
+    #   ^
     #
-    #   * If you don't have the subscription ARN returned, in addition to the
-    #     ARN for confirmed subscriptions, the response also includes the
-    #     `pending subscription` ARN value for subscriptions that aren't yet
-    #     confirmed. A subscription becomes confirmed when the subscriber
-    #     calls the `ConfirmSubscription` action with a confirmation token.
     #
-    #   If you set this parameter to `true`, .
     #
     #   The default value is `false`.
     #
@@ -2032,7 +2071,7 @@ module Aws::SNS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sns'
-      context[:gem_version] = '1.25.1'
+      context[:gem_version] = '1.30.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-sns/client_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

data/lib/aws-sdk-sns/customizations.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # utility classes
 require 'aws-sdk-sns/message_verifier'

data/lib/aws-sdk-sns/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

data/lib/aws-sdk-sns/message_verifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'openssl'
 require 'base64'

data/lib/aws-sdk-sns/platform_application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -103,8 +105,8 @@ module Aws::SNS
     #   device. The specific name for Token will vary, depending on which
     #   notification service is being used. For example, when using APNS as
     #   the notification service, you need the device token. Alternatively,
-    #   when using FCM or ADM, the device token equivalent is called the
-    #   registration ID.
+    #   when using GCM (Firebase Cloud Messaging) or ADM, the device token
+    #   equivalent is called the registration ID.
     # @option options [String] :custom_user_data
     #   Arbitrary user data to associate with the endpoint. Amazon SNS does
     #   not use this data. The data must be in UTF-8 format and less than 2KB.
@@ -148,26 +150,27 @@ module Aws::SNS
     #   include the following:
     #
     #   * `PlatformCredential` – The credential received from the notification
-    #     service. For APNS/APNS\_SANDBOX, PlatformCredential is private key.
-    #     For FCM, PlatformCredential is "API key". For ADM,
-    #     PlatformCredential is "client secret".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformCredential` is
+    #     `private key`. For `GCM` (Firebase Cloud Messaging),
+    #     `PlatformCredential` is `API key`. For `ADM`, `PlatformCredential`
+    #     is `client secret`.
     #
     #   * `PlatformPrincipal` – The principal received from the notification
-    #     service. For APNS/APNS\_SANDBOX, PlatformPrincipal is SSL
-    #     certificate. For FCM, PlatformPrincipal is not applicable. For ADM,
-    #     PlatformPrincipal is "client id".
+    #     service. For `APNS` and `APNS_SANDBOX`, `PlatformPrincipal` is `SSL
+    #     certificate`. For `GCM` (Firebase Cloud Messaging), there is no
+    #     `PlatformPrincipal`. For `ADM`, `PlatformPrincipal` is `client id`.
     #
-    #   * `EventEndpointCreated` – Topic ARN to which EndpointCreated event
-    #     notifications should be sent.
+    #   * `EventEndpointCreated` – Topic ARN to which `EndpointCreated` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointDeleted` – Topic ARN to which EndpointDeleted event
-    #     notifications should be sent.
+    #   * `EventEndpointDeleted` – Topic ARN to which `EndpointDeleted` event
+    #     notifications are sent.
     #
-    #   * `EventEndpointUpdated` – Topic ARN to which EndpointUpdate event
-    #     notifications should be sent.
+    #   * `EventEndpointUpdated` – Topic ARN to which `EndpointUpdate` event
+    #     notifications are sent.
     #
-    #   * `EventDeliveryFailure` – Topic ARN to which DeliveryFailure event
-    #     notifications should be sent upon Direct Publish delivery failure
+    #   * `EventDeliveryFailure` – Topic ARN to which `DeliveryFailure` event
+    #     notifications are sent upon Direct Publish delivery failure
     #     (permanent) to one of the application's endpoints.
     #
     #   * `SuccessFeedbackRoleArn` – IAM role ARN used to give Amazon SNS