aws-sdk 1.9.0 → 1.9.1

data/.yardopts

@@ -1,6 +1,6 @@
---no-private
 --title 'AWS SDK for Ruby'
 --template-path doc-src/templates
 --markup markdown
--
+--no-api private
+lib/**/*.rb
 LICENSE.txt

data/lib/aws/auto_scaling/activity.rb

@@ -35,7 +35,7 @@ module AWS
     #
     class Activity < Core::Resource
 
-      # @private
+      # @api private
       def initialize activity_id, options = {}
         @activity_id = activity_id
         super

data/lib/aws/auto_scaling/activity_collection.rb

@@ -37,7 +37,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @private
+      # @api private
       def initialize options = {}
         @group = options[:group]
         if @group

data/lib/aws/auto_scaling/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Auto Scaling.
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :describe_adjustment_types,
         :describe_auto_scaling_groups,

data/lib/aws/auto_scaling/group_options.rb

@@ -16,7 +16,7 @@ module AWS
 
     # This mixin provides a method for parsing Auto Scaling group options
     # (for create and update methods).
-    # @private
+    # @api private
     module GroupOptions
 
       protected

data/lib/aws/auto_scaling/instance.rb

@@ -57,7 +57,7 @@ module AWS
     #
     class Instance < Core::Resource
 
-      # @private
+      # @api private
       def initialize instance_id, options = {}
         @instance_id = instance_id
         super

data/lib/aws/auto_scaling/launch_configuration.rb

@@ -44,7 +44,7 @@ module AWS
     #
     class LaunchConfiguration < Core::Resource
 
-      # @private
+      # @api private
       def initialize name, options = {}
         super(options.merge(:name => name))
       end

data/lib/aws/auto_scaling/notification_configuration.rb

@@ -15,7 +15,7 @@ module AWS
   class AutoScaling
     class NotificationConfiguration
 
-      # @private
+      # @api private
       def initialize auto_scaling_group, topic_arn, notification_types = []
         @group = auto_scaling_group
         @topic_arn = topic_arn
@@ -74,7 +74,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       def eql? other
         other.is_a?(NotificationConfiguration) and
         other.group == group and

data/lib/aws/auto_scaling/notification_configuration_collection.rb

@@ -48,7 +48,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @private
+      # @api private
       def initialize options = {}
         @group = options[:group]
         if @group

data/lib/aws/auto_scaling/request.rb

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

data/lib/aws/auto_scaling/scaling_policy.rb

@@ -32,7 +32,7 @@ module AWS
 
       include ScalingPolicyOptions
 
-      # @private
+      # @api private
       def initialize auto_scaling_group, policy_name, options = {}
         @group = auto_scaling_group
         @name = policy_name

data/lib/aws/auto_scaling/scaling_policy_options.rb

@@ -15,7 +15,7 @@ module AWS
   class AutoScaling
 
     # Provides a helper method for parsing scaling policy options.
-    # @private
+    # @api private
     module ScalingPolicyOptions
 
       protected

data/lib/aws/auto_scaling/scheduled_action.rb

@@ -34,7 +34,7 @@ module AWS
     #
     class ScheduledAction < Core::Resource
 
-      # @private
+      # @api private
       def initialize name, options = {}
         @name = name
         super

data/lib/aws/auto_scaling/scheduled_action_collection.rb

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

data/lib/aws/auto_scaling/tag.rb

@@ -21,7 +21,7 @@ module AWS
     #
     class Tag < Hash
 
-      # @private
+      # @api private
       def initialize options = {}
 
         super()

data/lib/aws/auto_scaling/tag_collection.rb

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

data/lib/aws/cloud_formation/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for AWS CloudFormation.
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :describe_adjustment_types,
         :describe_auto_scaling_groups,

data/lib/aws/cloud_formation/request.rb

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

data/lib/aws/cloud_formation/stack.rb

@@ -51,7 +51,7 @@ module AWS
 
       include StackOptions
 
-      # @private
+      # @api private
       def initialize name, options = {}
         @name = name
         super

data/lib/aws/cloud_formation/stack_collection.rb

@@ -18,7 +18,7 @@ module AWS
       include Core::Collection::WithNextToken
       include StackOptions
 
-      # @private
+      # @api private
       def initialize options = {}
         @status_filter = options[:status_filter]
         super

data/lib/aws/cloud_formation/stack_event.rb

@@ -24,7 +24,7 @@ module AWS
     #     end
     class StackEvent
 
-      # @private
+      # @api private
       def initialize stack, details
         @stack = stack
         details.each_pair do |attr_name,attr_value|

data/lib/aws/cloud_formation/stack_options.rb

@@ -15,7 +15,7 @@ module AWS
   class CloudFormation
 
     # This module provide option helpers for methods operation on stacks.
-    # @private
+    # @api private
     module StackOptions
 
       protected

data/lib/aws/cloud_formation/stack_output.rb

@@ -38,7 +38,7 @@ module AWS
       # @return [String]
       attr_reader :description
 
-      # @private
+      # @api private
       def eql? other
         other.is_a?(StackOutput) and
         other.stack == stack and

data/lib/aws/cloud_formation/stack_resource.rb

@@ -45,7 +45,7 @@ module AWS
     #
     class StackResource < Core::Resource
 
-      # @private
+      # @api private
       def initialize stack, logical_resource_id, options = {}
         @stack = stack
         @logical_resource_id = logical_resource_id

data/lib/aws/cloud_formation/stack_summary_collection.rb

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

