File: initiate_job.rb

package info (click to toggle)
ruby-fog-aws 3.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,140 kB
  • sloc: ruby: 73,328; javascript: 14; makefile: 9; sh: 4
file content (39 lines) | stat: -rw-r--r-- 1,547 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
module Fog
  module AWS
    class Glacier
      class Real
        # This operation initates a multipart upload of an archive to a vault
        #
        # ==== Parameters
        # * name<~String> The vault name
        # * job_specification<~Hash> A specification of the job
        #    * Type<~String> The job type. Mandatory. Values: archive-retrieval, inventory-retrieval
        #    * Description<~String> The job description
        #    * ArchiveId<~String> The id of the archive to retrieve (only for Type==archive-retrieval)
        #    * Format<~String> The format to return (only for inventory retrieval). Values: CSV, JSON
        #    * SNSTopic<String> ARN of a topic to publish to when the job is complete
        # * options<~Hash>
        #   * account_id<~String> - The AWS account id. Defaults to the account owning the credentials making the request
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        #
        # ==== See Also
        # http://docs.amazonwebservices.com/amazonglacier/latest/dev/api-initiate-job-post.html
        #
        def initiate_job(name, job_specification, options={})
          account_id = options['account_id'] || '-'
          path = "/#{account_id}/vaults/#{Fog::AWS.escape(name)}/jobs"

          request({
            :expects  => 202,
            :headers => {},
            :method   => 'POST',
            :path     => path,
            :body     => Fog::JSON.encode(job_specification)
          })
        end
      end
    end
  end
end