aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_workflow/workflow_type.rb

@@ -16,18 +16,18 @@ require 'uuidtools'
 module AWS
   class SimpleWorkflow
 
-    # == Registering a WorkflowType
+    # ## Registering a WorkflowType
     #
     # To register a workflow type you should use the #workflow_types method
     # on the domain:
     #
-    #   domain.workflow_types.register('name', 'version', { ... })
+    #     domain.workflow_types.register('name', 'version', { ... })
     #
     # See {WorkflowTypeCollection#register} for a complete list of options.
     #
-    # == Deprecating a workflow type
+    # ## Deprecating a workflow type
     #
-    # WorkflowType inherits from the generic {Type} base class.  Defined in 
+    # WorkflowType inherits from the generic {Type} base class.  Defined in
     # {Type} are a few useful methods including:
     #
     # * {Type#deprecate}
@@ -35,7 +35,7 @@ module AWS
     #
     # You can use these to deprecate a workflow type:
     #
-    #   domain.workflow_types['name','version'].deprecate
+    #     domain.workflow_types['name','version'].deprecate
     #
     # @attr_reader [Time] creation_date When the workflow type was registered.
     #
@@ -46,38 +46,38 @@ module AWS
     #   type, or nil if was not set when it was registered.
     #
     # @attr_reader [Symbol] status The status of this workflow type.  The
-    #   status will either be +:registered+ or +:deprecated+.
-    # 
+    #   status will either be `:registered` or `:deprecated`.
+    #
     # @attr_reader [Symbol,nil] default_child_policy Specifies the default
-    #   policy to use for the child workflow executions when a workflow 
+    #   policy to use for the child workflow executions when a workflow
     #   execution of this type is terminated.  Values may be one of the
     #   following (or nil):
     #
-    #   * +:terminate+ - the child executions will be terminated.
+    #   * `:terminate` - the child executions will be terminated.
     #
-    #   * +:request_cancel+ - a request to cancel will be attempted for each
-    #     child execution by recording a WorkflowExecutionCancelRequested 
+    #   * `:request_cancel` - a request to cancel will be attempted for each
+    #     child execution by recording a WorkflowExecutionCancelRequested
     #     event in its history. It is up to the decider to take appropriate
     #     actions when it receives an execution history with this event.
     #
-    #   * +:abandon+ - no action will be taken. The child executions will 
+    #   * `:abandon` - no action will be taken. The child executions will
     #     continue to run.
     #
     # @attr_reader [Integer,:none,nil] default_execution_start_to_close_timeout
     #   The default maximum duration for executions of this workflow type.
     #
     #   The return value may be an integer (number of seconds), the
-    #   symbol +:none+ (implying no timeout) or +nil+ (not specified).
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
     #
-    # @attr_reader [String,nil] default_task_list Specifies 
-    #   the default task list to use for scheduling decision tasks for 
+    # @attr_reader [String,nil] default_task_list Specifies
+    #   the default task list to use for scheduling decision tasks for
     #   executions of this workflow type.
     #
     # @attr_reader [Integer,:none,nil] default_task_start_to_close_timeout
     #   The default maximum duration of decision tasks for this workflow type.
     #
     #   The return value may be an integer (number of seconds), the
-    #   symbol +:none+ (implying no timeout) or +nil+ (not specified).
+    #   symbol `:none` (implying no timeout) or `nil` (not specified).
     #
     class WorkflowType < Type
 
@@ -106,21 +106,21 @@ module AWS
       # @param [Hash] options
       #
       # @option (see DecisionTask#continue_as_new_workflow_execution)
-      # 
+      #
       # @option options [String] :workflow_id
       #   A user defined identifier associated with the workflow execution.
-      #   You can use this to associate a custom identifier with the 
-      #   workflow execution. You may specify the same identifier if a 
-      #   workflow execution is logically a restart of a previous execution. 
-      #   You cannot have two open workflow executions with the same 
+      #   You can use this to associate a custom identifier with the
+      #   workflow execution. You may specify the same identifier if a
+      #   workflow execution is logically a restart of a previous execution.
+      #   You cannot have two open workflow executions with the same
       #   :workflow_id at the same time.
       #