data/lib/aws/cloud_front/client.rb

@@ -15,7 +15,7 @@ module AWS
   class CloudFront
     class Client < Core::RESTXMLClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/cloud_front/request.rb

@@ -16,7 +16,7 @@ require 'time'
 module AWS
   class CloudFront
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
 
       def add_authorization! credentials

data/lib/aws/cloud_search/client.rb

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

data/lib/aws/cloud_search/request.rb

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

data/lib/aws/cloud_watch/alarm.rb

@@ -69,7 +69,7 @@ module AWS
     #
     class Alarm < Core::Resource
 
-      # @private
+      # @api private
       def initialize alarm_name, options = {}
         @alarm_name = alarm_name
         super

data/lib/aws/cloud_watch/alarm_history_item.rb

@@ -15,7 +15,7 @@ module AWS
   class CloudWatch
     class AlarmHistoryItem
 
-      # @private
+      # @api private
       def initialize options
         @alarm_name = options[:alarm_name]
         @history_data = options[:history_data]

data/lib/aws/cloud_watch/alarm_history_item_collection.rb

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

data/lib/aws/cloud_watch/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Cloud Watch
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :describe_alarm_history,
         :describe_alarms,

data/lib/aws/cloud_watch/metric_alarm_collection.rb

@@ -45,7 +45,7 @@ module AWS
 
       include Core::Collection::Simple
 
-      # @private
+      # @api private
       def initialize metric, options = {}
         @metric = metric
         super(options.merge(:config => metric.config))

data/lib/aws/cloud_watch/metric_collection.rb

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

data/lib/aws/cloud_watch/request.rb

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

data/lib/aws/core.rb

@@ -82,7 +82,7 @@ require 'aws/version'
 #
 module AWS
 
-  # @private
+  # @api private
   SERVICES = {
     'AutoScaling' => 'auto_scaling',
     'CloudFormation' => 'cloud_formation',
@@ -114,7 +114,7 @@ module AWS
     'STS' => 'sts',
   }
 
-  # @private
+  # @api private
   ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 
   autoload :Errors, 'aws/errors'
@@ -209,7 +209,7 @@ module AWS
 
   class << self
 
-    # @private
+    # @api private
     @@config = nil
 
     # The global configuration for AWS.  Generally you set your preferred
@@ -555,7 +555,7 @@ module AWS
       end
     end
 
-    # @private
+    # @api private
     def resource_cache
       if memoizing?
         Thread.current[:aws_memoization][:resource_cache] ||=
@@ -563,7 +563,7 @@ module AWS
       end
     end
 
-    # @private
+    # @api private
     def response_cache
       if memoizing?
         Thread.current[:aws_memoization][:response_cache] ||=

data/lib/aws/core/cacheable.rb

@@ -14,23 +14,23 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     module Cacheable
 
-      # @private
+      # @api private
       class NoData < StandardError; end
 
       def self.included base
         base.extend Naming unless base.respond_to?(:service_ruby_name)
       end
 
-      # @private
+      # @api private
       protected
       def local_cache_key
         raise NotImplementedError
       end
 
-      # @private
+      # @api private
       protected
       def cache_key
         @cache_key ||= begin
@@ -41,7 +41,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       public
       def retrieve_attribute attr, &block
 

data/lib/aws/core/client.rb

@@ -29,7 +29,7 @@ module AWS
 
       extend Naming
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # Creates a new low-level client.
@@ -68,16 +68,16 @@ module AWS
 
       # @return [CredentialProviders::Provider] Returns the credential
       #   provider for this client.
-      # @private
+      # @api private
       attr_reader :credential_provider
 
       # @return [String] The snake-cased ruby name for the service
       #   (e.g. 's3', 'iam', 'dynamo_db', etc).
-      # @private
+      # @api private
       attr_reader :service_ruby_name
 
       # @return [Integer] What port this client makes requests via.
-      # @private
+      # @api private
       attr_reader :port
 
       # @return [Integer] The number of seconds before requests made by
@@ -86,7 +86,7 @@ module AWS
 
       # @return [String] Returns the service endpoint (hostname) this client
       #   makes requests against.
-      # @private
+      # @api private
       attr_reader :endpoint
 
       # @return (see Client.operations)
@@ -135,14 +135,14 @@ module AWS
       # @param [Configuration] config The configuration object to use.
       # @return [Core::Client] Returns a new client object with the given
       #   configuration.
-      # @private
+      # @api private
       def with_config config
         self.class.new(:config => config)
       end
 
       # The stub returned is memoized.
       # @see new_stub_for
-      # @private
+      # @api private
       def stub_for method_name
         @stubs ||= {}
         @stubs[method_name] ||= new_stub_for(method_name)
@@ -151,7 +151,7 @@ module AWS
       # Primarily used for testing, this method returns an empty pseudo
       # service response without making a request.  Its used primarily for
       # testing the lighter level service interfaces.
-      # @private
+      # @api private
       def new_stub_for method_name
         response = Response.new(Http::Request.new, Http::Response.new)
         response.request_type = method_name
@@ -574,12 +574,12 @@ module AWS
           @operations ||= []
         end
 
-        # @private
+        # @api private
         def request_builders
           @request_builders ||= {}
         end
 
-        # @private
+        # @api private
         def response_parsers
           @response_parsers ||= {}
         end
@@ -673,7 +673,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       class ClientRequestMethodBuilder
 
         def initialize client_class, method_name, &block