aws-sdk 1.3.4 → 1.3.5

data/lib/aws/core.rb

@@ -27,6 +27,7 @@ require 'aws/core/autoloader'
 # * {AWS::S3}
 # * {AWS::SimpleDB}
 # * {AWS::SimpleEmailService}
+# * {AWS::SimpleWorkflow}
 # * {AWS::SNS}
 # * {AWS::SQS}
 # * {AWS::STS}
@@ -58,7 +59,7 @@ require 'aws/core/autoloader'
 module AWS
 
   # Current version of the AWS SDK for Ruby
-  VERSION = "1.3.4"
+  VERSION = "1.3.5"
 
   register_autoloads(self) do
     autoload :Errors, 'errors'
@@ -159,13 +160,18 @@ module AWS
     # @option options [String] :access_key_id (nil) AWS access key id 
     #   credential.
     #
+    # @option options [String] :secret_access_key (nil) AWS secret access 
+    #   key credential.
+    #
+    # @option options [String,nil] :session_token (nil) AWS secret token 
+    #   credential.
+    #
     # @option options [String] :dynamo_db_endpoint ('dynamodb.amazonaws.com') The 
     #   service endpoint for Amazon DynamoDB.
     #
-    # @option options [String] :dynamo_db_retry_throughput_errors (false) When
+    # @option options [String] :dynamo_db_retry_throughput_errors (true) When
     #   true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException
-    #   errors will be retried.  You may need to increase the maximum number
-    #   of retries if you have a low provisioned throughput.
+    #   errors will be retried.
     #
     # @option options [String] :ec2_endpoint ('ec2.amazonaws.com') The 
     #   service endpoint for Amazon EC2.
@@ -227,12 +233,6 @@ module AWS
     #   * {S3::S3Object#presigned_post}
     #   * {S3::Bucket#presigned_post}
     #
-    # @option options [String] :secret_access_key (nil) AWS secret access 
-    #   key credential.
-    #
-    # @option options [String,nil] :session_token (nil) AWS secret token 
-    #   credential.
-    #
     # @option options [String] :simple_db_endpoint ('sdb.amazonaws.com') The
     #   service endpoint for Amazon SimpleDB.
     #
@@ -243,6 +243,9 @@ module AWS
     # @option options [String] :simple_email_service_endpoint ('email.us-east-1.amazonaws.com') 
     #   The service endpoint for Amazon Simple Email Service.
     #
+    # @option options [String] :simple_workflow_service ('swf.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon Simple Workflow Service.
+    #
     # @option options [Object] :signer (AWS::DefaultSigner) The request signer.  Defaults to
     #   a default request signer implementation.
     #
@@ -254,7 +257,8 @@ module AWS
     #   The AWS SDK for Ruby ships with a CA cert bundle, which is the
     #   default value for this option.
     #
-    # @option options [String] :ssl_ca_path The path the a CA cert directory.
+    # @option options [String] :ssl_ca_path (nil) 
+    #   The path the a CA cert directory.
     #
     # @option options [Boolean] :ssl_verify_peer (true) When +true+ 
     #   the HTTP handler validate server certificates for HTTPS requests.
@@ -285,6 +289,7 @@ module AWS
     #   for clients and applications built ontop of the aws-sdk gem.
     # 
     # @return [Core::Configuration] Returns the new configuration.
+    #
     def config options = {}
       @@config ||= Core::Configuration.new
       @@config = @@config.with(options) unless options.empty?

data/lib/aws/core/configuration.rb

@@ -55,41 +55,55 @@ module AWS
     #
     # The global default configuration can be found at {AWS.config}
     #
-    # @attr_reader [String,nil] access_key_id AWS access key id credential.
-    #   Defaults to +nil+.
+    # @attr_reader [String,nil] access_key_id (nil) 
+    #   AWS access key id credential.
     #