-      #   If you do not provide +:workflow_id+ a random UUID will be generated.
+      #   If you do not provide `:workflow_id` a random UUID will be generated.
       #
       # @return [WorkflowExecution] Returns the new workflow execution.
       #
       def start_execution options = {}
-        
+
         options[:domain] = domain.name
         start_execution_opts(options, self)
         response = client.start_workflow_execution(options)
@@ -134,8 +134,10 @@ module AWS
 
       # Returns a count of workflow executions of this workflow type.
       #
+      # @example
+      #
       #   domain.workflow_types['name','version'].count
-      # 
+      #
       # @note (see WorkflowExecution#count_executions)
       # @param (see WorkflowExecution#count_executions)
       # @option (see WorkflowExecution#count_executions)
@@ -155,7 +157,7 @@ module AWS
       provider(:list_workflow_types) do |provider|
         provider.provides *type_attributes.keys
         provider.find do |resp|
-          desc = resp.data['typeInfos'].find do |info|  
+          desc = resp.data['typeInfos'].find do |info|
             info[self.class.type_key] == { 'name' => name, 'version' => version }
           end
         end

data/lib/aws/simple_workflow/workflow_type_collection.rb

@@ -16,53 +16,53 @@ module AWS
 
     class WorkflowTypeCollection < TypeCollection
 
-      # Registers a new workflow type and its configuration settings for 
+      # Registers a new workflow type and its configuration settings for
       # in the current domain.
-      # 
+      #
       # @param [String] name The name of the workflow type.
       #
       # @param [String] version The version of the workflow type.
-      #   The workflow type consists of the name and version, the 
-      #   combination of which must be unique within the domain. 
+      #   The workflow type consists of the name and version, the
+      #   combination of which must be unique within the domain.
       #
       # @param [Hash] options
-      # 
+      #
       # @option options [Symbol] :default_child_policy (nil) Specifies the default
-      #   policy to use for the child workflow executions when a workflow 
-      #   execution of this type is terminated.  This default can be 
+      #   policy to use for the child workflow executions when a workflow
+      #   execution of this type is terminated.  This default can be
       #   overridden when starting a workflow execution. The supported child
       #   policies are:
       #
-      #   * +:terminate+ - the child executions will be terminated.
+      #   * `:terminate` - the child executions will be terminated.
       #
-      #   * +:request_cancel+ - a request to cancel will be attempted for each
-      #     child execution by recording a WorkflowExecutionCancelRequested 
+      #   * `:request_cancel` - a request to cancel will be attempted for each
+      #     child execution by recording a WorkflowExecutionCancelRequested
       #     event in its history. It is up to the decider to take appropriate
       #     actions when it receives an execution history with this event.
       #
-      #   * +:abandon+ - no action will be taken. The child executions will 
+      #   * `:abandon` - no action will be taken. The child executions will
       #     continue to run.
       #
       # @option options [Integer,:none] :default_execution_start_to_close_timeout (nil)
       #   The default maximum duration for executions of this workflow type.
-      #   You can override this default when starting an execution.  
+      #   You can override this default when starting an execution.
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
-      # @option options [String] :default_task_list (nil) Specifies 
-      #   the default task list to use for scheduling decision tasks for 
-      #   executions of this workflow type. This default is used only if 
+      # @option options [String] :default_task_list (nil) Specifies
+      #   the default task list to use for scheduling decision tasks for
+      #   executions of this workflow type. This default is used only if
       #   a task list is not provided when starting the workflow execution.
       #
       # @option options [Integer,:none] :default_task_start_to_close_timeout (nil)
       #   The default maximum duration of decision tasks for this workflow type.
       #
       #   The value should be a number of seconds (integer) or the symbol
-      #   +:none+ (implying no timeout).
+      #   `:none` (implying no timeout).
       #
       # @option options [String] :description (nil) Textual description of
       #   the workflow type.
-      #   
+      #
       def register name, version, options = {}
 
         options[:domain] = domain.name
@@ -71,7 +71,7 @@ module AWS
 
         upcase_opts(options, :default_child_policy)
 
