aws-sdk 1.7.1 → 1.8.0

data/lib/aws/s3/client.rb

@@ -16,6 +16,7 @@ require 'pathname'
 require 'stringio'
 require 'json'
 require 'digest/md5'
+require 'base64'
 require 'nokogiri'
 
 module AWS
@@ -925,8 +926,19 @@ module AWS
             exp_rule_id = nil
           end
 
+          if restore = resp.http_response.headers['x-amz-restore']
+            restore.first =~ /ongoing-request="(.+?)", expiry-date="(.+?)"/
+            restoring = $1 == "true"
+            restore_date = DateTime.parse($2)
+          else
+            restoring = false
+            restore_date = nil
+          end
+
           resp.data[:expiration_date] = exp_date
           resp.data[:expiration_rule_id] = exp_rule_id
+          resp.data[:restore_in_progress] = restoring
+          resp.data[:restore_expiration_date] = restore_date
 
           {
             'x-amz-version-id' => :version_id,
@@ -970,6 +982,37 @@ module AWS
 
       end
 
+      # @overload restore_object(options = {})
+      #   Restores a temporary copy of an archived object.
+      #   @param [Hash] options
+      #   @option options [required,String] :bucket_name
+      #   @option options [required,String] :key
+      #   @option options [required,Integer] :days the number of days to keep
+      #     the restored object.
+      #   @return [Core::Response]
+      # @since 1.7.2
+      object_method(:restore_object, :post, 'restore',
+          :header_options => { :content_md5 => 'Content-MD5' }) do
+        configure_request do |req, options|
+          super(req, options)
+
+          validate!(:days, options[:days]) do
+            "must be greater or equal to 1" if options[:days].to_i <= 0
+          end
+
+          xml = Nokogiri::XML::Builder.new do |xml|
+            xml.RestoreRequest('xmlns' => XMLNS) do
+              xml.Days(options[:days].to_i) if options[:days]
+            end
+          end.doc.root.to_xml
+
+          req.body = xml
+          req.headers['content-type'] = 'application/xml'
+          req.headers['content-md5'] = md5(xml)
+        end
+      end
+
+
       # @overload list_objects(options = {})
       #   @param [Hash] options
       #   @option options [required,String] :bucket_name

data/lib/aws/s3/client/xml.rb

@@ -167,6 +167,12 @@ module AWS
             rename(:rules)
             element("Expiration") do
               element("Days") { integer_value }
+              element("Date") { datetime_value }
+            end
+            element("Transition") do
+              element("StorageClass") { }
+              element("Days") { integer_value }
+              element("Date") { datetime_value }
             end
           end
         end

data/lib/aws/s3/cors_rule_collection.rb

@@ -90,7 +90,7 @@ module AWS
       #    bucket.cors.clear
       #    bucket.cors.set([])
       #
-      # @param [Hash,CORSRule,CORSRuleCollection] rule A list or array
+      # @param [Hash,CORSRule,CORSRuleCollection] rules A list or array
       #   of one or more rules to set.  Each rule may be a Hash, a CORSRule
       #   or a CORSRuleCollection.
       #

data/lib/aws/s3/data_options.rb

@@ -135,9 +135,7 @@ module AWS
       # @param [String] path Path to a file on disk.
       # @return [File] Given a path string, returns an open File.
       def open_file path
-        file_opts = ['rb']
-        file_opts << { :encoding => "BINARY" } if Object.const_defined?(:Encoding)
-        File.open(path, *file_opts)
+        Core::ManagedFile.open(path)
       end
 
       # A utility class that turns a block (with 2 args) into an

data/lib/aws/s3/request.rb

@@ -180,7 +180,7 @@ module AWS
         def sub_resources
           %w(acl location logging notification partNumber policy
              requestPayment torrent uploadId uploads versionId
-             versioning versions delete lifecycle tagging cors)
+             versioning versions restore delete lifecycle tagging cors)
         end
 
         def query_parameters

data/lib/aws/s3/s3_object.rb

@@ -349,6 +349,31 @@ module AWS
         !server_side_encryption.nil?
       end
 
