aws-sdk 1.9.0 → 1.9.1

data/lib/aws/core/resource_cache.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     class ResourceCache
 
       def initialize

data/lib/aws/core/response.rb

@@ -63,7 +63,7 @@ module AWS
       # @return [Hash] Returns the response data as a hash.
       attr_accessor :data
 
-      # @private
+      # @api private
       attr_accessor :config
 
       # @return [Symbol] The name of the client request method that
@@ -132,13 +132,13 @@ module AWS
       end
 
       # @return [String]
-      # @private
+      # @api private
       def inspect
         data.inspect
       end
 
       # @return [String]
-      # @private
+      # @api private
       def cache_key
         [
           http_request.access_key_id,
@@ -151,7 +151,7 @@ module AWS
       # Rebuilds the HTTP request using the block passed to the initializer.
       # This is primarily used by the client when a request must be retried
       # (throttling, server errors, socket errors, etc).
-      # @private
+      # @api private
       def rebuild_request
         build_request
         @http_request.body_stream.rewind if @http_request.body_stream

data/lib/aws/core/response_cache.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     class ResponseCache
 
       attr_reader :cached_responses

data/lib/aws/core/rest_error_parser.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     module RESTErrorParser
 
 

data/lib/aws/core/rest_request_builder.rb

@@ -18,7 +18,7 @@ module AWS
     # populate a Core::Http::Request object.
     class RESTRequestBuilder
 
-      # @private
+      # @api private
       def initialize operation, options = {}
 
         @http = operation[:http]

data/lib/aws/core/rest_response_parser.rb

@@ -18,7 +18,7 @@ module AWS
     # populate a Core::Http::Request object.
     class RESTResponseParser
 
-      # @private
+      # @api private
       def initialize operation, options
         @http = operation[:http]
         @parser =

data/lib/aws/core/service_interface.rb

@@ -29,7 +29,7 @@ module AWS
 
         AWS::Core::MetaUtils.extend(base) do
 
-          # @private
+          # @api private
           def endpoint_prefix prefix = nil, options = {}
             if prefix
               @endpoint_prefix = prefix
@@ -38,7 +38,7 @@ module AWS
             @endpoint_prefix
           end
 
-          # @private
+          # @api private
           def global_endpoint?
             @global_endpoint
           end

data/lib/aws/core/xml/frame_stack.rb

@@ -15,7 +15,7 @@ module AWS
   module Core
     module XML
 
-      # @private
+      # @api private
       module FrameStack
 
         # @param [Hash] rules A hash of parser rules.  These

data/lib/aws/data_pipeline/client.rb

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

data/lib/aws/data_pipeline/request.rb

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

data/lib/aws/direct_connect/client.rb

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

data/lib/aws/direct_connect/errors.rb

@@ -14,7 +14,7 @@
 
 module AWS
   class DirectConnect
-    # @private
+    # @api private
     module Errors
       extend Core::LazyErrorClasses
     end

data/lib/aws/direct_connect/request.rb

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

data/lib/aws/dynamo_db/attribute_collection.rb

@@ -71,7 +71,7 @@ module AWS
       # @return [Item] The item to which these attributes belong.
       attr_reader :item
 
-      # @private
+      # @api private
       def initialize(item, opts = {})
         @item = item
         super
@@ -228,12 +228,12 @@ module AWS
       # {AttributeCollection#update} for more information.
       class UpdateBuilder
 
-        # @private
+        # @api private
         attr_reader :updates
 
         include Types
 
-        # @private
+        # @api private
         def initialize
           @updates = {}
         end

data/lib/aws/dynamo_db/item.rb

@@ -44,7 +44,7 @@ module AWS
       #   item, or `nil` if the table has a simple primary key.
       attr_reader :range_value
 
-      # @private
+      # @api private
       def initialize(table, *args)
         opts = args.pop if args.last.kind_of?(Hash)
         (@hash_value, @range_value) = args
@@ -100,7 +100,7 @@ module AWS
         AttributeCollection.new(self)
       end
 
-      # @private
+      # @api private
       def self.new_from(op, response_object, table, *args)
 
         config = args.last.is_a?(Hash) ? args.last : AWS.config

data/lib/aws/dynamo_db/item_collection.rb

@@ -92,7 +92,7 @@ module AWS
       include Types
       include Expectations
 
-      # @private
+      # @api private
       def initialize(table, opts = {})
         @table = table
         @scan_filters = opts[:scan_filters] || {}
@@ -103,7 +103,7 @@ module AWS
       #   belong.
       attr_reader :table
 
-      # @private
+      # @api private
       attr_reader :scan_filters
 
       # Creates a new item, or replaces an old item with a new item
@@ -259,7 +259,7 @@ module AWS
 
         attr_reader :attribute
 
-        # @private
+        # @api private
         def initialize(items, attribute)
           @items = items
           @attribute = attribute
@@ -744,7 +744,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       def with_filter attribute, op, *values
 
         values = values.map {|value| format_attribute_value(value) }
@@ -762,7 +762,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       def refine(opts)
         opts = {
           :scan_filters => scan_filters

data/lib/aws/dynamo_db/keys.rb

@@ -14,7 +14,7 @@
 module AWS
   class DynamoDB
 
-    # @private
+    # @api private
     module Keys
 
       include Types

data/lib/aws/dynamo_db/request.rb

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

data/lib/aws/dynamo_db/resource.rb

@@ -15,7 +15,7 @@ module AWS
   class DynamoDB
     class Resource < Core::Resource
 
-      # @private
+      # @api private
       def self.attribute name, options = {}
 
         # DynamoDB attributes are all returned in UpperCamelCase, this

data/lib/aws/dynamo_db/table.rb

@@ -90,7 +90,7 @@ module AWS
     #
     class Table < Resource
 
-      # @private
+      # @api private
       def initialize name, options = {}
         @name = name
         super

data/lib/aws/dynamo_db/table_collection.rb

@@ -111,7 +111,7 @@ module AWS
         Table.new(name, :config => config)
       end
 
-      # @private
+      # @api private
       protected
       def _each_item next_token, limit, options = {}, &block
 

data/lib/aws/dynamo_db/types.rb

@@ -18,7 +18,7 @@ require 'base64'
 module AWS
   class DynamoDB
 
-    # @private
+    # @api private
     module Types
 
       def value_from_response(hash, options = {})

data/lib/aws/ec2/attachment.rb

@@ -30,7 +30,7 @@ module AWS
     #   volume.delete
     class Attachment < Resource
 
-      # @private
+      # @api private
       def initialize volume, instance, device, options = {}
         @volume = volume
         @instance = instance

data/lib/aws/ec2/attachment_collection.rb

@@ -25,7 +25,7 @@ module AWS
 
       attr_reader :volume
 
-      # @private
+      # @api private
       def initialize volume, options = {}
         @volume = volume
         super

data/lib/aws/ec2/availability_zone_collection.rb

@@ -31,7 +31,7 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       protected
       def member_class
         AvailabilityZone

data/lib/aws/ec2/block_device_mappings.rb

@@ -14,10 +14,10 @@
 module AWS
   class EC2
 
-    # @private
+    # @api private
     module BlockDeviceMappings
 
-      # @private
+      # @api private
       private
       def translate_block_device_mappings(mapping)
         raise ArgumentError.new("block_device_mappings must be a hash") unless

data/lib/aws/ec2/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Amazon Elastic Compute Cloud (EC2).
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :describe_addresses,
         :describe_availability_zones,

data/lib/aws/ec2/config_transform.rb

@@ -3,7 +3,7 @@
 module AWS
   class EC2
 
-    # @private
+    # @api private
     class ConfigTransform
 
       class << self

data/lib/aws/ec2/customer_gateway.rb

@@ -30,7 +30,7 @@ module AWS
 
       include TaggedItem
 
-      # @private
+      # @api private
       def initialize customer_gateway_id, options = {}
         @customer_gateway_id = customer_gateway_id
         super

data/lib/aws/ec2/dhcp_options.rb

@@ -18,7 +18,7 @@ module AWS
 
       include TaggedItem
 
-      # @private
+      # @api private
       def initialize dhcp_options_id, options = {}
         @dhcp_options_id = dhcp_options_id
         super

data/lib/aws/ec2/elastic_ip.rb

@@ -179,25 +179,25 @@ module AWS
         public_ip.to_s
       end
 
-      # @private
+      # @api private
       protected
       def resource_id_method
         :public_ip
       end
 
-      # @private
+      # @api private
       protected
       def response_id_method
         :public_ip
       end
 
-      # @private
+      # @api private
       protected
       def describe_call_name
         :describe_addresses
       end
 
-      # @private
+      # @api private
       protected
       def self.describe_call_name
         :describe_addresses

data/lib/aws/ec2/errors.rb

@@ -15,7 +15,7 @@ module AWS
   class EC2
     module Errors
 
-      # @private
+      # @api private
       GRAMMAR = Core::XML::Grammar.customize do
         element "Errors" do
           ignore

data/lib/aws/ec2/export_task.rb

@@ -42,7 +42,7 @@ module AWS
     #
     class ExportTask < Resource
 
-      # @private
+      # @api private
       def initialize export_task_id, options = {}
         @export_task_id = export_task_id
         super

data/lib/aws/ec2/filtered_collection.rb

@@ -38,7 +38,7 @@ module AWS
         collection_with(:filters => filters)
       end
 
-      # @private
+      # @api private
       def filtered_request client_method, options = {}, &block
         options[:filters] = @filters unless @filters.empty?
         client.send(client_method, options)
@@ -70,13 +70,13 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       protected
       def preserved_options
         { :config => config, :filters => @filters }
       end
 
-      # @private
+      # @api private
       protected
       def collection_with(options = {})
         self.class.new(preserved_options.merge(options))