aws-sdk-v1 1.52.0

data/lib/aws/emr/job_flow_collection.rb

@@ -0,0 +1,183 @@
+# Copyright 2011-2013 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 'date'
+require 'time'
+
+module AWS
+  class EMR
+
+    # # Creating a Job Flow
+    #
+    # Call {#create} to run a new job flow.
+    #
+    #     emr = AWS::EMR.new
+    #
+    #     job_flow = emr.job_flows.create('name',
+    #       :instances => {
+    #         :instance_count => 2,
+    #         :master_instance_type => 'm1.small',
+    #         :slave_instance_type => 'm1.small',
+    #       }
+    #     )
+    #
+    # # Getting a Job Flow
+    #
+    # You can get a job flow by its ID.
+    #
+    #     job_flow = emr.job_flows['j-123456678'] # makes no request
+    #     job_flow.exists? #=> true/false
+    #
+    # # Enumerating Job Flows
+    #
+    # You can enumerate all job flows, or filter them.
+    #
+    #     # all job flows
+    #     job_flows.each {|job_flow| ... }
+    #
+    #     # only job flows with a particular state
+    #     job_flows.with_state('ENDED').each {|job_flow| ... }
+    #
+    # The filtering methods include:
+    #
+    # * {#with_id}
+    # * {#with_state}
+    # * {#created_before}
+    # * {#created_after}
+    #
+    class JobFlowCollection
+
+      include Core::Collection::Simple
+
+      # @api private
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String] job_flow_id
+      # @return [JobFlow] Returns a {JobFlow} with the given ID.
+      def [] job_flow_id
+        JobFlow.new(job_flow_id, :config => config)
+      end
+
+      # Runs a job flow.
+      #
+      #     job_flow = emr.job_flows.create('name',
+      #       :instances => {
+      #         :instance_count => 2,
+      #         :master_instance_type => 'm1.small',
+      #         :slave_instance_type => 'm1.small',
+      #       }
+      #     )
+      #
+      # See {Client#run_job_flow} for documentation on the complete
+      # list of accepted options.
+      # @param [String] name
+      # @param [Hash] options
+      # @see (Client#run_job_flow)
+      # @return [JobFlow]
+      def create name, options = {}
+
+        options[:name] = name
+        options[:ami_version] ||= 'latest'
+        options[:instances] ||= {}
+
+        resp = client.run_job_flow(options)
+
+        self[resp.data[:job_flow_id]]
+
+      end
+      alias_method :run, :create
+
+      # Returns a new collection that will only enumerate job flows that have
+      # one of the given ids.
+      #
+      #     emr.job_flows.with_id('id1', 'id2', 'id3').each do |job_flow|
+      #       # ...
+      #     end
+      #
+      # @param [String] ids One or more job flow ids to use as a filter.
+      # @return [JobFlowCollection]
+      def with_id *ids
+        filter(:job_flow_ids, ids.flatten)
+      end
+
+      # Returns a new collection that will only enumerate job flows that have
+      # one of the given job flow states.
+      #
+      #     emr.job_flows.with_state('SHUTTING_DOWN', 'TERMINATED').each do |job|
+      #       # ...
+      #     end
+      #
+      # @param [String] states One or more job flow states to use as a filter.
+      # @return [JobFlowCollection]
+      def with_state *states
+        filter(:job_flow_states, states.flatten)
+      end
+
+      # Returns a new collection that will only enumerate job flows that
+      # were created before the given time.
+      #
+      #     # enumerate jobs that are more than an hour old
+      #     emr.job_flows.created_before(Time.now - 3600).each{|job| ... }
+      #
+      # @param [Time,DateTime,Date,Integer] time
+      # @return [JobFlowCollection]
+      def created_before time
+        filter(:created_before, time.to_i)
+      end
+
+      # Returns a new collection that will only enumerate job flows that
+      # were created after the given time.
+      #
+      #     # enumerate jobs that are at most 1 hour old
+      #     emr.job_flows.created_after(Time.now - 3600).each{|job| ... }
+      #
+      # @param [Time,DateTime,Date,Integer] time
+      # @return [JobFlowCollection]
+      def created_after time
+        filter(:created_after, time.to_i)
+      end
+
+      # @param [String,Symbol] name
+      # @param [Mixed] value
+      # @return [JobFlowCollection]
+      def filter name, value
+        options = {}
+        options[:filters] = @filters.merge(name.to_s.to_sym => value)
+        options[:config] = config
+        JobFlowCollection.new(options)
+      end
+
+      protected
+
+      def _each_item options = {}, &block
+
+        resp = client.describe_job_flows(@filters.merge(options))
+        resp.data[:job_flows].each do |details|
+
+          job_flow = JobFlow.new_from(
+            :describe_job_flows,
+            details,
+            details[:job_flow_id],
+            :config => config)
+
+          yield(job_flow)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/errors.rb