+      # @return [Boolean] whether a {#restore} operation on the
+      #   object is currently being performed on the object.
+      # @see #restore_expiration_date
+      # @since 1.7.2
+      def restore_in_progress?
+        head.restore_in_progress
+      end
+
+      # @return [DateTime] the time when the temporarily restored object
+      #   will be removed from S3. Note that the original object will remain
+      #   available in Glacier.
+      # @return [nil] if the object was not restored from an archived
+      #   copy
+      # @since 1.7.2
+      def restore_expiration_date
+        head.restore_expiration_date
+      end
+
+      # @return [Boolean] whether the object is a temporary copy of an
+      #   archived object in the Glacier storage class.
+      # @since 1.7.2
+      def restored_object?
+        !!head.restore_expiration_date
+      end
+
       # Deletes the object from its S3 bucket.
       #
       # @param [Hash] options
@@ -381,6 +406,27 @@ module AWS
 
       end
 
+      # Restores a temporary copy of an archived object from the
+      # Glacier storage tier. After the specified +days+, Amazon
+      # S3 deletes the temporary copy. Note that the object
+      # remains archived; Amazon S3 deletes only the restored copy.
+      #
+      # Restoring an object does not occur immediately. Use
+      # {#restore_in_progress?} to check the status of the operation.
+      #
+      # @option [Integer] :days (1) the number of days to keep the object
+      # @return [Boolean] +true+ if a restore can be initiated.
+      # @since 1.7.2
+      def restore options = {}
+        options[:days] ||= 1
+
+        client.restore_object(
+          :bucket_name => bucket.name,
+          :key => key, :days => options[:days])
+
+        true
+      end
+
       # @option [String] :version_id (nil) If present the metadata object
       #   will be for the specified version.
       # @return [ObjectMetadata] Returns an instance of ObjectMetadata
@@ -1310,17 +1356,13 @@ module AWS
       end
 
       def expiration_timestamp(input)
+        input = input.to_int if input.respond_to?(:to_int)
         case input
-        when Time
-          expires = input.to_i
-        when DateTime
-          expires = Time.parse(input.to_s).to_i
-        when Integer
-          expires = (Time.now + input).to_i
-        when String
-          expires = Time.parse(input).to_i
-        else
-          expires = (Time.now + 60*60).to_i
+        when Time then input.to_i
+        when DateTime then Time.parse(input.to_s).to_i
+        when Integer then (Time.now + input).to_i
+        when String then Time.parse(input).to_i
+        else (Time.now + 60*60).to_i
         end
       end
 

data/lib/aws/sqs/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Amazon Simple Queue Service (SQS).
     class Client < Core::QueryClient
 
-      define_client_methods('2011-10-01')
+      define_client_methods('2012-11-05')
 
       # @private
       CACHEABLE_REQUESTS = Set[]
@@ -167,8 +167,10 @@ module AWS
       # @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.
+      #   * +: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
@@ -176,6 +178,10 @@ module AWS
       #   * +: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:

data/lib/aws/sqs/queue.rb

@@ -29,8 +29,15 @@ module AWS
 
       # The default number of seconds to wait between polling requests for
       # new messages.  
+      # @deprecated No longer used by {#poll}
       DEFAULT_POLL_INTERVAL = 1
 
+      # The default number of seconds to pass in as the SQS long polling
+      # value (+:wait_time_seconds+) in {#receive_message}.
+      #
+      # @since 1.8.0
+      DEFAULT_WAIT_TIME_SECONDS = 15
+
       include Core::Model
 
       # @return [String] The queue URL.
@@ -147,6 +154,12 @@ module AWS
       #   (for more information, see the preceding note about
       #   machine sampling).
       #
+      # @option opts [Integer] :wait_time_seconds The number of seconds
+      #   the service should wait for a response when requesting a new message.
+      #   Defaults to the {#wait_time_seconds} attribute defined on the queue.
+      #   See {#wait_time_seconds} to set the global long poll setting
+      #   on the queue.
+      #
       # @option opts [Integer] :visibilitiy_timeout The duration (in
       #   seconds) that the received messages are hidden from
       #   subsequent retrieve requests.  Valid values: integer from
@@ -209,9 +222,12 @@ module AWS
       #
       # @param [Hash] opts Options for polling.
       #
