aws-sdk-glacier 1.0.0.rc1

data/lib/aws-sdk-glacier/customizations.rb

@@ -0,0 +1,7 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+

data/lib/aws-sdk-glacier/errors.rb

@@ -0,0 +1,23 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Glacier
+    module Errors
+
+      extend Aws::Errors::DynamicErrors
+
+      # Raised when calling #load or #data on a resource class that can not be
+      # loaded.  This can happen when:
+      #
+      # * A resource class has identifiers, but no data attributes.
+      # * Resource data is only available when making an API call that
+      # enumerates all resources of that type.
+      class ResourceNotLoadable < RuntimeError; end
+    end
+  end
+end

data/lib/aws-sdk-glacier/job.rb

@@ -0,0 +1,345 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Glacier
+    class Job
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(account_id, vault_name, id, options = {})
+      #   @param [String] account_id
+      #   @param [String] vault_name
+      #   @param [String] id
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :account_id
+      #   @option options [required, String] :vault_name
+      #   @option options [required, String] :id
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @account_id = extract_account_id(args, options)
+        @vault_name = extract_vault_name(args, options)
+        @id = extract_id(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def account_id
+        @account_id
+      end
+
+      # @return [String]
+      def vault_name
+        @vault_name
+      end
+
+      # @return [String]
+      def id
+        @id
+      end
+      alias :job_id :id
+
+      # The job description you provided when you initiated the job.
+      # @return [String]
+      def job_description
+        data.job_description
+      end
+
+      # The job type. It is either ArchiveRetrieval or InventoryRetrieval.
+      # @return [String]
+      def action
+        data.action
+      end
+
+      # For an ArchiveRetrieval job, this is the archive ID requested for
+      # download. Otherwise, this field is null.
+      # @return [String]
+      def archive_id
+        data.archive_id
+      end
+
+      # The Amazon Resource Name (ARN) of the vault from which the archive
+      # retrieval was requested.
+      # @return [String]
+      def vault_arn
+        data.vault_arn
+      end
+
+      # The UTC date when the job was created. A string representation of ISO
+      # 8601 date format, for example, "2012-03-20T17:03:43.221Z".
+      # @return [Time]
+      def creation_date
+        data.creation_date
+      end
+
+      # The job status. When a job is completed, you get the job's output.
+      # @return [Boolean]
+      def completed
+        data.completed
+      end
+
+      # The status code can be InProgress, Succeeded, or Failed, and indicates
+      # the status of the job.
+      # @return [String]
+      def status_code
+        data.status_code
+      end
+
+      # A friendly message that describes the job status.
+      # @return [String]
+      def status_message
+        data.status_message
+      end
+
+      # For an ArchiveRetrieval job, this is the size in bytes of the archive
+      # being requested for download. For the InventoryRetrieval job, the
+      # value is null.
+      # @return [Integer]
+      def archive_size_in_bytes
+        data.archive_size_in_bytes
+      end
+
+      # For an InventoryRetrieval job, this is the size in bytes of the
+      # inventory requested for download. For the ArchiveRetrieval job, the
+      # value is null.
+      # @return [Integer]
+      def inventory_size_in_bytes
+        data.inventory_size_in_bytes
+      end
+
+      # An Amazon Simple Notification Service (Amazon SNS) topic that receives
+      # notification.
+      # @return [String]
+      def sns_topic
+        data.sns_topic
+      end
+
+      # The UTC time that the archive retrieval request completed. While the
+      # job is in progress, the value will be null.
+      # @return [Time]
+      def completion_date
+        data.completion_date
+      end
+
+      # For an ArchiveRetrieval job, it is the checksum of the archive.
+      # Otherwise, the value is null.
+      #
+      # The SHA256 tree hash value for the requested range of an archive. If
+      # the Initiate a Job request for an archive specified a tree-hash
+      # aligned range, then this field returns a value.
+      #
+      # For the specific case when the whole archive is retrieved, this value
+      # is the same as the ArchiveSHA256TreeHash value.
+      #
+      # This field is null in the following situations:
+      #
+      # * Archive retrieval jobs that specify a range that is not tree-hash
+      #   aligned.
+      #
+      # ^
+      # ^
+      #
+      # * Archival jobs that specify a range that is equal to the whole
+      #   archive and the job status is InProgress.
+      #
+      # ^
+      # ^
+      #
+      # * Inventory jobs.
+      #
+      # ^
+      # @return [String]
+      def sha256_tree_hash
+        data.sha256_tree_hash
+      end
+
+      # The SHA256 tree hash of the entire archive for an archive retrieval.
+      # For inventory retrieval jobs, this field is null.
+      # @return [String]
+      def archive_sha256_tree_hash
+        data.archive_sha256_tree_hash
+      end
+
+      # The retrieved byte range for archive retrieval jobs in the form
+      # "*StartByteValue*-*EndByteValue*" If no range was specified in the
+      # archive retrieval, then the whole archive is retrieved and
+      # *StartByteValue* equals 0 and *EndByteValue* equals the size of the
+      # archive minus 1. For inventory retrieval jobs this field is null.
+      # @return [String]
+      def retrieval_byte_range
+        data.retrieval_byte_range
+      end
+
+      # The retrieval option to use for the archive retrieval. Valid values
+      # are `Expedited`, `Standard`, or `Bulk`. `Standard` is the default.
+      # @return [String]
+      def tier
+        data.tier
+      end
+
+      # Parameters used for range inventory retrieval.
+      # @return [Types::InventoryRetrievalJobDescription]
+      def inventory_retrieval_parameters
+        data.inventory_retrieval_parameters
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Job}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     job.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_job(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          job_id: @id
+        )
+        @data = resp.data
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::GlacierJobDescription]
+      #   Returns the data for this {Job}. Calls
+      #   {Client#describe_job} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   job.get_output({
+      #     range: "string",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :range
+      #   The range of bytes to retrieve from the output. For example, if you
+      #   want to download the first 1,048,576 bytes, specify the range as
+      #   `bytes=0-1048575`. By default, this operation downloads the entire
+      #   output.
+      #
+      #   If the job output is large, then you can use a range to retrieve a
+      #   portion of the output. This allows you to download the entire output
+      #   in smaller chunks of bytes. For example, suppose you have 1 GB of job
+      #   output you want to download and you decide to download 128 MB chunks
+      #   of data at a time, which is a total of eight Get Job Output requests.
+      #   You use the following process to download the job output:
+      #
+      #   1.  Download a 128 MB chunk of output by specifying the appropriate
+      #       byte range. Verify that all 128 MB of data was received.
+      #
+      #   2.  Along with the data, the response includes a SHA256 tree hash of
+      #       the payload. You compute the checksum of the payload on the client
+      #       and compare it with the checksum you received in the response to
+      #       ensure you received all the expected data.
+      #
+      #   3.  Repeat steps 1 and 2 for all the eight 128 MB chunks of output
+      #       data, each time specifying the appropriate byte range.
+      #
+      #   4.  After downloading all the parts of the job output, you have a list
+      #       of eight checksum values. Compute the tree hash of these values to
+      #       find the checksum of the entire output. Using the DescribeJob API,
+      #       obtain job information of the job that provided you the output.
+      #       The response includes the checksum of the entire archive stored in
+      #       Amazon Glacier. You compare this value with the checksum you
+      #       computed to ensure you have downloaded the entire archive content
+      #       with no errors.
+      # @return [Types::GetJobOutputOutput]
+      def get_output(options = {})
+        options = options.merge(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          job_id: @id
+        )
+        resp = @client.get_job_output(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Vault]
+      def vault
+        Vault.new(
+          account_id: @account_id,
+          name: @vault_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          account_id: @account_id,
+          vault_name: @vault_name,
+          id: @id
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_account_id(args, options)
+        value = args[0] || options.delete(:account_id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :account_id"
+        else
+          msg = "expected :account_id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_vault_name(args, options)
+        value = args[1] || options.delete(:vault_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :vault_name"
+        else
+          msg = "expected :vault_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_id(args, options)
+        value = args[2] || options.delete(:id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :id"
+        else
+          msg = "expected :id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

data/lib/aws-sdk-glacier/multipart_upload.rb

@@ -0,0 +1,269 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module Glacier
+    class MultipartUpload
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(account_id, vault_name, id, options = {})
+      #   @param [String] account_id
+      #   @param [String] vault_name
+      #   @param [String] id
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :account_id
+      #   @option options [required, String] :vault_name
+      #   @option options [required, String] :id
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @account_id = extract_account_id(args, options)
+        @vault_name = extract_vault_name(args, options)
+        @id = extract_id(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def account_id
+        @account_id
+      end
+
+      # @return [String]
+      def vault_name
+        @vault_name
+      end
+
+      # @return [String]
+      def id
+        @id
+      end
+      alias :multipart_upload_id :id
+
+      # The Amazon Resource Name (ARN) of the vault that contains the archive.
+      # @return [String]
+      def vault_arn
+        data.vault_arn
+      end
+
+      # The description of the archive that was specified in the Initiate
+      # Multipart Upload request.
+      # @return [String]
+      def archive_description
+        data.archive_description
+      end
+
+      # The part size, in bytes, specified in the Initiate Multipart Upload
+      # request. This is the size of all the parts in the upload except the
+      # last part, which may be smaller than this size.
+      # @return [Integer]
+      def part_size_in_bytes
+        data.part_size_in_bytes
+      end
+
+      # The UTC time at which the multipart upload was initiated.
+      # @return [Time]
+      def creation_date
+        data.creation_date
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # @raise [Errors::ResourceNotLoadable]
+      # @api private
+      def load
+        msg = "#load is not implemented, data only available via enumeration"
+        raise Errors::ResourceNotLoadable, msg
+      end
+      alias :reload :load
+
+      # @raise [Errors::ResourceNotLoadableError] Raises when {#data_loaded?} is `false`.
+      # @return [Types::UploadListElement]
+      #   Returns the data for this {MultipartUpload}.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   multipart_upload.abort()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def abort(options = {})
+        options = options.merge(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          upload_id: @id
+        )
+        resp = @client.abort_multipart_upload(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   multipart_upload.complete({
+      #     archive_size: 1,
+      #     checksum: "string",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [Integer] :archive_size
+      #   The total size, in bytes, of the entire archive. This value should be
+      #   the sum of all the sizes of the individual parts that you uploaded.
+      # @option options [String] :checksum
+      #   The SHA256 tree hash of the entire archive. It is the tree hash of
+      #   SHA256 tree hash of the individual parts. If the value you specify in
+      #   the request does not match the SHA256 tree hash of the final assembled
+      #   archive as computed by Amazon Glacier, Amazon Glacier returns an error
+      #   and the request fails.
+      # @return [Types::ArchiveCreationOutput]
+      def complete(options = {})
+        options = options.merge(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          upload_id: @id
+        )
+        resp = @client.complete_multipart_upload(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   multipart_upload.parts({
+      #     marker: "string",
+      #     limit: 1,
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :marker
+      #   An opaque string used for pagination. This value specifies the part at
+      #   which the listing of parts should begin. Get the marker value from the
+      #   response of a previous List Parts response. You need only include the
+      #   marker if you are continuing the pagination of results started in a
+      #   previous List Parts request.
+      # @option options [Integer] :limit
+      #   The maximum number of parts to be returned. The default limit is 1000.
+      #   The number of parts returned might be fewer than the specified limit,
+      #   but the number of returned parts never exceeds the limit.
+      # @return [Types::ListPartsOutput]
+      def parts(options = {})
+        options = options.merge(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          upload_id: @id
+        )
+        resp = @client.list_parts(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   multipart_upload.upload_part({
+      #     checksum: "string",
+      #     range: "string",
+      #     body: "data",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :checksum
+      #   The SHA256 tree hash of the data being uploaded.
+      # @option options [String] :range
+      #   Identifies the range of bytes in the assembled archive that will be
+      #   uploaded in this part. Amazon Glacier uses this information to
+      #   assemble the archive in the proper sequence. The format of this header
+      #   follows RFC 2616. An example header is Content-Range:bytes
+      #   0-4194303/*.
+      # @option options [String, IO] :body
+      #   The data to upload.
+      # @return [Types::UploadMultipartPartOutput]
+      def upload_part(options = {})
+        options = options.merge(
+          account_id: @account_id,
+          vault_name: @vault_name,
+          upload_id: @id
+        )
+        resp = @client.upload_multipart_part(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [Vault]
+      def vault
+        Vault.new(
+          account_id: @account_id,
+          name: @vault_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          account_id: @account_id,
+          vault_name: @vault_name,
+          id: @id
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_account_id(args, options)
+        value = args[0] || options.delete(:account_id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :account_id"
+        else
+          msg = "expected :account_id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_vault_name(args, options)
+        value = args[1] || options.delete(:vault_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :vault_name"
+        else
+          msg = "expected :vault_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_id(args, options)
+        value = args[2] || options.delete(:id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :id"
+        else
+          msg = "expected :id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end