aws-sdk 1.9.0 → 1.9.1

data/lib/aws/iam/server_certificate.rb

@@ -24,7 +24,7 @@ module AWS
 
       prefix_update_attributes
 
-      # @private
+      # @api private
       def initialize(name, opts={})
         opts[:name] = name
         super(opts)
@@ -117,7 +117,7 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       protected
       def resource_identifiers
         [[:server_certificate_name, name]]

data/lib/aws/iam/server_certificate_collection.rb

@@ -120,7 +120,7 @@ module AWS
         ServerCertificate.new(name, :config => config)
       end
 
-      # @private
+      # @api private
       protected
       def each_item response, &block
         response.server_certificate_metadata_list.each do |sc|

data/lib/aws/iam/signing_certificate.rb

@@ -137,7 +137,7 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       protected
       def resource_identifiers
         identifiers = []
@@ -150,14 +150,14 @@ module AWS
       # Also note, we do not page the response. This is because
       # restrictions on how many certificates an account / user may
       # have is fewer than one page of results.
-      # @private
+      # @api private
       protected
       def get_resource attribute
         options = user ? { :user_name => user.name } : {}
         client.list_signing_certificates(options)
       end
 
-      # @private
+      # @api private
       protected
       def matches_response_object? obj
         user_name = obj.respond_to?(:user_name) ? obj.user_name : nil

data/lib/aws/iam/signing_certificate_collection.rb

@@ -107,7 +107,7 @@ module AWS
         super(each_options, &block)
       end
 
-      # @private
+      # @api private
       protected
       def each_item response, &block
         response.certificates.each do |item|
@@ -120,7 +120,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def new_options
         user ? { :user => user } : { :config => config }

data/lib/aws/iam/user.rb

@@ -189,7 +189,7 @@ module AWS
         UserGroupCollection.new(self)
       end
 
-      # @private
+      # @api private
       protected
       def resource_identifiers
         [[:user_name, name]]

data/lib/aws/iam/user_collection.rb

@@ -115,7 +115,7 @@ module AWS
         super(options)
       end
 
-      # @private
+      # @api private
       protected
       def each_item response, &block
         response.users.each do |item|

data/lib/aws/iam/user_group_collection.rb

@@ -28,7 +28,7 @@ module AWS
       # @attr_reader [User] The user.
       attr_reader :user
 
-      # @private
+      # @api private
       def initialize(user, opts = {})
         @user = user
         super
@@ -77,13 +77,13 @@ module AWS
         super(options.merge(:user_name => user.name), &block)
       end
 
-      # @private
+      # @api private
       protected
       def request_method
         :list_groups_for_user
       end
 
-      # @private
+      # @api private
       protected
       def each_item response
         response.groups.each do |g|

data/lib/aws/iam/user_policy.rb

@@ -33,7 +33,7 @@ module AWS
       # @return [String] Returns the name of this user policy.
       attr_reader :name
 
-      # @private
+      # @api private
       module PolicyProxy
 
         attr_accessor :user_policy

data/lib/aws/iam/virtual_mfa_device.rb

@@ -32,7 +32,7 @@ module AWS
     #
     class VirtualMfaDevice < Resource
 
-      # @private
+      # @api private
       def initialize serial_number, options = {}
         @serial_number = serial_number
         super

data/lib/aws/import_export/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for AWS Import/Export.
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/import_export/request.rb

@@ -14,7 +14,7 @@
 module AWS
   class ImportExport
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
       include Core::Signature::Version2
     end

data/lib/aws/ops_works/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for AWS OpsWorks.
     class Client < Core::JSONClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/ops_works/request.rb

@@ -14,7 +14,7 @@
 module AWS
   class OpsWorks
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
       include Core::Signature::Version4
 

data/lib/aws/rails.rb

@@ -17,7 +17,7 @@ module AWS
 
   if Object.const_defined?(:Rails) and Rails.const_defined?(:Railtie)
 
-    # @private
+    # @api private
     class Railtie < Rails::Railtie
 
       # configure our plugin on boot. other extension points such
@@ -173,19 +173,19 @@ module AWS
       nil
     end
 
-    # @private
+    # @api private
     protected
     def self.rails_env
       ::Rails.respond_to?(:env) ? ::Rails.env : RAILS_ENV
     end
 
-    # @private
+    # @api private
     protected
     def self.rails_root
       ::Rails.respond_to?(:root) ? ::Rails.root.to_s : RAILS_ROOT
     end
 
-    # @private
+    # @api private
     protected
     def self.rails_logger
       ::Rails.respond_to?(:logger) ? ::Rails.logger : ::RAILS_DEFAULT_LOGGER

data/lib/aws/rds/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Amazon Relational Database Service (RDS).
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/rds/db_snapshot_collection.rb

@@ -17,7 +17,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @private
+      # @api private
       def initialize options = {}
         @filters = options[:filters] || {}
         super

data/lib/aws/rds/request.rb

@@ -14,7 +14,7 @@
 module AWS
   class RDS
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
       include Core::Signature::Version2
     end

data/lib/aws/record.rb