-      # @option opts [Float, Integer] :poll_interval The number of
-      #   seconds to wait before retrying when no messages are
-      #   received.  The default is 1 second.
+      # @option opts [Integer] :wait_time_seconds The number of seconds
+      #   the service should wait for a response when requesting a new message.
+      #   Defaults to {DEFAULT_WAIT_TIME_SECONDS}. Use +nil+ to
+      #   use the queue's global long polling wait time setting.
+      #   See {#wait_time_seconds} to set the global long poll setting
+      #   on the queue.
       #
       # @option opts [Integer] :idle_timeout The maximum number of
       #   seconds to spend polling while no messages are being
@@ -247,12 +263,18 @@ module AWS
       #   See {ReceivedMessage} for documentation on each
       #   attribute's meaning.
       #
+      # @option opts [Float, Integer] :poll_interval As of
+      #   v1.7.2, this option is no longer used. See the
+      #   +:wait_time_seonds+ option for long polling instead.
+      #
       # @return [nil]
       def poll(opts = {}, &block)
-        poll_interval = opts[:poll_interval] || DEFAULT_POLL_INTERVAL
         opts[:limit] = opts.delete(:batch_size) if
           opts.key?(:batch_size)
 
+        opts[:wait_time_seconds] = DEFAULT_WAIT_TIME_SECONDS unless
+          opts.has_key?(:wait_time_seconds)
+
         last_message_at = Time.now
         got_first = false
         loop do
@@ -263,7 +285,6 @@ module AWS
             yield(message)
           end
           unless got_msg
-            Kernel.sleep(poll_interval) unless poll_interval == 0
             return if hit_timeout?(got_first, last_message_at, opts)
           end
         end
@@ -370,6 +391,21 @@ module AWS
         set_attribute("DelaySeconds", seconds.to_s)
       end
 
+      # @return [Integer] Gets the number of seconds the service will wait
+      #   for a response when requesting a new message
+      # @since 1.8.0
+      def wait_time_seconds
+        get_attribute("ReceiveMessageWaitTimeSeconds").to_i
+      end
+
+      # Sets the number of seconds that the service should wait for a response
+      # when requesting a new message
+      # @param [Integer] seconds How many seconds to wait for a response
+      # @since 1.8.0
+      def wait_time_seconds= seconds
+        set_attribute("ReceiveMessageWaitTimeSeconds", seconds.to_s)
+      end
+
       # @return [Integer] Returns an approximate count of messages delayed.
       def approximate_number_of_messages_delayed
         get_attribute("ApproximateNumberOfMessagesDelayed").to_i
@@ -673,6 +709,9 @@ module AWS
           opts[:visibility_timeout]
         receive_opts[:max_number_of_messages] = opts[:limit] if
           opts[:limit]
+        receive_opts[:wait_time_seconds] = opts[:wait_time_seconds] if
+          opts[:wait_time_seconds]
+
         if names = opts[:attributes]
           receive_opts[:attribute_names] = names.map do |name|
             name = ReceivedMessage::ATTRIBUTE_ALIASES[name.to_sym] if

data/lib/aws/storage_gateway.rb

@@ -0,0 +1,71 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/core'
+require 'aws/storage_gateway/config'
+
+module AWS
+
+  # This class is the starting point for working with AWS Storage Gateway.
+  #
+  # To use AWS Storage Gateway you must first
+  # {sign up here}[http://aws.amazon.com/storagegateway/].
+  #
+  # For more information about AWS Storage Gateway:
+  #
+  # * {AWS Storage Gateway}[http://aws.amazon.com/storagegateway/]
+  # * {AWS Storage Gateway Documentation}[http://aws.amazon.com/documentation/storagegateway/]
+  #
+  # = Credentials
+  #
+  # 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')
+  #
+  # Or you can set them directly on the AWS::StorageGateway interface:
+  #
+  #   sg = AWS::StorageGateway.new(
+  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # = Using the Client
+  #
+  # AWS::StorageGateway does not provide higher level abstractions for Route 53 at
+  # this time.  You can still access all of the API methods using
+  # {AWS::StorageGateway::Client}.  Here is how you access the client and make
+  # a simple request:
+  #
+  #   sg = AWS::StorageGateway.new
+  #
+  #   resp = sg.client.list_gateways
+  #   resp[:gateways].each do |gateway|
+  #     puts gateway[:gateway_arn]
+  #   end
+  #
+  # See {Client} for documentation on all of the supported operations.
+  #
+  class StorageGateway
+
+    AWS.register_autoloads(self, 'aws/storage_gateway') do
+      autoload :Client,  'client'
+      autoload :Errors,  'errors'
+      autoload :Request, 'request'
+    end
+
+    include Core::ServiceInterface
+
+  end
+end