@@ -0,0 +1,162 @@
+# Copyright 2011-2013 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
+
+  # # Errors
+  #
+  # There are two basic types of errors:
+  #
+  # * {ClientError}
+  # * {ServerError}
+  #
+  # ## Client Errors
+  #
+  # Errors in the three and four hundreds are client errors ({ClientError}).
+  # A client error should not be resent without changes.  The body of the
+  # http response (the error #message) should give more information about
+  # the nature of the problem.
+  #
+  # ## Server Errors
+  #
+  # A 500 level error typically indicates the service is having an issue.
+  #
+  # Requests that generate service errors are automatically retried with
+  # an exponential backoff.  If the service still fails to respond with
+  # a 200 after 3 retries the error is raised.
+  #
+  module Errors
+
+    # Base class for all errors returned by the service.
+    class Base < StandardError
+
+      # @overload new(error_message)
+      #   @param [String] error_message The body of the error message
+      #
+      # @overload new(http_request, http_response, code = nil, message = nil)
+      #   @param [Http::Request] http_request
+      #   @param [Http::Response] http_response
+      #   @param [String] code (nil)
+      #   @param [String] message (nil)
+      #
+      def initialize req = nil, resp = nil, code = nil, message = nil
+        if req.is_a?(String) or req.nil?
+          super(req)
+        else
+          @http_request = req
+          @http_response = resp
+          @code = code
+          include_error_type
+          super(message || http_response.body)
+        end
+      end
+
+      # @return [String] The response code given by the service.
+      attr_reader :code
+
+      # @return [Http::Request] The low level http request that caused the
+      #   error to be raised.
+      attr_reader :http_request
+
+      # @return [Http::Response] The low level http response from the service
+      #   that wrapped the service error.
+      attr_reader :http_response
+
+      protected
+
+      # Extends the error object with {ServerError} or {ClientError}.
+      # This indicates if the request should be retried (server errors)
+      # or not (client errors).
+      def include_error_type
+        if http_response.status >= 500
+          extend ServerError
+        else
+          extend ClientError
+        end
+      end
+
+    end
+
+    # Provides the ability to instantiate instances of {ServerError} and
+    # {ClientError}.
+    # @api private
+    module ExceptionMixinClassMethods
+      def new(*args)
+        e = Base.new(*args)
+        e.extend(self)
+        e
+      end
+    end
+
+    # Raised when an error occurs as a result of bad client
+    # behavior, most commonly when the parameters passed to a method
+    # are somehow invalid.  Other common cases:
+    #
+    # * Throttling errors
+    # * Bad credentials
+    # * No permission to do the requested operation
+    # * Limits exceeded (e.g. too many buckets)
+    #
+    module ClientError
+      extend ExceptionMixinClassMethods
+    end
+
+    # Raised when an AWS service is unable to handle the request.  These
+    # are automatically retired.  If after 3 retries the request is still
+    # failing, then the error is raised.
+    module ServerError
+      extend ExceptionMixinClassMethods
+    end
+
+    # Raised when AWS credentials could not be found.
+    class MissingCredentialsError < StandardError
+
+      def initialize msg = nil
+        msg ||= <<-MSG
+
+Missing Credentials.
+
+Unable to find AWS credentials.  You can configure your AWS credentials
+a few different ways:
+
+* Call AWS.config with :access_key_id and :secret_access_key
+
+* Export AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to ENV
+
+* On EC2 you can run instances with an IAM instance profile and credentials
+  will be auto loaded from the instance metadata service on those
+  instances.
+
+* Call AWS.config with :credential_provider.  A credential provider should
+  either include AWS::Core::CredentialProviders::Provider or respond to
+  the same public methods.
+
+= Ruby on Rails
+
+In a Ruby on Rails application you may also specify your credentials in
+the following ways:
+
+* Via a config initializer script using any of the methods mentioned above
+  (e.g. RAILS_ROOT/config/initializers/aws-sdk.rb).
+
+* Via a yaml configuration file located at RAILS_ROOT/config/aws.yml.
+  This file should be formated like the default RAILS_ROOT/config/database.yml
+  file.
+
+MSG
+        super(msg)
+      end
+    end
+
+  end
+end