-    # @attr_reader [String] ec2_endpoint The service endpoint for Amazon EC2.
-    #   Defaults to 'ec2.amazonaws.com'.
+    # @attr_reader [String,nil] secret_access_key (nil)
+    #   AWS secret access key credential.
+    #
+    # @attr_reader [String,nil] session_token (nil) AWS secret token credential.
+    #
+    # @attr_reader [String] dynamo_db_endpoint ('dynamodb.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon DynamoDB.  
+    #
+    # @attr_reader [String] dynamo_db_retry_throughput_errors (true) When
+    #   true, AWS::DynamoDB::Errors::ProvisionedThroughputExceededException
+    #   errors will be retried.
+    #
+    # @attr_reader [String] ec2_endpoint ('ec2.amazonaws.com')
+    #   The service endpoint for Amazon EC2.
+    #
+    # @attr_reader [String] elb_endpoint ('elasticloadbalancing.us-east-1.amazonaws.com')
+    #   The service endpoint for Elastic Load Balancing. 
     #
     # @attr_reader [Object] http_handler The http handler that sends requests
     #   to AWS.  Defaults to an HTTP handler built on net/http.
     #
-    # @attr_reader [String] iam_endpoint The service endpoint for AWS Idenity
-    #   Access Management (IAM).  Defaults to 'iam.amazonaws.com'.
+    # @attr_reader [String] iam_endpoint ('iam.amazonaws.com')
+    #   The service endpoint for AWS Idenity Access Management (IAM).
     #
-    # @attr_reader [Object,nil] logger A logger instance that 
+    # @attr_reader [Object,nil] logger (nil) A logger instance that 
     #   should receive log messages generated by service requets.  
     #   A logger needs to respond to #log and must accept a 
     #   severity (e.g. :info, :error, etc) and a string message.
-    #   Defaults to +nil+.
     #
-    # @attr_reader [Integer] max_retries The maximum number of times
+    # @attr_reader [Integer] max_retries (3) The maximum number of times
     #   service errors (500) should be retried.  There is an exponential 
     #   backoff in between service request retries, so the more retries the
-    #   longer it can take to fail.  Defautls to 3.
+    #   longer it can take to fail.
     #
-    # @attr_reader [String, URI, nil] proxy_uri The URI of the proxy 
+    # @attr_reader [String, URI, nil] proxy_uri (nil) The URI of the proxy 
     #    to send service requests through.  You can pass a URI object or a 
     #    URI string.  Defautls to +nil+.
     #
     #      AWS.config(:proxy_uri => 'https://user:pass@my.proxy:443')
     #
-    # @attr_reader [String] s3_endpoint The service endpoint for Amazon S3.
-    #   Defaults to 's3.amazonaws.com'.
+    # @attr_reader [String] s3_endpoint ('s3.amazonaws.com')
+    #   The service endpoint for Amazon S3.
     #
-    # @attr_reader [Integer] s3_multipart_max_parts The maximum number of 
-    #   parts to split a file into when uploading in parts to S3.  
-    #   Defaults to 1000.
+    # @attr_reader [Integer] s3_multipart_max_parts (1000) 
+    #   The maximum number of parts to split a file into when uploading 
+    #   in parts to S3.
     #
     # @attr_reader [Integer] s3_multipart_threshold (16777216) When uploading
     #   data to S3, if the number of bytes to send exceedes 
@@ -98,9 +112,9 @@ module AWS
     #   is specified by +:s3_multipart_min_part_size+. Defaults to 
     #   16777216 (16MB).
     #
-    # @attr_reader [Integer] s3_multipart_min_part_size The absolute minimum
-    #   size (in bytes) each S3 multipart segment should be.
-    #   Defaults to 5242880 (5MB).
+    # @attr_reader [Integer] s3_multipart_min_part_size (5242880) 
+    #   The absolute minimum size (in bytes) each S3 multipart 
+    #   segment should be defaults to 5242880 (5MB).
     #
     # @attr_reader [Symbol] s3_server_side_encryption The algorithm to
     #   use when encrypting object data on the server side.  The only
@@ -122,26 +136,21 @@ module AWS
     #
     #     s3 = AWS::S3.new(:s3_server_side_encryption => :aes256)
     #
-    # @attr_reader [String,nil] secret_access_key AWS secret access key 
-    #   credential.  Defaults to +nil+.
-    #
-    # @attr_reader [String,nil] session_token AWS secret token credential.
-    #   Defaults to +nil+.
+    # @attr_reader [String] simple_db_endpoint ('sdb.amazonaws.com')
+    #   The service endpoint for Amazon SimpleDB.  
     #