-        duration_opts(options, 
+        duration_opts(options,
           :default_execution_start_to_close_timeout,
           :default_task_start_to_close_timeout)
 
@@ -82,7 +82,7 @@ module AWS
         client.register_workflow_type(options)
 
         self[name, version]
-        
+
       end
       alias_method :create, :register
 

data/lib/aws/sns.rb

@@ -16,50 +16,50 @@ require 'aws/sns/config'
 
 module AWS
 
-  # This class is the starting point for working with Amazon Simple 
+  # This class is the starting point for working with Amazon Simple
   # Notification Service (SNS).
   #
-  # To use Amazon SNS you must first {sign up here}[http://aws.amazon.com/sns/].
+  # To use Amazon SNS you must first [sign up here](http://aws.amazon.com/sns/).
   #
   # For more information about Amazon SNS:
   #
-  # * {Amazon SNS}[http://aws.amazon.com/sns/]
-  # * {Amazon SNS Documentation}[http://aws.amazon.com/documentation/sns/]
+  # * [Amazon SNS](http://aws.amazon.com/sns/)
+  # * [Amazon SNS Documentation](http://aws.amazon.com/documentation/sns/)
   #
-  # = Credentials
+  # # Credentials
   #
-  # You can setup default credentials for all AWS services via 
+  # You can setup default credentials for all AWS services via
   # AWS.config:
   #
-  #   AWS.config(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
-  # 
+  #     AWS.config(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
   # Or you can set them directly on the SNS interface:
   #
-  #   sns = AWS::SNS.new(
-  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
-  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #     sns = AWS::SNS.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
   #
   # @!attribute [r] client
   #   @return [Client] the low-level SNS client object
   class SNS
 
-    AWS.register_autoloads(self) do
-      autoload :Client,                      'client'
-      autoload :Errors,                      'errors'
-      autoload :Policy,                      'policy'
-      autoload :HasDeliveryPolicy,           'has_delivery_policy'
-      autoload :Request,                     'request'
-      autoload :Subscription,                'subscription'
-      autoload :SubscriptionCollection,      'subscription_collection'
-      autoload :Topic,                       'topic'
-      autoload :TopicCollection,             'topic_collection'
-      autoload :TopicSubscriptionCollection, 'topic_subscription_collection'
-    end
+    autoload :Client, 'aws/sns/client'
+    autoload :Errors, 'aws/sns/errors'
+    autoload :Policy, 'aws/sns/policy'
+    autoload :HasDeliveryPolicy, 'aws/sns/has_delivery_policy'
+    autoload :Request, 'aws/sns/request'
+    autoload :Subscription, 'aws/sns/subscription'
+    autoload :SubscriptionCollection, 'aws/sns/subscription_collection'
+    autoload :Topic, 'aws/sns/topic'
+    autoload :TopicCollection, 'aws/sns/topic_collection'
+    autoload :TopicSubscriptionCollection, 'aws/sns/topic_subscription_collection'
 
     include Core::ServiceInterface
 
+    endpoint_prefix 'sns'
+
     # @return [TopicCollection] Returns a topic collection for managing
     #   SNS topics.
     def topics

data/lib/aws/sns/client.rb

@@ -25,15 +25,15 @@ module AWS
       # @!method add_permission(options = {})
       # Calls the AddPermission API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic whose
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic whose
       #     access control policy you wish to modify.
-      #   * +:label+ - *required* - (String) A unique identifier for the new
+      #   * `:label` - *required* - (String) A unique identifier for the new
       #     policy statement.
-      #   * +:aws_account_id+ - *required* - (Array<String>) The AWS account
+      #   * `:aws_account_id` - *required* - (Array<String>) 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.
-      #   * +:action_name+ - *required* - (Array<String>) The action you want
+      #   * `:action_name` - *required* - (Array<String>) The action you want
       #     to allow for the specified principal(s). Valid values: any Amazon
       #     SNS action name.
       # @return [Core::Response]
@@ -41,36 +41,36 @@ module AWS
       # @!method confirm_subscription(options = {})
       # Calls the ConfirmSubscription API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic for which
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic for which
       #     you wish to confirm a subscription.
-      #   * +:token+ - *required* - (String) Short-lived token sent to an
+      #   * `:token` - *required* - (String) Short-lived token sent to an
       #     endpoint during the Subscribe action.
-      #   * +:authenticate_on_unsubscribe+ - (String) Disallows unauthenticated
+      #   * `:authenticate_on_unsubscribe` - (String) 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
+      #     `true` and the request has an AWS signature, then only the topic
       #     owner and the subscription owner can unsubscribe the endpoint. The
       #     unsubscribe action will require AWS authentication.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:subscription_arn+ - (String)
+      #   * `:subscription_arn` - (String)
 
       # @!method create_topic(options = {})
       # Calls the CreateTopic API operation.
       # @param [Hash] options
-      #   * +:name+ - *required* - (String) The name of the topic you want to
+      #   * `:name` - *required* - (String) The name of the topic you want to
       #     create. Constraints: Topic names must be made up of only uppercase
       #     and lowercase ASCII letters, numbers, and hyphens, and must be
       #     between 1 and 256 characters long.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:topic_arn+ - (String)
+      #   * `:topic_arn` - (String)
 
       # @!method delete_topic(options = {})
       # Calls the DeleteTopic API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic you want
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic you want
       #     to delete. http://sns.us-east-1.amazonaws.com/
       #     ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic
       #     &Action=DeleteTopic &SignatureVersion=2 &SignatureMethod=HmacSHA256
@@ -87,85 +87,85 @@ module AWS
       # @!method get_subscription_attributes(options = {})
       # Calls the GetSubscriptionAttributes API operation.
       # @param [Hash] options
-      #   * +:subscription_arn+ - *required* - (String) The ARN of the
+      #   * `:subscription_arn` - *required* - (String) The ARN of the
       #     subscription whose properties you want to get.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:attributes+ - (Hash<String,String>)
+      #   * `:attributes` - (Hash<String,String>)
 
       # @!method get_topic_attributes(options = {})
       # Calls the GetTopicAttributes API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic whose
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic whose
       #     properties you want to get.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:attributes+ - (Hash<String,String>)
+      #   * `:attributes` - (Hash<String,String>)
 
       # @!method list_subscriptions(options = {})
       # Calls the ListSubscriptions API operation.
       # @param [Hash] options
-      #   * +:next_token+ - (String) Token returned by the previous
+      #   * `:next_token` - (String) Token returned by the previous
       #     ListSubscriptions request.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:subscriptions+ - (Array<Hash>)
-      #     * +:subscription_arn+ - (String)
-      #     * +:owner+ - (String)
-      #     * +:protocol+ - (String)
-      #     * +:endpoint+ - (String)
-      #     * +:topic_arn+ - (String)
-      #   * +:next_token+ - (String)
+      #   * `:subscriptions` - (Array<Hash>)
+      #     * `:subscription_arn` - (String)
+      #     * `:owner` - (String)
+      #     * `:protocol` - (String)
+      #     * `:endpoint` - (String)
+      #     * `:topic_arn` - (String)
+      #   * `:next_token` - (String)
 
       # @!method list_subscriptions_by_topic(options = {})
       # Calls the ListSubscriptionsByTopic API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic for which
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic for which
       #     you wish to find subscriptions.
-      #   * +:next_token+ - (String) Token returned by the previous
+      #   * `:next_token` - (String) Token returned by the previous
       #     ListSubscriptionsByTopic request.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:subscriptions+ - (Array<Hash>)
-      #     * +:subscription_arn+ - (String)
-      #     * +:owner+ - (String)
-      #     * +:protocol+ - (String)
-      #     * +:endpoint+ - (String)
-      #     * +:topic_arn+ - (String)
-      #   * +:next_token+ - (String)
+      #   * `:subscriptions` - (Array<Hash>)
+      #     * `:subscription_arn` - (String)
+      #     * `:owner` - (String)
+      #     * `:protocol` - (String)
+      #     * `:endpoint` - (String)
+      #     * `:topic_arn` - (String)
+      #   * `:next_token` - (String)
 
       # @!method list_topics(options = {})
       # Calls the ListTopics API operation.
       # @param [Hash] options
-      #   * +:next_token+ - (String) Token returned by the previous ListTopics
+      #   * `:next_token` - (String) Token returned by the previous ListTopics
       #     request.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:topics+ - (Array<Hash>)
-      #     * +:topic_arn+ - (String)
-      #   * +:next_token+ - (String)
+      #   * `:topics` - (Array<Hash>)
+      #     * `:topic_arn` - (String)
+      #   * `:next_token` - (String)
 
       # @!method publish(options = {})
       # Calls the Publish API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The topic you want to publish
+      #   * `:topic_arn` - *required* - (String) The topic you want to publish
       #     to.
-      #   * +:message+ - *required* - (String) The message you want to send to
+      #   * `:message` - *required* - (String) The message you want to send to
       #     the topic. Constraints: Messages must be UTF-8 encoded strings at
       #     most 8 KB in size (8192 bytes, not 8192 characters).
-      #   * +:subject+ - (String) Optional parameter to be used as the
+      #   * `:subject` - (String) Optional parameter to be used as the
       #     "Subject" line of when the message is delivered to e-mail
       #     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.
-      #   * +:message_structure+ - (String) Optional parameter. It will have
+      #   * `:message_structure` - (String) Optional parameter. It will have
       #     one valid value: "json". If this option, Message is present and set
       #     to "json", the value of Message must: be a syntactically valid JSON
       #     object. It must contain at least a top level JSON key of "default"
@@ -189,54 +189,54 @@ module AWS
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:message_id+ - (String)
+      #   * `:message_id` - (String)
 
       # @!method remove_permission(options = {})
       # Calls the RemovePermission API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic whose
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic whose
       #     access control policy you wish to modify.
-      #   * +:label+ - *required* - (String) The unique label of the statement
+      #   * `:label` - *required* - (String) The unique label of the statement
       #     you want to remove.
       # @return [Core::Response]
 
       # @!method set_subscription_attributes(options = {})
       # Calls the SetSubscriptionAttributes API operation.
       # @param [Hash] options
-      #   * +:subscription_arn+ - *required* - (String) The ARN of the
+      #   * `:subscription_arn` - *required* - (String) The ARN of the
       #     subscription to modify.
-      #   * +:attribute_name+ - *required* - (String) The name of the attribute
+      #   * `:attribute_name` - *required* - (String) The name of the attribute
       #     you want to set. Only a subset of the subscriptions attributes are
       #     mutable. Valid values: DeliveryPolicy
-      #   * +:attribute_value+ - *required* - (String) The new value for the
+      #   * `:attribute_value` - *required* - (String) The new value for the
       #     attribute.
       # @return [Core::Response]
 
       # @!method set_topic_attributes(options = {})
       # Calls the SetTopicAttributes API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of the topic to
+      #   * `:topic_arn` - *required* - (String) The ARN of the topic to
       #     modify.
-      #   * +:attribute_name+ - *required* - (String) The name of the attribute
+      #   * `:attribute_name` - *required* - (String) The name of the attribute
       #     you want to set. Only a subset of the topic's attributes are
       #     mutable. Valid values: Policy | DisplayName
-      #   * +:attribute_value+ - *required* - (String) The new value for the
+      #   * `:attribute_value` - *required* - (String) The new value for the
       #     attribute.
       # @return [Core::Response]
 
       # @!method subscribe(options = {})
       # Calls the Subscribe API operation.
       # @param [Hash] options
-      #   * +:topic_arn+ - *required* - (String) The ARN of topic you want to
+      #   * `:topic_arn` - *required* - (String) The ARN of topic you want to
       #     subscribe to.
-      #   * +:protocol+ - *required* - (String) The protocol you want to use.
+      #   * `:protocol` - *required* - (String) 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
-      #   * +:endpoint+ - *required* - (String) The endpoint that you want to
+      #   * `:endpoint` - *required* - (String) 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
@@ -248,12 +248,12 @@ module AWS
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:subscription_arn+ - (String)
+      #   * `:subscription_arn` - (String)
 
       # @!method unsubscribe(options = {})
       # Calls the Unsubscribe API operation.
       # @param [Hash] options
-      #   * +:subscription_arn+ - *required* - (String) The ARN of the
+      #   * `:subscription_arn` - *required* - (String) The ARN of the
       #     subscription to be deleted.
       # @return [Core::Response]