aws-sdk 1.13.0 → 1.14.0

data/lib/aws/sns/client.rb

@@ -26,289 +26,6 @@ module AWS
 
     class Client::V20100331 < Client
 
-      # client methods #
-
-      # @!method add_permission(options = {})
-      # Calls the AddPermission API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:label` - *required* - (String)
-      #   * `:aws_account_id` - *required* - (Array<String>)
-      #   * `:action_name` - *required* - (Array<String>)
-      # @return [Core::Response]
-
-      # @!method confirm_subscription(options = {})
-      # Calls the ConfirmSubscription API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:token` - *required* - (String)
-      #   * `:authenticate_on_unsubscribe` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:subscription_arn` - (String)
-
-      # @!method create_platform_application(options = {})
-      # Calls the CreatePlatformApplication API operation.
-      # @param [Hash] options
-      #
-      #   * `:name` - (String)
-      #   * `:platform` - (String)
-      #   * `:attributes` - (Hash<String,String>)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:platform_application_arn` - (String)
-
-      # @!method create_platform_endpoint(options = {})
-      # Calls the CreatePlatformEndpoint API operation.
-      # @param [Hash] options
-      #
-      #   * `:platform_application_arn` - (String)
-      #   * `:token` - (String)
-      #   * `:custom_user_data` - (String)
-      #   * `:attributes` - (Hash<String,String>)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:endpoint_arn` - (String)
-
-      # @!method create_topic(options = {})
-      # Calls the CreateTopic API operation.
-      # @param [Hash] options
-      #
-      #   * `:name` - *required* - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:topic_arn` - (String)
-
-      # @!method delete_endpoint(options = {})
-      # Calls the DeleteEndpoint API operation.
-      # @param [Hash] options
-      #
-      #   * `:endpoint_arn` - (String)
-      # @return [Core::Response]
-
-      # @!method delete_platform_application(options = {})
-      # Calls the DeletePlatformApplication API operation.
-      # @param [Hash] options
-      #
-      #   * `:platform_application_arn` - (String)
-      # @return [Core::Response]
-
-      # @!method delete_topic(options = {})
-      # Calls the DeleteTopic API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      # @return [Core::Response]
-
-      # @!method get_endpoint_attributes(options = {})
-      # Calls the GetEndpointAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:endpoint_arn` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:attributes` - (Hash<String,String>)
-
-      # @!method get_platform_application_attributes(options = {})
-      # Calls the GetPlatformApplicationAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:platform_application_arn` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:attributes` - (Hash<String,String>)
-
-      # @!method get_subscription_attributes(options = {})
-      # Calls the GetSubscriptionAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:subscription_arn` - *required* - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:attributes` - (Hash<String,String>)
-
-      # @!method get_topic_attributes(options = {})
-      # Calls the GetTopicAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:attributes` - (Hash<String,String>)
-
-      # @!method list_endpoints_by_platform_application(options = {})
-      # Calls the ListEndpointsByPlatformApplication API operation.
-      # @param [Hash] options
-      #
-      #   * `:platform_application_arn` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:endpoints` - (Array<Hash>)
-      #     * `:endpoint_arn` - (String)
-      #     * `:attributes` - (Hash<String,String>)
-      #   * `:next_token` - (String)
-
-      # @!method list_platform_applications(options = {})
-      # Calls the ListPlatformApplications API operation.
-      # @param [Hash] options
-      #
-      #   * `:next_token` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:platform_applications` - (Array<Hash>)
-      #     * `:platform_application_arn` - (String)
-      #     * `:attributes` - (Hash<String,String>)
-
-      # @!method list_subscriptions(options = {})
-      # Calls the ListSubscriptions API operation.
-      # @param [Hash] options
-      #
-      #   * `:next_token` - (String)
-      # @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)
-
-      # @!method list_subscriptions_by_topic(options = {})
-      # Calls the ListSubscriptionsByTopic API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:next_token` - (String)
-      # @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)
-
-      # @!method list_topics(options = {})
-      # Calls the ListTopics API operation.
-      # @param [Hash] options
-      #
-      #   * `:next_token` - (String)
-      # @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)
-
-      # @!method publish(options = {})
-      # Calls the Publish API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - (String)
-      #   * `:target_arn` - (String)
-      #   * `:message` - *required* - (String)
-      #   * `:subject` - (String)
-      #   * `:message_structure` - (String)
-      #   * `:attributes` - (Hash<String,String>)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:message_id` - (String)
-
-      # @!method remove_permission(options = {})
-      # Calls the RemovePermission API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:label` - *required* - (String)
-      # @return [Core::Response]
-
-      # @!method set_endpoint_attributes(options = {})
-      # Calls the SetEndpointAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:endpoint_arn` - (String)
-      #   * `:attributes` - (Hash<String,String>)
-      # @return [Core::Response]
-
-      # @!method set_platform_application_attributes(options = {})
-      # Calls the SetPlatformApplicationAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:platform_application_arn` - (String)
-      #   * `:attributes` - (Hash<String,String>)
-      # @return [Core::Response]
-
-      # @!method set_subscription_attributes(options = {})
-      # Calls the SetSubscriptionAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:subscription_arn` - *required* - (String)
-      #   * `:attribute_name` - *required* - (String)
-      #   * `:attribute_value` - (String)
-      # @return [Core::Response]
-
-      # @!method set_topic_attributes(options = {})
-      # Calls the SetTopicAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:attribute_name` - *required* - (String)
-      #   * `:attribute_value` - (String)
-      # @return [Core::Response]
-
-      # @!method subscribe(options = {})
-      # Calls the Subscribe API operation.
-      # @param [Hash] options
-      #
-      #   * `:topic_arn` - *required* - (String)
-      #   * `:protocol` - *required* - (String)
-      #   * `:endpoint` - (String)
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:subscription_arn` - (String)
-
-      # @!method unsubscribe(options = {})
-      # Calls the Unsubscribe API operation.
-      # @param [Hash] options
-      #
-      #   * `:subscription_arn` - *required* - (String)
-      # @return [Core::Response]
-
-      # end client methods #
-
       define_client_methods('2010-03-31')
 
     end

data/lib/aws/sns/message.rb

@@ -49,7 +49,7 @@ module AWS
         self.extend FromAutoScaling if FromAutoScaling.applicable? @raw
       end
 
-      # @param [String] indexer into raw SNS JSON message
+      # @param [String] key Indexer into raw SNS JSON message.
       # @return [String] the value of the SNS' field
       def [] key
         @raw[key]

data/lib/aws/sqs/client.rb

@@ -41,261 +41,6 @@ module AWS
 
     class Client::V20121105 < Client
 
-      # client methods #
-
-      # @!method add_permission(options = {})
-      # Calls the AddPermission API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:label` - *required* - (String) The unique identification of the
-      #     permission you're setting (e.g., AliceSendMessage). Constraints:
-      #     Maximum 80 characters; alphanumeric characters, hyphens (-), and
-      #     underscores (_) are allowed.
-      #   * `:aws_account_ids` - *required* - (Array<String>) The AWS account
-      #     number of the principal who will be given permission. The principal
-      #     must have an AWS account, but does not need to be signed up for
-      #     Amazon SQS.
-      #   * `:actions` - *required* - (Array<String>) The action the client
-      #     wants to allow for the specified principal.
-      # @return [Core::Response]
-
-      # @!method change_message_visibility(options = {})
-      # Calls the ChangeMessageVisibility API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:receipt_handle` - *required* - (String) The receipt handle
-      #     associated with the message whose visibility timeout should be
-      #     changed.
-      #   * `:visibility_timeout` - *required* - (Integer) The new value (in
-      #     seconds) for the message's visibility timeout.
-      # @return [Core::Response]
-
-      # @!method change_message_visibility_batch(options = {})
-      # Calls the ChangeMessageVisibilityBatch API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:entries` - *required* - (Array<Hash>) A list of receipt handles
-      #     of the messages for which the visibility timeout must be changed.
-      #     * `:id` - *required* - (String) An identifier for this particular
-      #       receipt handle. This is used to communicate the result. Note that
-      #       the Ids of a batch request need to be unique within the request.
-      #     * `:receipt_handle` - *required* - (String) A receipt handle.
-      #     * `:visibility_timeout` - (Integer) The new value (in seconds) for
-      #       the message's visibility timeout.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:successful` - (Array<Hash>)
-      #     * `:id` - (String)
-      #   * `:failed` - (Array<Hash>)
-      #     * `:id` - (String)
-      #     * `:sender_fault` - (Boolean)
-      #     * `:code` - (String)
-      #     * `:message` - (String)
-
-      # @!method create_queue(options = {})
-      # Calls the CreateQueue API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_name` - *required* - (String) The name for the queue to be
-      #     created.
-      #   * `:attributes` - (Hash<String,String>) A map of attributes with
-      #     their corresponding values.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:queue_url` - (String)
-
-      # @!method delete_message(options = {})
-      # Calls the DeleteMessage API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:receipt_handle` - *required* - (String) The receipt handle
-      #     associated with the message to delete.
-      # @return [Core::Response]
-
-      # @!method delete_message_batch(options = {})
-      # Calls the DeleteMessageBatch API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:entries` - *required* - (Array<Hash>) A list of receipt handles
-      #     for the messages to be deleted.
-      #     * `:id` - *required* - (String) An identifier for this particular
-      #       receipt handle. This is used to communicate the result. Note that
-      #       the Ids of a batch request need to be unique within the request.
-      #     * `:receipt_handle` - *required* - (String) A receipt handle.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:successful` - (Array<Hash>)
-      #     * `:id` - (String)
-      #   * `:failed` - (Array<Hash>)
-      #     * `:id` - (String)
-      #     * `:sender_fault` - (Boolean)
-      #     * `:code` - (String)
-      #     * `:message` - (String)
-
-      # @!method delete_queue(options = {})
-      # Calls the DeleteQueue API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      # @return [Core::Response]
-
-      # @!method get_queue_attributes(options = {})
-      # Calls the GetQueueAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:attribute_names` - (Array<String>) A list of attributes to
-      #     retrieve information for.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:attributes` - (Hash<String,String>)
-
-      # @!method get_queue_url(options = {})
-      # Calls the GetQueueUrl API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_name` - *required* - (String) The name of the queue whose
-      #     URL must be fetched.
-      #   * `:queue_owner_aws_account_id` - (String) The AWS account number of
-      #     the queue's owner.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:queue_url` - (String)
-
-      # @!method list_queues(options = {})
-      # Calls the ListQueues API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_name_prefix` - (String) A string to use for filtering the
-      #     list results. Only those queues whose name begins with the
-      #     specified string are returned.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:queue_urls` - (Array<String>)
-
-      # @!method receive_message(options = {})
-      # Calls the ReceiveMessage API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:attribute_names` - (Array<String>) A list of attributes that need
-      #     to be returned along with each message. The set of valid attributes
-      #     are [SenderId, ApproximateFirstReceiveTimestamp,
-      #     ApproximateReceiveCount, SentTimestamp].
-      #   * `:max_number_of_messages` - (Integer) The maximum number of
-      #     messages to return. Amazon SQS never returns more messages than
-      #     this value but may return fewer. All of the messages are not
-      #     necessarily returned.
-      #   * `:visibility_timeout` - (Integer) The duration (in seconds) that
-      #     the received messages are hidden from subsequent retrieve requests
-      #     after being retrieved by a ReceiveMessage request.
-      #   * `:wait_time_seconds` - (Integer) The duration (in seconds) for
-      #     which the call will wait for a message to arrive in the queue
-      #     before returning. If a message is available, the call will return
-      #     sooner than WaitTimeSeconds.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:messages` - (Array<Hash>)
-      #     * `:message_id` - (String)
-      #     * `:receipt_handle` - (String)
-      #     * `:md5_of_body` - (String)
-      #     * `:body` - (String)
-      #     * `:attributes` - (Hash<String,String>)
-
-      # @!method remove_permission(options = {})
-      # Calls the RemovePermission API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:label` - *required* - (String) The identification of the
-      #     permission to remove. This is the label added with the
-      #     AddPermission operation.
-      # @return [Core::Response]
-
-      # @!method send_message(options = {})
-      # Calls the SendMessage API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:message_body` - *required* - (String) The message to send.
-      #   * `:delay_seconds` - (Integer) The number of seconds the message has
-      #     to be delayed.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:md5_of_message_body` - (String)
-      #   * `:message_id` - (String)
-
-      # @!method send_message_batch(options = {})
-      # Calls the SendMessageBatch API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:entries` - *required* - (Array<Hash>) A list of
-      #     SendMessageBatchRequestEntrys.
-      #     * `:id` - *required* - (String) An identifier for the message in
-      #       this batch. This is used to communicate the result. Note that the
-      #       the Ids of a batch request need to be unique within the request.
-      #     * `:message_body` - *required* - (String) Body of the message.
-      #     * `:delay_seconds` - (Integer) The number of seconds for which the
-      #       message has to be delayed.
-      # @return [Core::Response]
-      #   The #data method of the response object returns
-      #   a hash with the following structure:
-      #
-      #   * `:successful` - (Array<Hash>)
-      #     * `:id` - (String)
-      #     * `:message_id` - (String)
-      #     * `:md5_of_message_body` - (String)
-      #   * `:failed` - (Array<Hash>)
-      #     * `:id` - (String)
-      #     * `:sender_fault` - (Boolean)
-      #     * `:code` - (String)
-      #     * `:message` - (String)
-
-      # @!method set_queue_attributes(options = {})
-      # Calls the SetQueueAttributes API operation.
-      # @param [Hash] options
-      #
-      #   * `:queue_url` - *required* - (String) The URL of the SQS queue to
-      #     take action on.
-      #   * `:attributes` - *required* - (Hash<String,String>) A map of
-      #     attributes to set.
-      # @return [Core::Response]
-
-      # end client methods #
-
       define_client_methods('2012-11-05')
 
     end