aws-sdk-sns 1.0.0.rc1

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

@@ -0,0 +1,185 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module SNS
+    class Resource
+
+      # @param options ({})
+      # @option options [Client] :client
+      def initialize(options = {})
+        @client = options[:client] || Client.new(options)
+      end
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   platformapplication = sns.create_platform_application({
+      #     name: "String", # required
+      #     platform: "String", # required
+      #     attributes: { # required
+      #       "String" => "String",
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :name
+      #   Application names must be made up of only uppercase and lowercase
+      #   ASCII letters, numbers, underscores, hyphens, and periods, and must be
+      #   between 1 and 256 characters long.
+      # @option options [required, String] :platform
+      #   The following platforms are supported: ADM (Amazon Device Messaging),
+      #   APNS (Apple Push Notification Service), APNS\_SANDBOX, and GCM (Google
+      #   Cloud Messaging).
+      # @option options [required, Hash<String,String>] :attributes
+      #   For a list of attributes, see [SetPlatformApplicationAttributes][1]
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html
+      # @return [PlatformApplication]
+      def create_platform_application(options = {})
+        resp = @client.create_platform_application(options)
+        PlatformApplication.new(
+          arn: resp.data.platform_application_arn,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic = sns.create_topic({
+      #     name: "topicName", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :name
+      #   The name of the topic you want to create.
+      #
+      #   Constraints: Topic names must be made up of only uppercase and
+      #   lowercase ASCII letters, numbers, underscores, and hyphens, and must
+      #   be between 1 and 256 characters long.
+      # @return [Topic]
+      def create_topic(options = {})
+        resp = @client.create_topic(options)
+        Topic.new(
+          arn: resp.data.topic_arn,
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @param [String] arn
+      # @return [PlatformApplication]
+      def platform_application(arn)
+        PlatformApplication.new(
+          arn: arn,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   platformapplications = sns.platform_applications()
+      # @param [Hash] options ({})
+      # @return [PlatformApplication::Collection]
+      def platform_applications(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_platform_applications(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.platform_applications.each do |p|
+              batch << PlatformApplication.new(
+                arn: p.platform_application_arn,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        PlatformApplication::Collection.new(batches)
+      end
+
+      # @param [String] arn
+      # @return [PlatformEndpoint]
+      def platform_endpoint(arn)
+        PlatformEndpoint.new(
+          arn: arn,
+          client: @client
+        )
+      end
+
+      # @param [String] arn
+      # @return [Subscription]
+      def subscription(arn)
+        Subscription.new(
+          arn: arn,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscriptions = sns.subscriptions()
+      # @param [Hash] options ({})
+      # @return [Subscription::Collection]
+      def subscriptions(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_subscriptions(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.subscriptions.each do |s|
+              batch << Subscription.new(
+                arn: s.subscription_arn,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        Subscription::Collection.new(batches)
+      end
+
+      # @param [String] arn
+      # @return [Topic]
+      def topic(arn)
+        Topic.new(
+          arn: arn,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topics = sns.topics()
+      # @param [Hash] options ({})
+      # @return [Topic::Collection]
+      def topics(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_topics(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.topics.each do |t|
+              batch << Topic.new(
+                arn: t.topic_arn,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        Topic::Collection.new(batches)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,149 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module SNS
+    class Subscription
+
+      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
+
+      # @return [String]
+      def arn
+        @arn
+      end
+
+      # A map of the subscription's attributes. Attributes in this map
+      # include the following:
+      #
+      # * `SubscriptionArn` -- the subscription's ARN
+      #
+      # * `TopicArn` -- the topic ARN that the subscription is associated with
+      #
+      # * `Owner` -- the AWS account ID of the subscription's owner
+      #
+      # * `ConfirmationWasAuthenticated` -- true if the subscription
+      #   confirmation request was authenticated
+      #
+      # * `DeliveryPolicy` -- the JSON serialization of the subscription's
+      #   delivery policy
+      #
+      # * `EffectiveDeliveryPolicy` -- the JSON serialization of the effective
+      #   delivery policy that takes into account the topic delivery policy
+      #   and account system defaults
+      # @return [Hash<String,String>]
+      def attributes
+        data.attributes
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Subscription}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     subscription.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_subscription_attributes(subscription_arn: @arn)
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GetSubscriptionAttributesResponse]
+      #   Returns the data for this {Subscription}. Calls
+      #   {Client#get_subscription_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
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscription.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(subscription_arn: @arn)
+        resp = @client.unsubscribe(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscription.set_attributes({
+      #     attribute_name: "attributeName", # required
+      #     attribute_value: "attributeValue",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :attribute_name
+      #   The name of the attribute you want to set. Only a subset of the
+      #   subscriptions attributes are mutable.
+      #
+      #   Valid values: `DeliveryPolicy` \| `RawMessageDelivery`
+      # @option options [String] :attribute_value
+      #   The new value for the attribute in JSON format.
+      # @return [EmptyStructure]
+      def set_attributes(options = {})
+        options = options.merge(subscription_arn: @arn)
+        resp = @client.set_subscription_attributes(options)
+        resp.data
+      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
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

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

@@ -0,0 +1,419 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module SNS
+    class Topic
+
+      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
+
+      # @return [String]
+      def arn
+        @arn
+      end
+
+      # A map of the topic's attributes. Attributes in this map include the
+      # following:
+      #
+      # * `TopicArn` -- the topic's ARN
+      #
+      # * `Owner` -- the AWS account ID of the topic's owner
+      #
+      # * `Policy` -- the JSON serialization of the topic's access control
+      #   policy
+      #
+      # * `DisplayName` -- the human-readable name used in the "From" field
+      #   for notifications to email and email-json endpoints
+      #
+      # * `SubscriptionsPending` -- the number of subscriptions pending
+      #   confirmation on this topic
+      #
+      # * `SubscriptionsConfirmed` -- the number of confirmed subscriptions on
+      #   this topic
+      #
+      # * `SubscriptionsDeleted` -- the number of deleted subscriptions on
+      #   this topic
+      #
+      # * `DeliveryPolicy` -- the JSON serialization of the topic's delivery
+      #   policy
+      #
+      # * `EffectiveDeliveryPolicy` -- the JSON serialization of the effective
+      #   delivery policy that takes into account system defaults
+      # @return [Hash<String,String>]
+      def attributes
+        data.attributes
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Topic}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     topic.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_topic_attributes(topic_arn: @arn)
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GetTopicAttributesResponse]
+      #   Returns the data for this {Topic}. Calls
+      #   {Client#get_topic_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
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic.add_permission({
+      #     label: "label", # required
+      #     aws_account_id: ["delegate"], # required
+      #     action_name: ["action"], # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :label
+      #   A unique identifier for the new policy statement.
+      # @option options [required, Array<String>] :aws_account_id
+      #   The AWS account IDs of the users (principals) who will be given access
+      #   to the specified actions. The users must have AWS accounts, but do not
+      #   need to be signed up for this service.
+      # @option options [required, Array<String>] :action_name
+      #   The action you want to allow for the specified principal(s).
+      #
+      #   Valid values: any Amazon SNS action name.
+      # @return [EmptyStructure]
+      def add_permission(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.add_permission(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscription = topic.confirm_subscription({
+      #     token: "token", # required
+      #     authenticate_on_unsubscribe: "authenticateOnUnsubscribe",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :token
+      #   Short-lived token sent to an endpoint during the `Subscribe` action.
+      # @option options [String] :authenticate_on_unsubscribe
+      #   Disallows unauthenticated unsubscribes of the subscription. If the
+      #   value of this parameter is `true` and the request has an AWS
+      #   signature, then only the topic owner and the subscription owner can
+      #   unsubscribe the endpoint. The unsubscribe action requires AWS
+      #   authentication.
+      # @return [Subscription]
+      def confirm_subscription(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.confirm_subscription(options)
+        Subscription.new(
+          arn: resp.data.subscription_arn,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.delete_topic(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic.publish({
+      #     target_arn: "String",
+      #     phone_number: "String",
+      #     message: "message", # required
+      #     subject: "subject",
+      #     message_structure: "messageStructure",
+      #     message_attributes: {
+      #       "String" => {
+      #         data_type: "String", # required
+      #         string_value: "String",
+      #         binary_value: "data",
+      #       },
+      #     },
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :target_arn
+      #   Either TopicArn or EndpointArn, but not both.
+      #
+      #   If you don't specify a value for the `TargetArn` parameter, you must
+      #   specify a value for the `PhoneNumber` or `TopicArn` parameters.
+      # @option options [String] :phone_number
+      #   The phone number to which you want to deliver an SMS message. Use
+      #   E.164 format.
+      #
+      #   If you don't specify a value for the `PhoneNumber` parameter, you
+      #   must specify a value for the `TargetArn` or `TopicArn` parameters.
+      # @option options [required, String] :message
+      #   The message you want to send to the topic.
+      #
+      #   If you want to send the same message to all transport protocols,
+      #   include the text of the message as a String value.
+      #
+      #   If you want to send different messages for each transport protocol,
+      #   set the value of the `MessageStructure` parameter to `json` and use a
+      #   JSON object for the `Message` parameter.
+      #
+      #   Constraints: Messages must be UTF-8 encoded strings at most 256 KB in
+      #   size (262144 bytes, not 262144 characters).
+      #
+      #   JSON-specific constraints:
+      #
+      #   * Keys in the JSON object that correspond to supported transport
+      #     protocols must have simple JSON string values.
+      #
+      #   * The values will be parsed (unescaped) before they are used in
+      #     outgoing messages.
+      #
+      #   * Outbound notifications are JSON encoded (meaning that the characters
+      #     will be reescaped for sending).
+      #
+      #   * Values have a minimum length of 0 (the empty string, "", is
+      #     allowed).
+      #
+      #   * Values have a maximum length bounded by the overall message size
+      #     (so, including multiple protocols may limit message sizes).
+      #
+      #   * Non-string values will cause the key to be ignored.
+      #
+      #   * Keys that do not correspond to supported transport protocols are
+      #     ignored.
+      #
+      #   * Duplicate keys are not allowed.
+      #
+      #   * Failure to parse or validate any key or value in the message will
+      #     cause the `Publish` call to return an error (no partial delivery).
+      # @option options [String] :subject
+      #   Optional parameter to be used as the "Subject" line when the message
+      #   is delivered to email endpoints. This field will also be included, if
+      #   present, in the standard JSON messages delivered to other endpoints.
+      #
+      #   Constraints: Subjects must be ASCII text that begins with a letter,
+      #   number, or punctuation mark; must not include line breaks or control
+      #   characters; and must be less than 100 characters long.
+      # @option options [String] :message_structure
+      #   Set `MessageStructure` to `json` if you want to send a different
+      #   message for each protocol. For example, using one publish action, you
+      #   can send a short message to your SMS subscribers and a longer message
+      #   to your email subscribers. If you set `MessageStructure` to `json`,
+      #   the value of the `Message` parameter must:
+      #
+      #   * be a syntactically valid JSON object; and
+      #
+      #   * contain at least a top-level JSON key of "default" with a value
+      #     that is a string.
+      #
+      #   You can define other top-level keys that define the message you want
+      #   to send to a specific transport protocol (e.g., "http").
+      #
+      #   For information about sending different messages for each protocol
+      #   using the AWS Management Console, go to [Create Different Messages for
+      #   Each Protocol][1] in the *Amazon Simple Notification Service Getting
+      #   Started Guide*.
+      #
+      #   Valid value: `json`
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol
+      # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
+      #   Message attributes for Publish action.
+      # @return [Types::PublishResponse]
+      def publish(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.publish(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic.remove_permission({
+      #     label: "label", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :label
+      #   The unique label of the statement you want to remove.
+      # @return [EmptyStructure]
+      def remove_permission(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.remove_permission(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   topic.set_attributes({
+      #     attribute_name: "attributeName", # required
+      #     attribute_value: "attributeValue",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :attribute_name
+      #   The name of the attribute you want to set. Only a subset of the
+      #   topic's attributes are mutable.
+      #
+      #   Valid values: `Policy` \| `DisplayName` \| `DeliveryPolicy`
+      # @option options [String] :attribute_value
+      #   The new value for the attribute.
+      # @return [EmptyStructure]
+      def set_attributes(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.set_topic_attributes(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscription = topic.subscribe({
+      #     protocol: "protocol", # required
+      #     endpoint: "endpoint",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :protocol
+      #   The protocol you want to use. Supported protocols include:
+      #
+      #   * `http` -- delivery of JSON-encoded message via HTTP POST
+      #
+      #   * `https` -- delivery of JSON-encoded message via HTTPS POST
+      #
+      #   * `email` -- delivery of message via SMTP
+      #
+      #   * `email-json` -- delivery of JSON-encoded message via SMTP
+      #
+      #   * `sms` -- delivery of message via SMS
+      #
+      #   * `sqs` -- delivery of JSON-encoded message to an Amazon SQS queue
+      #
+      #   * `application` -- delivery of JSON-encoded message to an EndpointArn
+      #     for a mobile app and device.
+      #
+      #   * `lambda` -- delivery of JSON-encoded message to an AWS Lambda
+      #     function.
+      # @option options [String] :endpoint
+      #   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 `https` protocol, the endpoint is a URL beginning with
+      #     "https://"
+      #
+      #   * For the `email` protocol, the endpoint is an email address
+      #
+      #   * For the `email-json` protocol, the endpoint is an email address
+      #
+      #   * For the `sms` protocol, the endpoint is a phone number of an
+      #     SMS-enabled device
+      #
+      #   * For the `sqs` protocol, the endpoint is the ARN of an Amazon SQS
+      #     queue
+      #
+      #   * For the `application` protocol, the endpoint is the EndpointArn of a
+      #     mobile app and device.
+      #
+      #   * For the `lambda` protocol, the endpoint is the ARN of an AWS Lambda
+      #     function.
+      # @return [Subscription]
+      def subscribe(options = {})
+        options = options.merge(topic_arn: @arn)
+        resp = @client.subscribe(options)
+        Subscription.new(
+          arn: resp.data.subscription_arn,
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @example Request syntax with placeholder values
+      #
+      #   subscriptions = topic.subscriptions()
+      # @param [Hash] options ({})
+      # @return [Subscription::Collection]
+      def subscriptions(options = {})
+        batches = Enumerator.new do |y|
+          options = options.merge(topic_arn: @arn)
+          resp = @client.list_subscriptions_by_topic(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.subscriptions.each do |s|
+              batch << Subscription.new(
+                arn: s.subscription_arn,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        Subscription::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
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end