data/lib/aws/storage_gateway/client.rb

@@ -0,0 +1,472 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class StorageGateway
+
+    # Client class for AWS Storage Gateway.
+    class Client < Core::JSONClient
+
+      define_client_methods('2012-06-30')
+
+      # @private
+      CACHEABLE_REQUESTS = Set[]
+
+      ## client methods ##
+
+      # @!method activate_gateway(options = {})
+      # Calls the ActivateGateway API operation.
+      # @param [Hash] options
+      #   * +:activation_key+ - *required* - (String)
+      #   * +:gateway_name+ - *required* - (String)
+      #   * +:gateway_timezone+ - *required* - (String)
+      #   * +:gateway_region+ - *required* - (String)
+      #   * +:gateway_type+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method add_cache(options = {})
+      # Calls the AddCache API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:disk_ids+ - *required* - (Array<String>)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method add_upload_buffer(options = {})
+      # Calls the AddUploadBuffer API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:disk_ids+ - *required* - (Array<String>)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method add_working_storage(options = {})
+      # Calls the AddWorkingStorage API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:disk_ids+ - *required* - (Array<String>)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method create_cachedi_scsi_volume(options = {})
+      # Calls the CreateCachediSCSIVolume API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:volume_size_in_bytes+ - *required* - (Integer)
+      #   * +:snapshot_id+ - (String)
+      #   * +:target_name+ - *required* - (String)
+      #   * +:network_interface_id+ - *required* - (String)
+      #   * +:client_token+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+      #   * +TargetARN+ - (String)
+
+      # @!method create_snapshot(options = {})
+      # Calls the CreateSnapshot API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      #   * +:snapshot_description+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+      #   * +SnapshotId+ - (String)
+
+      # @!method create_snapshot_from_volume_recovery_point(options = {})
+      # Calls the CreateSnapshotFromVolumeRecoveryPoint API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      #   * +:snapshot_description+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +SnapshotId+ - (String)
+      #   * +VolumeARN+ - (String)
+      #   * +VolumeRecoveryPointTime+ - (String)
+
+      # @!method create_storedi_scsi_volume(options = {})
+      # Calls the CreateStorediSCSIVolume API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:disk_id+ - *required* - (String)
+      #   * +:snapshot_id+ - (String)
+      #   * +:preserve_existing_data+ - *required* - (Boolean)
+      #   * +:target_name+ - *required* - (String)
+      #   * +:network_interface_id+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+      #   * +VolumeSizeInBytes+ - (Integer)
+      #   * +TargetARN+ - (String)
+
+      # @!method delete_bandwidth_rate_limit(options = {})
+      # Calls the DeleteBandwidthRateLimit API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:bandwidth_type+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method delete_chap_credentials(options = {})
+      # Calls the DeleteChapCredentials API operation.
+      # @param [Hash] options
+      #   * +:target_arn+ - *required* - (String)
+      #   * +:initiator_name+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +TargetARN+ - (String)
+      #   * +InitiatorName+ - (String)
+
+      # @!method delete_gateway(options = {})
+      # Calls the DeleteGateway API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method delete_snapshot_schedule(options = {})
+      # Calls the DeleteSnapshotSchedule API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+
+      # @!method delete_volume(options = {})
+      # Calls the DeleteVolume API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+
+      # @!method describe_bandwidth_rate_limit(options = {})
+      # Calls the DescribeBandwidthRateLimit API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +AverageUploadRateLimitInBitsPerSec+ - (Integer)
+      #   * +AverageDownloadRateLimitInBitsPerSec+ - (Integer)
+
+      # @!method describe_cache(options = {})
+      # Calls the DescribeCache API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +DiskIds+ - (Array<String>)
+      #   * +CacheAllocatedInBytes+ - (Integer)
+      #   * +CacheUsedPercentage+ - (Numeric)
+      #   * +CacheDirtyPercentage+ - (Numeric)
+      #   * +CacheHitPercentage+ - (Numeric)
+      #   * +CacheMissPercentage+ - (Numeric)
+
+      # @!method describe_cachedi_scsi_volumes(options = {})
+      # Calls the DescribeCachediSCSIVolumes API operation.
+      # @param [Hash] options
+      #   * +:volume_ar_ns+ - *required* - (Array<String>)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +CachediSCSIVolumes+ - (Array<Hash>)
+      #     * +VolumeARN+ - (String)
+      #     * +VolumeId+ - (String)
+      #     * +VolumeType+ - (String)
+      #     * +VolumeStatus+ - (String)
+      #     * +VolumeSizeInBytes+ - (Integer)
+      #     * +VolumeProgress+ - (Numeric)
+      #     * +SourceSnapshotId+ - (String)
+      #     * +VolumeiSCSIAttributes+ - (Hash)
+      #       * +TargetARN+ - (String)
+      #       * +NetworkInterfaceId+ - (String)
+      #       * +NetworkInterfacePort+ - (Integer)
+      #       * +LunNumber+ - (Integer)
+      #       * +ChapEnabled+ - (Boolean)
+
+      # @!method describe_chap_credentials(options = {})
+      # Calls the DescribeChapCredentials API operation.
+      # @param [Hash] options
+      #   * +:target_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +ChapCredentials+ - (Array<Hash>)
+      #     * +TargetARN+ - (String)
+      #     * +SecretToAuthenticateInitiator+ - (String)
+      #     * +InitiatorName+ - (String)
+      #     * +SecretToAuthenticateTarget+ - (String)
+
+      # @!method describe_gateway_information(options = {})
+      # Calls the DescribeGatewayInformation API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +GatewayId+ - (String)
+      #   * +GatewayTimezone+ - (String)
+      #   * +GatewayState+ - (String)
+      #   * +GatewayNetworkInterfaces+ - (Array<Hash>)
+      #     * +Ipv4Address+ - (String)
+      #     * +MacAddress+ - (String)
+      #     * +Ipv6Address+ - (String)
+      #   * +GatewayType+ - (String)
+      #   * +NextUpdateAvailabilityDate+ - (String)
+
+      # @!method describe_maintenance_start_time(options = {})
+      # Calls the DescribeMaintenanceStartTime API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +HourOfDay+ - (Integer)
+      #   * +MinuteOfHour+ - (Integer)
+      #   * +DayOfWeek+ - (Integer)
+      #   * +Timezone+ - (String)
+
+      # @!method describe_snapshot_schedule(options = {})
+      # Calls the DescribeSnapshotSchedule API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+      #   * +StartAt+ - (Integer)
+      #   * +RecurrenceInHours+ - (Integer)
+      #   * +Description+ - (String)
+      #   * +Timezone+ - (String)
+
+      # @!method describe_storedi_scsi_volumes(options = {})
+      # Calls the DescribeStorediSCSIVolumes API operation.
+      # @param [Hash] options
+      #   * +:volume_ar_ns+ - *required* - (Array<String>)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +StorediSCSIVolumes+ - (Array<Hash>)
+      #     * +VolumeARN+ - (String)
+      #     * +VolumeId+ - (String)
+      #     * +VolumeType+ - (String)
+      #     * +VolumeStatus+ - (String)
+      #     * +VolumeSizeInBytes+ - (Integer)
+      #     * +VolumeProgress+ - (Numeric)
+      #     * +VolumeDiskId+ - (String)
+      #     * +SourceSnapshotId+ - (String)
+      #     * +PreservedExistingData+ - (Boolean)
+      #     * +VolumeiSCSIAttributes+ - (Hash)
+      #       * +TargetARN+ - (String)
+      #       * +NetworkInterfaceId+ - (String)
+      #       * +NetworkInterfacePort+ - (Integer)
+      #       * +LunNumber+ - (Integer)
+      #       * +ChapEnabled+ - (Boolean)
+
+      # @!method describe_upload_buffer(options = {})
+      # Calls the DescribeUploadBuffer API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +DiskIds+ - (Array<String>)
+      #   * +UploadBufferUsedInBytes+ - (Integer)
+      #   * +UploadBufferAllocatedInBytes+ - (Integer)
+
+      # @!method describe_working_storage(options = {})
+      # Calls the DescribeWorkingStorage API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +DiskIds+ - (Array<String>)
+      #   * +WorkingStorageUsedInBytes+ - (Integer)
+      #   * +WorkingStorageAllocatedInBytes+ - (Integer)
+
+      # @!method list_gateways(options = {})
+      # Calls the ListGateways API operation.
+      # @param [Hash] options
+      #   * +:marker+ - (String)
+      #   * +:limit+ - (Integer)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +Gateways+ - (Array<Hash>)
+      #     * +GatewayARN+ - (String)
+      #   * +Marker+ - (String)
+
+      # @!method list_local_disks(options = {})
+      # Calls the ListLocalDisks API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +Disks+ - (Array<Hash>)
+      #     * +DiskId+ - (String)
+      #     * +DiskPath+ - (String)
+      #     * +DiskNode+ - (String)
+      #     * +DiskSizeInBytes+ - (Integer)
+      #     * +DiskAllocationType+ - (String)
+      #     * +DiskAllocationResource+ - (String)
+
+      # @!method list_volume_recovery_points(options = {})
+      # Calls the ListVolumeRecoveryPoints API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +VolumeRecoveryPointInfos+ - (Array<Hash>)
+      #     * +VolumeARN+ - (String)
+      #     * +VolumeSizeInBytes+ - (Integer)
+      #     * +VolumeUsageInBytes+ - (Integer)
+      #     * +VolumeRecoveryPointTime+ - (String)
+
+      # @!method list_volumes(options = {})
+      # Calls the ListVolumes API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:marker+ - (String)
+      #   * +:limit+ - (Integer)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+      #   * +Marker+ - (String)
+      #   * +VolumeInfos+ - (Array<Hash>)
+      #     * +VolumeARN+ - (String)
+      #     * +VolumeType+ - (String)
+
+      # @!method shutdown_gateway(options = {})
+      # Calls the ShutdownGateway API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method start_gateway(options = {})
+      # Calls the StartGateway API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method update_bandwidth_rate_limit(options = {})
+      # Calls the UpdateBandwidthRateLimit API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:average_upload_rate_limit_in_bits_per_sec+ - (Integer)
+      #   * +:average_download_rate_limit_in_bits_per_sec+ - (Integer)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method update_chap_credentials(options = {})
+      # Calls the UpdateChapCredentials API operation.
+      # @param [Hash] options
+      #   * +:target_arn+ - *required* - (String)
+      #   * +:secret_to_authenticate_initiator+ - *required* - (String)
+      #   * +:initiator_name+ - *required* - (String)
+      #   * +:secret_to_authenticate_target+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +TargetARN+ - (String)
+      #   * +InitiatorName+ - (String)
+
+      # @!method update_gateway_information(options = {})
+      # Calls the UpdateGatewayInformation API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:gateway_name+ - (String)
+      #   * +:gateway_timezone+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method update_gateway_software_now(options = {})
+      # Calls the UpdateGatewaySoftwareNow API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method update_maintenance_start_time(options = {})
+      # Calls the UpdateMaintenanceStartTime API operation.
+      # @param [Hash] options
+      #   * +:gateway_arn+ - *required* - (String)
+      #   * +:hour_of_day+ - *required* - (Integer)
+      #   * +:minute_of_hour+ - *required* - (Integer)
+      #   * +:day_of_week+ - *required* - (Integer)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +GatewayARN+ - (String)
+
+      # @!method update_snapshot_schedule(options = {})
+      # Calls the UpdateSnapshotSchedule API operation.
+      # @param [Hash] options
+      #   * +:volume_arn+ - *required* - (String)
+      #   * +:start_at+ - *required* - (Integer)
+      #   * +:recurrence_in_hours+ - *required* - (Integer)
+      #   * +:description+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +VolumeARN+ - (String)
+
+      ## end client methods ##
+
+    end
+  end
+end