aws-sdk-sns 1.0.0.rc1 → 1.0.0.rc2

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

@@ -1,23 +1,14 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module SNS
-    module Errors
+module Aws::SNS
+  module Errors
 
-      extend Aws::Errors::DynamicErrors
+    extend Aws::Errors::DynamicErrors
 
-      # Raised when calling #load or #data on a resource class that can not be
-      # loaded.  This can happen when:
-      #
-      # * A resource class has identifiers, but no data attributes.
-      # * Resource data is only available when making an API call that
-      # enumerates all resources of that type.
-      class ResourceNotLoadable < RuntimeError; end
-    end
   end
 end

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

@@ -1,235 +1,233 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module SNS
-    class PlatformApplication
-
-      extend Aws::Deprecations
-
-      # @overload def initialize(arn, options = {})
-      #   @param [String] arn
-      #   @option options [Client] :client
-      # @overload def initialize(options = {})
-      #   @option options [required, String] :arn
-      #   @option options [Client] :client
-      def initialize(*args)
-        options = Hash === args.last ? args.pop.dup : {}
-        @arn = extract_arn(args, options)
-        @data = options.delete(:data)
-        @client = options.delete(:client) || Client.new(options)
-      end
+module Aws::SNS
+  class PlatformApplication
+
+    extend Aws::Deprecations
+
+    # @overload def initialize(arn, options = {})
+    #   @param [String] arn
+    #   @option options [Client] :client
+    # @overload def initialize(options = {})
+    #   @option options [required, String] :arn
+    #   @option options [Client] :client
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      @arn = extract_arn(args, options)
+      @data = options.delete(:data)
+      @client = options.delete(:client) || Client.new(options)
+    end
 
-      # @!group Read-Only Attributes
+    # @!group Read-Only Attributes
 
-      # @return [String]
-      def arn
-        @arn
-      end
+    # @return [String]
+    def arn
+      @arn
+    end
 
-      # Attributes include the following:
-      #
-      # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
-      #   notifications should be sent.
-      #
-      # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
-      #   notifications should be sent.
-      #
-      # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
-      #   notifications should be sent.
-      #
-      # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
-      #   notifications should be sent upon Direct Publish delivery failure
-      #   (permanent) to one of the application's endpoints.
-      # @return [Hash<String,String>]
-      def attributes
-        data.attributes
-      end
+    # Attributes include the following:
+    #
+    # * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
+    #   notifications should be sent.
+    #
+    # * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
+    #   notifications should be sent.
+    #
+    # * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
+    #   notifications should be sent.
+    #
+    # * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
+    #   notifications should be sent upon Direct Publish delivery failure
+    #   (permanent) to one of the application's endpoints.
+    # @return [Hash<String,String>]
+    def attributes
+      data.attributes
+    end
 
-      # @!endgroup
+    # @!endgroup
 
-      # @return [Client]
-      def client
-        @client
-      end
+    # @return [Client]
+    def client
+      @client
+    end
 
-      # Loads, or reloads {#data} for the current {PlatformApplication}.
-      # Returns `self` making it possible to chain methods.
-      #
-      #     platform_application.reload.data
-      #
-      # @return [self]
-      def load
-        resp = @client.get_platform_application_attributes(platform_application_arn: @arn)
-        @data = resp.data
-        self
-      end
-      alias :reload :load
-
-      # @return [Types::GetPlatformApplicationAttributesResponse]
-      #   Returns the data for this {PlatformApplication}. Calls
-      #   {Client#get_platform_application_attributes} if {#data_loaded?} is `false`.
-      def data
-        load unless @data
-        @data
-      end
+    # Loads, or reloads {#data} for the current {PlatformApplication}.
+    # Returns `self` making it possible to chain methods.
+    #
+    #     platform_application.reload.data
+    #
+    # @return [self]
+    def load
+      resp = @client.get_platform_application_attributes(platform_application_arn: @arn)
+      @data = resp.data
+      self
+    end
+    alias :reload :load
+
+    # @return [Types::GetPlatformApplicationAttributesResponse]
+    #   Returns the data for this {PlatformApplication}. Calls
+    #   {Client#get_platform_application_attributes} if {#data_loaded?} is `false`.
+    def data
+      load unless @data
+      @data
+    end
 