data/lib/aws/glacier.rb

@@ -0,0 +1,79 @@
+# Copyright 2011-2013 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/glacier/config'
+
+module AWS
+
+  # This class is the starting point for working with Amazon Glacier.
+  #
+  # To use Amazon Glacier you must first
+  # [sign up here](http://aws.amazon.com/glacier/).
+  #
+  # For more information about Amazon Glacier:
+  #
+  # * [Amazon Glacier](http://aws.amazon.com/glacier/)
+  # * [Amazon Glacier Documentation](http://aws.amazon.com/documentation/glacier/)
+  #
+  # # 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::Glacier interface:
+  #
+  #     glacier = AWS::Glacier.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # See {Client} for documentation on all of the supported API operations.
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level Glacier client object
+  class Glacier
+
+    autoload :Archive, 'aws/glacier/archive'
+    autoload :ArchiveCollection, 'aws/glacier/archive_collection'
+    autoload :Client, 'aws/glacier/client'
+    autoload :Errors, 'aws/glacier/errors'
+    autoload :Resource, 'aws/glacier/resource'
+    autoload :Vault, 'aws/glacier/vault'
+    autoload :VaultCollection, 'aws/glacier/vault_collection'
+    autoload :VaultNotificationConfiguration, 'aws/glacier/vault_notification_configuration'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'glacier'
+
+    # @option options[String] :account_id ('-')
+    def initialize options = {}
+      @account_id = options[:account_id] || '-'
+      super
+    end
+
+    # @return [String]
+    attr_accessor :account_id
+
+    # @return [VaultCollection] Returns a collection for working with
+    #   vaults that belong to this account.
+    def vaults
+      VaultCollection.new(:config => config, :account_id => account_id)
+    end
+
+  end
+end

data/lib/aws/glacier/archive.rb

@@ -0,0 +1,56 @@
+# Copyright 2011-2013 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 Glacier
+
+    class Archive < Resource
+
+      # @param [Vault] vault
+      # @param [String] archive_id
+      # @param [Hash] options
+      # @option options [String] :account_id
+      def initialize vault, archive_id, options = {}
+        @vault = vault
+        @archive_id = archive_id
+        super
+      end
+
+      # @return [Vault]
+      attr_reader :vault
+
+      # @return [String]
+      attr_reader :archive_id
+
+      alias_method :id, :archive_id
+
+      # Deletes the current archive.
+      # @return [nil]
+      def delete
+        client.delete_archive(resource_options)
+        nil
+      end
+
+      protected
+
+      def resource_identifiers
+        [
+          [:vault_name, vault.name],
+          [:archive_id, archive_id],
+          [:account_id, account_id],
+        ]
+      end
+
+    end
+  end
+end