@@ -50,7 +50,7 @@ module AWS
     autoload :PresenceValidator, 'aws/record/validators/presence'
     autoload :Validator, 'aws/record/validator'
 
-    # @private
+    # @api private
     class RecordNotFound < StandardError; end
 
     # Sets a prefix to be applied to all SimpleDB domains associated with
@@ -113,7 +113,7 @@ module AWS
     #
     # @param [Object] value
     # @return [Array] The value cast into an array
-    # @private
+    # @api private
     def self.as_array value
       case value
       when nil   then []
@@ -130,7 +130,7 @@ module AWS
     #
     # @param [Object] value
     # @return [Set] The value cast into a Set.
-    # @private
+    # @api private
     def self.as_set value
       case value
       when Set then value

data/lib/aws/record/abstract_base.rb

@@ -448,7 +448,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def hydrate id, data
 
@@ -592,7 +592,7 @@ module AWS
           create_impl(attributes, :create!, :save!)
         end
 
-        # @private
+        # @api private
         def new_scope
           self::Scope.new(self)
         end
@@ -619,7 +619,7 @@ module AWS
           @attributes ||= {}
         end
 
-        # @private
+        # @api private
         def attribute_for attribute_name, &block
           unless attribute = attributes[attribute_name.to_s]
             raise UndefinedAttributeError.new(attribute_name.to_s)
@@ -627,7 +627,7 @@ module AWS
           block_given? ? yield(attribute) : attribute
         end
 
-        # @private
+        # @api private
         def add_attribute attribute
 
           attr_name = attribute.name

data/lib/aws/record/attributes.rb

@@ -91,7 +91,7 @@ module AWS
           raise NotImplementedError
         end
 
-        # @private
+        # @api private
         protected
         def self.expect klass, value, &block
           unless value.is_a?(klass)
@@ -143,7 +143,7 @@ module AWS
           string
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           true
         end
@@ -171,7 +171,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           false
         end
@@ -216,7 +216,7 @@ module AWS
           expect(Integer, integer) { integer }
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           true
         end
@@ -241,7 +241,7 @@ module AWS
           expect(Float, float) { float }
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           true
         end
@@ -308,7 +308,7 @@ module AWS
           date.strftime('%Y-%m-%d')
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           true
         end
@@ -373,7 +373,7 @@ module AWS
           datetime.strftime('%Y-%m-%dT%H:%M:%S%Z')
         end
 
-        # @private
+        # @api private
         def self.allow_set?
           true
         end

data/lib/aws/record/conversion.rb

@@ -14,20 +14,20 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     module Conversion
 
-      # @private
+      # @api private
       def to_model
         self
       end
 
-      # @private
+      # @api private
       def to_key
         persisted? ? [id] : nil
       end
 
-      # @private
+      # @api private
       def to_param
         persisted? ? to_key.join('-') : nil
       end

data/lib/aws/record/dirty_tracking.rb

@@ -140,7 +140,7 @@ module AWS
       #
       # @return [Boolean] Returns true if the named attribute
       #   has unsaved changes.
-      # @private
+      # @api private
       private
       def attribute_changed? attribute_name
         orig_values.keys.include?(attribute_name)
@@ -175,7 +175,7 @@ module AWS
       #   a change for.
       # @return [Boolean] Returns true if the named attribute
       #   has unsaved changes.
-      # @private
+      # @api private
       private
       def attribute_change attribute_name
         self.class.attribute_for(attribute_name) do |attribute|
@@ -209,7 +209,7 @@ module AWS
       #
       # @return Returns the previous value for changed attributes
       #   or the current value for unchanged attributes.
-      # @private
+      # @api private
       private
       def attribute_was attribute_name
         self.class.attribute_for(attribute_name) do |attribute|
@@ -221,7 +221,7 @@ module AWS
       # Reverts any changes to the attribute, restoring its original value.
       # @param [String] attribute_name Name of the attribute to reset.
       # @return [nil]
-      # @private
+      # @api private
       private
       def reset_attribute! attribute_name
         __send__("#{attribute_name}=", attribute_was(attribute_name))
@@ -233,7 +233,7 @@ module AWS
       # @param [String] attribute_name Name of the attribute that will
       #   be changed.
       # @return [nil]
-      # @private
+      # @api private
       private
       def attribute_will_change! attribute_name
         self.class.attribute_for(attribute_name) do |attribute|

data/lib/aws/record/exceptions.rb

@@ -15,7 +15,7 @@ module AWS
   module Record
 
     # Raised when trying to access an attribute that does not exist.
-    # @private
+    # @api private
     class UndefinedAttributeError < StandardError
       def initalize attribute_name
         super("undefined attribute `#{attribute_name}`")
@@ -24,7 +24,7 @@ module AWS
 
     # Raised when calling #save!, #create! or #update_attributes! on a record that
     # has validation errors.
-    # @private
+    # @api private
     class InvalidRecordError < StandardError
       def initialize record
         @record = record
@@ -35,7 +35,7 @@ module AWS
 
     # Raised when trying to persist a record that has no attribute values
     # to persist.
-    # @private
+    # @api private
     class EmptyRecordError < StandardError
       def initialize record
         @record = record