-    # @attr_reader [String] simple_db_endpoint The service endpoint for Amazon
-    #   SimpleDB.  Defaults to 'sdb.amazonaws.com'.
-    #
-    # @attr_reader [Boolean] simple_db_consistent_reads Determines
+    # @attr_reader [Boolean] simple_db_consistent_reads (false) Determines
     #   if all SimpleDB read requests should be done consistently.
     #   Consistent reads are slower, but reflect all changes to SDB.
-    #   Defaults to +false+.
     #
-    # @attr_reader [String] simple_email_service_endpoint The service endpoint
-    #   for Amazon Simple Email Service.  Defaults to 
-    #   'email.us-east-1.amazonaws.com'.
+    # @attr_reader [String] simple_email_service_endpoint ('email.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon Simple Email Service.
+    #
+    # @attr_reader [String] simple_workflow_endpoint ('swf.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon Simple Workflow Service.
     #
-    # @attr_reader [Object] signer The request signer.  Defaults to
-    #   a default request signer implementation.
+    # @attr_reader [Object] signer 
+    #   The request signer. Defaults to a default request signer implementation.
     #
     # @attr_reader [String] ssl_ca_file The path to a CA cert bundle in 
     #   PEM format.
@@ -151,36 +160,36 @@ module AWS
     #   The AWS SDK for Ruby ships with a CA cert bundle, which is the
     #   default value for this option.
     #
-    # @attr_reader [Boolean] ssl_verify_peer When +true+ 
+    # @attr_reader [String] ssl_ca_path (nil) 
+    #   The path the a CA cert directory.
+    #
+    # @attr_reader [Boolean] ssl_verify_peer (true) When +true+ 
     #   the HTTP handler validate server certificates for HTTPS requests.
-    #   Defaults to +true+.
     #
     #   This option should only be disabled for diagnostic purposes;
     #   leaving this option set to +false+ exposes your application to
     #   man-in-the-middle attacks and can pose a serious security
     #   risk.
     #
-    # @attr_reader [Boolean] stub_requests When +true+ requests are not
+    # @attr_reader [Boolean] stub_requests (false) When +true+ requests are not
     #   sent to AWS, instead empty reponses are generated and returned to
     #   each service request.
     #
-    # @attr_reader [String] sns_endpoint The service endpoint for Amazon SNS.
-    #   Defaults to 'sns.us-east-1.amazonaws.com'.
+    # @attr_reader [String] sns_endpoint ('sns.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon SNS.
     #
-    # @attr_reader [String] sqs_endpoint The service endpoint for Amazon SQS.
-    #   Defaults to 'sqs.us-east-1.amazonaws.com'.
+    # @attr_reader [String] sqs_endpoint ('sqs.us-east-1.amazonaws.com')
+    #   The service endpoint for Amazon SQS.
     #
-    # @attr_reader [String] sts_endpoint The service endpoint for AWS
-    #   Security Token Service.  Defaults to 'sts.amazonaws.com'.
+    # @attr_reader [String] sts_endpoint ('sts.amazonaws.com')
+    #   The service endpoint for AWS Security Token Service.  
     #
-    # @attr_reader [Boolean] use_ssl When +true+, all requests
+    # @attr_reader [Boolean] use_ssl (true) When +true+, all requests
     #   to AWS are sent using HTTPS instead vanilla HTTP.
-    #   Defaults to +true+.
     #
-    # @attr_reader [String] user_agent_prefix A string prefix to 
+    # @attr_reader [String] user_agent_prefix (nil) A string prefix to 
     #   append to all requets against AWS services.  This should be set
     #   for clients and applications built ontop of the aws-sdk gem.
-    #   Defaults to +nil+.
     #
     class Configuration
   
@@ -199,6 +208,15 @@ module AWS
         end
   
       end