-      # @return [Boolean]
-      #   Returns `true` if this resource is loaded.  Accessing attributes or
-      #   {#data} on an unloaded resource will trigger a call to {#load}.
-      def data_loaded?
-        !!@data
-      end
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
 
-      # @!group Actions
-
-      # @example Request syntax with placeholder values
-      #
-      #   platformendpoint = platform_application.create_platform_endpoint({
-      #     token: "String", # required
-      #     custom_user_data: "String",
-      #     attributes: {
-      #       "String" => "String",
-      #     },
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, String] :token
-      #   Unique identifier created by the notification service for an app on a
-      #   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 GCM 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.
-      # @option options [Hash<String,String>] :attributes
-      #   For a list of attributes, see [SetEndpointAttributes][1].
-      #
-      #
-      #
-      #   [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html
-      # @return [PlatformEndpoint]
-      def create_platform_endpoint(options = {})
-        options = options.merge(platform_application_arn: @arn)
-        resp = @client.create_platform_endpoint(options)
-        PlatformEndpoint.new(
-          arn: resp.data.endpoint_arn,
-          client: @client
-        )
-      end
+    # @!group Actions
+
+    # @example Request syntax with placeholder values
+    #
+    #   platformendpoint = platform_application.create_platform_endpoint({
+    #     token: "String", # required
+    #     custom_user_data: "String",
+    #     attributes: {
+    #       "String" => "String",
+    #     },
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, String] :token
+    #   Unique identifier created by the notification service for an app on a
+    #   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 GCM 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.
+    # @option options [Hash<String,String>] :attributes
+    #   For a list of attributes, see [SetEndpointAttributes][1].
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html
+    # @return [PlatformEndpoint]
+    def create_platform_endpoint(options = {})
+      options = options.merge(platform_application_arn: @arn)
+      resp = @client.create_platform_endpoint(options)
+      PlatformEndpoint.new(
+        arn: resp.data.endpoint_arn,
+        client: @client
+      )
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   platform_application.delete()
-      # @param [Hash] options ({})
-      # @return [EmptyStructure]
-      def delete(options = {})
-        options = options.merge(platform_application_arn: @arn)
-        resp = @client.delete_platform_application(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   platform_application.delete()
+    # @param [Hash] options ({})
+    # @return [EmptyStructure]
+    def delete(options = {})
+      options = options.merge(platform_application_arn: @arn)
+      resp = @client.delete_platform_application(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   platform_application.set_attributes({
-      #     attributes: { # required
-      #       "String" => "String",
-      #     },
-      #   })
-      # @param [Hash] options ({})
-      # @option options [required, Hash<String,String>] :attributes
-      #   A map of the platform application attributes. Attributes in this map
-      #   include the following:
-      #
-      #   * `PlatformCredential` -- The credential received from the
-      #     notification service. For APNS/APNS\_SANDBOX, PlatformCredential is
-      #     private key. For GCM, 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 GCM, PlatformPrincipal is not applicable. For ADM,
-      #     PlatformPrincipal is "client id".
-      #
-      #   * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
-      #     notifications should be sent.
-      #
-      #   * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
-      #     notifications should be sent.
-      #
-      #   * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
-      #     notifications should be sent.
-      #
-      #   * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
-      #     notifications should be sent upon Direct Publish delivery failure
-      #     (permanent) to one of the application's endpoints.
-      #
-      #   * `SuccessFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
-      #     write access to use CloudWatch Logs on your behalf.
-      #
-      #   * `FailureFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
-      #     write access to use CloudWatch Logs on your behalf.
-      #
-      #   * `SuccessFeedbackSampleRate` -- Sample rate percentage (0-100) of
-      #     successfully delivered messages.
-      # @return [EmptyStructure]
-      def set_attributes(options = {})
-        options = options.merge(platform_application_arn: @arn)
-        resp = @client.set_platform_application_attributes(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   platform_application.set_attributes({
+    #     attributes: { # required
+    #       "String" => "String",
+    #     },
+    #   })
+    # @param [Hash] options ({})
+    # @option options [required, Hash<String,String>] :attributes
+    #   A map of the platform application attributes. Attributes in this map
+    #   include the following:
+    #
+    #   * `PlatformCredential` -- The credential received from the
+    #     notification service. For APNS/APNS\_SANDBOX, PlatformCredential is
+    #     private key. For GCM, 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 GCM, PlatformPrincipal is not applicable. For ADM,
+    #     PlatformPrincipal is "client id".
+    #
+    #   * `EventEndpointCreated` -- Topic ARN to which EndpointCreated event
+    #     notifications should be sent.
+    #
+    #   * `EventEndpointDeleted` -- Topic ARN to which EndpointDeleted event
+    #     notifications should be sent.
+    #
+    #   * `EventEndpointUpdated` -- Topic ARN to which EndpointUpdate event
+    #     notifications should be sent.
+    #
+    #   * `EventDeliveryFailure` -- Topic ARN to which DeliveryFailure event
+    #     notifications should be sent upon Direct Publish delivery failure
+    #     (permanent) to one of the application's endpoints.
+    #
+    #   * `SuccessFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
+    #     write access to use CloudWatch Logs on your behalf.
+    #
+    #   * `FailureFeedbackRoleArn` -- IAM role ARN used to give Amazon SNS
+    #     write access to use CloudWatch Logs on your behalf.
+    #
+    #   * `SuccessFeedbackSampleRate` -- Sample rate percentage (0-100) of
+    #     successfully delivered messages.
+    # @return [EmptyStructure]
+    def set_attributes(options = {})
+      options = options.merge(platform_application_arn: @arn)
+      resp = @client.set_platform_application_attributes(options)
+      resp.data
+    end
+
+    # @!group Associations
 
-      # @!group Associations
-
-      # @example Request syntax with placeholder values
-      #
-      #   endpoints = platform_application.endpoints()
-      # @param [Hash] options ({})
-      # @return [PlatformEndpoint::Collection]
-      def endpoints(options = {})
-        batches = Enumerator.new do |y|
-          options = options.merge(platform_application_arn: @arn)
-          resp = @client.list_endpoints_by_platform_application(options)
-          resp.each_page do |page|
-            batch = []
-            page.data.endpoints.each do |e|
-              batch << PlatformEndpoint.new(
-                arn: e.endpoint_arn,
-                client: @client
-              )
-            end
-            y.yield(batch)
+    # @example Request syntax with placeholder values
+    #
+    #   platform_application.endpoints()
+    # @param [Hash] options ({})
+    # @return [PlatformEndpoint::Collection]
+    def endpoints(options = {})
+      batches = Enumerator.new do |y|
+        options = options.merge(platform_application_arn: @arn)
+        resp = @client.list_endpoints_by_platform_application(options)
+        resp.each_page do |page|
+          batch = []
+          page.data.endpoints.each do |e|
+            batch << PlatformEndpoint.new(
+              arn: e.endpoint_arn,
+              client: @client
+            )
           end
+          y.yield(batch)
         end
-        PlatformEndpoint::Collection.new(batches)
       end
+      PlatformEndpoint::Collection.new(batches)
+    end
 
-      # @deprecated
-      # @api private
-      def identifiers
-        { arn: @arn }
-      end
-      deprecated(:identifiers)
-
-      private
-
-      def extract_arn(args, options)
-        value = args[0] || options.delete(:arn)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :arn"
-        else
-          msg = "expected :arn to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    # @deprecated
+    # @api private
+    def identifiers
+      { arn: @arn }
+    end
+    deprecated(:identifiers)
+
+    private
+
+    def extract_arn(args, options)
+      value = args[0] || options.delete(:arn)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :arn"
+      else
+        msg = "expected :arn to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
-
-      class Collection < Aws::Resources::Collection; end
     end
+
+    class Collection < Aws::Resources::Collection; end
   end
 end