+
+      # @return [Hash] Returns a hash with your configured credentials.
+      def credentials
+        credentials = {}
+        credentials[:access_key_id] = access_key_id
+        credentials[:secret_access_key] = secret_access_key
+        credentials[:session_token] = session_token if session_token
+        credentials
+      end
   
       # Used to create a new Configuration object with the given modifications.
       # The current configuration object is not modified.

data/lib/aws/dynamo_db/item_collection.rb

@@ -465,9 +465,8 @@ module AWS
       # are filtered). A scan can result in no table data meeting the
       # filter criteria.
       #
-      # For more information about filtering the collection or
-      # limiting the results that are returned, see the {#where} and
-      # {#limit} methods.
+      # For more information about filtering the collection 
+      # see the {#where} method.
       #
       # @param [Hash] options Options for iterating the collection.
       #

data/lib/aws/dynamo_db/table.rb

@@ -30,8 +30,8 @@ module AWS
     # == Creating a Table
     #
     # To get started you can create a table by supplying a name
-    # and the read/write capacity.  A default schema of a hash_key
-    # ({:id => :string}) will be provided.
+    # and the read/write capacity.  A default schema with a hash_key
+    # of :id => :string will be provided.
     #
     #   dynamo_db = AWS::DynamoDB.new
     #   dynamo_db.tables.create('mytable', 10, 5)

data/lib/aws/ec2/collection.rb

@@ -14,13 +14,13 @@
 module AWS
   class EC2
 
-    # @private
     class Collection
 
       include Core::Model
       include Enumerable
       include FilteredCollection
 
+      # @param [String] id Returns the collection member with the given id.
       def [] id
         member_class.new(id.to_s, :config => config)
       end

data/lib/aws/ec2/snapshot_collection.rb

@@ -42,7 +42,7 @@ module AWS
         super(options)
       end
 
-      # @yield [Instance] Yields each volume in the collection.
+      # @yield [Snapshot] Yields each snapshot in the collection.
       # @return [nil]
       def each(&block)
         opts = {}

data/lib/aws/ec2/tagged_collection.rb

@@ -14,7 +14,12 @@
 module AWS
   class EC2
 
-    # @private
+    # Most of the AWS::EC2 collections include TaggedCollection.  This 
+    # module provides methods for filtering the collection with
+    # tags.
+    #
+    #   collecion.tagged('prod').each do {|obj| ... }
+    #
     module TaggedCollection
 
       # Filter the collection by one or more tag keys.  If you pass multiple

data/lib/aws/elb/backend_server_policy_collection.rb

@@ -30,17 +30,7 @@ module AWS
     #   public_key1 = <<-KEY
     #   -----BEGIN CERTIFICATE-----
     #   MIICaTCCAdICCQDuvCF4erLGSjANBgkqhkiG9w0BAQUFADB5MQswCQYDVQQGEwJa
-    #   WjENMAsGA1UECBMERkFLRTENMAsGA1UEBxMERkFLRTENMAsGA1UEChMERkFLRTEN
-    #   MAsGA1UECxMERkFLRTENMAsGA1UEAxMERkFLRTEfMB0GCSqGSIb3DQEJARYQZmFr
-    #   ZUBleGFtcGxlLmNvbTAeFw0xMTA4MTAyMjE0NDVaFw0xMjA4MDkyMjE0NDVaMHkx
-    #   CzAJBgNVBAYTAlpaMQ0wCwYDVQQIEwRGQUtFMQ0wCwYDVQQHEwRGQUtFMQ0wCwYD
-    #   VQQKEwRGQUtFMQ0wCwYDVQQLEwRGQUtFMQ0wCwYDVQQDEwRGQUtFMR8wHQYJKoZI
-    #   hvcNAQkBFhBmYWtlQGV4YW1wbGUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
-    #   iQKBgQC4vy7K2LCgYJs7AbxdanPEwL4KLC9gi1LqzkRWShEaz8COUZswcOkevLQy
-    #   SMFTXAvmH1FVqNO97wVG6ydxi+LNE7Jub62QQnsK420y+nXRTytxrboH1eAiAIEt
-    #   ZoUKaOymfAN8l/MJbcPH0rTYNdni99B+UMPWmFeRg/BeWiy2hwIDAQABMA0GCSqG
-    #   SIb3DQEBBQUAA4GBAD+VNA6ia8TXa2lJgvmoGYCLGcCaccz7Nv/u4/oqv8qMPvdZ
-    #   5DZxDLIExOSHiFGwWg5m8NgcirH2diveyRBgNhgC6S6DntkEMvAV0yvaQgHtUO53
+    #   ....
     #   o50MymfqtoVcebZcXbiDVAXW1cPEHKLBXecX6/LZ+GOzEsUOxgt7Xs9uabqp
     #   -----END CERTIFICATE-----
     #   KEY

data/lib/aws/elb/load_balancer.rb

@@ -205,17 +205,17 @@ module AWS
 
       # Generally you don't need to call this method, rather you can
       # just pass the load balancer as a source to the various
-      # authorize and revoke methods of {SecurityGroup}:
+      # authorize and revoke methods of {EC2::SecurityGroup}:
       #
       #   security_group.authorize_ingress(load_balancer)
       #
       #   security_group.revoke_ingress(load_balancer)
       #
       # @return [Hash] Returns a hash that can be passed to the following
-      #   {SecurityGroup} methods as a source:
+      #   {EC2::SecurityGroup} methods as a source:
       #
-      #   * {SecurityGroup#authorize_ingress}
-      #   * {SecurityGroup#authorize_egress}
+      #   * {EC2::SecurityGroup#authorize_ingress}
+      #   * {EC2::SecurityGroup#authorize_egress}
       #
       def source_security_group
         { 

data/lib/aws/elb/load_balancer_collection.rb

@@ -44,7 +44,7 @@ module AWS
       #
       # @option options [required,Array] :availability_zones An array of
       #   one or more availability zones.  Values may be availability zone
-      #   name strings, or {AWS::EC2::AvabilityZone} objects.
+      #   name strings, or {AWS::EC2::AvailabilityZone} objects.
       #
       # @option options [required,Array] :listeners An array of load balancer
       #   listener options.  Each value must be an array with the following

data/lib/aws/iam/policy.rb

@@ -14,7 +14,7 @@
 module AWS
   class IAM
 
-    # @private
+    # (see AWS::Core::Policy)
     class Policy < Core::Policy
 
       def to_h

data/lib/aws/record.rb

@@ -33,13 +33,16 @@ module AWS
     #   AWS::Record.domain_prefix = 'production_'
     #
     #   class Product < AWS::Record::Base
-    #     set_domain_name 'products'
+    #     set_shard_name 'products'
     #   end
     #
-    #   Product.domain_name #=> 'production_products'
+    #   p = Product.new
+    #   p.shard #=> 'products'
+    #   p.save # the product is persisted to the 'production-products' domain
     #
     # @param [String] A prefix to append to all domains.  This is useful for
     #   grouping domains used by one application with a single prefix.
+    #
     def self.domain_prefix= prefix
       @domain_prefix = prefix
     end
@@ -56,14 +59,17 @@ module AWS
     #   AWS::Record.table_prefix = 'production_'
     #
     #   class Product < AWS::Record::HashModel
-    #     set_table_name 'products'
+    #     set_shard_name 'products'
     #   end
     #
-    #   Product.table_name #=> 'production_products'
+    #   p = Product.new
+    #   p.shard #=> 'products'
+    #   p.save # the product is persisted to the 'production-products' table
     #
     # @param [String] A prefix to append to all tables.  This is
     #   useful for grouping tables used by one application with a
     #   single prefix.
+    #
     def self.table_prefix= prefix
       @table_prefix = prefix
     end

data/lib/aws/record/hash_model/finder_methods.rb

@@ -98,8 +98,7 @@ module AWS
         #   end
         #
         # This method is equivalent to +find(:all)+, and therefore you can also
-        # pass aditional options.  See {#find} for more information on what 
-        # options you can pass.
+        # pass aditional options.
         #
         #   Book.all(:where => { :author' => 'me' }).each do |my_book|
         #     # ...
@@ -143,7 +142,7 @@ module AWS
         # 
         # @return [Integer] The count of records in the table.
         #
-        def count
+        def count options = {}
           new_scope.count(options)
         end
         alias_method :size, :count