aws-sdk-v1 1.52.0

data/lib/aws/storage_gateway.rb

@@ -0,0 +1,72 @@
+# 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/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.
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level StorageGateway client object
+  class StorageGateway
+
+    autoload :Client, 'aws/storage_gateway/client'
+    autoload :Errors, 'aws/storage_gateway/errors'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'storagegateway'
+
+  end
+end

data/lib/aws/storage_gateway/client.rb

@@ -0,0 +1,42 @@
+# 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 StorageGateway
+
+    # Client class for AWS Storage Gateway.
+    class Client < Core::JSONClient
+
+      API_VERSION = '2013-06-30'
+
+      signature_version :Version4, 'storagegateway'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+    end
+
+    class Client::V20120630 < Client
+
+      define_client_methods('2012-06-30')
+
+    end
+
+    class Client::V20130630 < Client
+
+      define_client_methods('2013-06-30')
+
+    end
+
+  end
+end

data/lib/aws/storage_gateway/config.rb

@@ -0,0 +1,18 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'StorageGateway', 'storage_gateway', 'storagegateway'
+
+end

data/lib/aws/storage_gateway/errors.rb

@@ -0,0 +1,22 @@
+# 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 StorageGateway
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/sts.rb

@@ -0,0 +1,164 @@
+# 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/sts/config'
+
+module AWS
+
+  # This class is a starting point for working with the AWS Security
+  # Token Service.  The AWS Security Token Service is a web service
+  # that enables you to request temporary, limited-privilege
+  # credentials for users that you authenticate (federated users), or
+  # IAM users.
+  #
+  # @example Getting temporary credentials and using them to make an EC2 request
+  #
+  #   sts = AWS::STS.new(:access_key_id => "LONG_TERM_KEY",
+  #                      :secret_access_key => "LONG_TERM_SECRET")
+  #   session = sts.new_session(:duration => 60*60)
+  #   ec2 = AWS::EC2.new(session.credentials)
+  #   ec2.instances.to_a
+  #
+  # @example Getting temporary credentials with restricted permissions
+  #
+  #   policy = AWS::STS::Policy.new
+  #   policy.allow(:actions => ["s3:*", "ec2:*"],
+  #                :resources => :any)
+  #   session = sts.new_federated_session("TemporaryUser", :policy => policy)
+  #   ec2 = AWS::EC2.new(session.credentials)
+  #   ec2.instances.to_a
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level STS client object
+  class STS
+
+    autoload :Client, 'aws/sts/client'
+    autoload :Errors, 'aws/sts/errors'
+    autoload :FederatedSession, 'aws/sts/federated_session'
+    autoload :Policy, 'aws/sts/policy'
+    autoload :Session, 'aws/sts/session'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'sts', :global => true
+
+    # (see Client#assume_role)
+    def assume_role options = {}
+      client.assume_role(options).data
+    end
+
+    # Returns a set of temporary credentials for an AWS account or IAM
+    # User. The credentials consist of an Access Key ID, a Secret
+    # Access Key, and a security token. These credentials are valid
+    # for the specified duration only. The session duration for IAM
+    # users can be between one and 36 hours, with a default of 12
+    # hours. The session duration for AWS account owners is restricted
+    # to one hour.
+    #
+    # @param [Hash] opts Options for getting temporary credentials.
+    #
+    # @option opts [Integer] :duration The duration, in seconds, that
+    #   the session should last. Acceptable durations for IAM user
+    #   sessions range from 3600s (one hour) to 129600s (36 hours),
+    #   with 43200s (12 hours) as the default. Sessions for AWS
+    #   account owners are restricted to a maximum of 3600s (one
+    #   hour).
+    #
+    # @option opts [String] :serial_number The identification number of the
+    #   Multi-Factor Authentication (MFA) device for the user.
+    #
+    # @option opts [String] :token_code The value provided by the MFA device.
+    #   If the user has an access policy requiring an MFA code, provide the
+    #   value here to get permission to resources as specified in the access
+    #   policy.
+    #
+    # @return [Session]
+    def new_session(opts = {})
+      get_session(:get_session_token, opts) do |resp, session_opts|
+        Session.new(session_opts)
+      end
+    end
+
+    # Returns a set of temporary credentials for a federated user with
+    # the user name and policy specified in the request. The
+    # credentials consist of an Access Key ID, a Secret Access Key,
+    # and a security token. The credentials are valid for the
+    # specified duration, between one and 36 hours.
+    #
+    # The federated user who holds these credentials has only those
+    # permissions allowed by intersection of the specified policy and
+    # any resource or user policies that apply to the caller of the
+    # GetFederationToken API. For more information about how token
+    # permissions work, see
+    # {http://docs.amazonwebservices.com/IAM/latest/UserGuide/TokenPermissions.html
+    # Controlling Token Permissions} in Using AWS Identity and Access
+    # Management.
+    #
+    # @param [String] name The name of the federated user associated
+    #   with the session.  Must be between 2 and 32 characters in
+    #   length.
+    #
+    # @param [Hash] opts Options for getting temporary credentials.
+    #
+    # @option opts [Integer] :duration The duration, in seconds, that
+    #   the session should last. Acceptable durations for federation
+    #   sessions range from 3600s (one hour) to 129600s (36 hours),
+    #   with one hour as the default.
+    #
+    # @option opts [String, AWS::STS::Policy] :policy A policy
+    #   specifying the permissions to associate with the session. The
+    #   caller can delegate their own permissions by specifying a
+    #   policy for the session, and both policies will be checked when
+    #   a service call is made. In other words, permissions of the
+    #   session credentials are the intersection of the policy
+    #   specified in the API and the policies associated with the user
+    #   who issued the session.
+    #
+    # @return [FederatedSession]
+    #
+    def new_federated_session(name, opts = {})
+      opts = opts.merge(:name => name)
+      case
+      when opts[:policy].kind_of?(String) || !opts[:policy]
+        # leave it alone
+      when opts[:policy].respond_to?(:to_json)
+        opts[:policy] = opts[:policy].to_json
+      end
+      get_session(:get_federation_token, opts) do |resp, session_opts|
+        session_opts.merge!(
+          :user_id => resp[:federated_user][:federated_user_id],
+          :user_arn => resp[:federated_user][:arn],
+          :packed_policy_size => resp[:packed_policy_size]
+        )
+        FederatedSession.new(session_opts)
+      end
+    end
+
+    protected
+
+    def get_session(method, opts = {})
+      opts[:duration_seconds] = opts.delete(:duration) if
+        opts[:duration]
+      resp = client.send(method, opts)
+      credentials = resp[:credentials].dup
+      session_opts = {
+        :credentials => credentials,
+        :expires_at => credentials.delete(:expiration),
+      }
+      yield(resp, session_opts)
+    end
+
+  end
+
+end

data/lib/aws/sts/client.rb

@@ -0,0 +1,55 @@
+# 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 STS
+
+    # Client class for AWS Security Token Service (STS).
+    class Client < Core::QueryClient
+
+      API_VERSION = '2011-06-15'
+
+      signature_version :Version4, 'sts'
+
+      REGION_US_E1 = 'sts.amazonaws.com'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+      def initialize *args
+        super
+        unless config.use_ssl?
+          msg = 'AWS Security Token Service (STS) requires ssl but the ' +
+            ':use_ssl option is set to false.  Try passing :use_ssl => true'
+          raise ArgumentError, msg
+        end
+      end
+
+      # Two STS operations are un-signed
+      alias do_sign_request sign_request
+      def sign_request(req)
+        action = req.params.find { |param| param.name == 'Action' }.value
+        unsigned = %w( AssumeRoleWithWebIdentity AssumeRoleWithSAML )
+        do_sign_request(req) unless unsigned.include?(action)
+        req
+      end
+
+    end
+
+    class Client::V20110615 < Client
+
+      define_client_methods('2011-06-15')
+
+    end
+  end
+end

data/lib/aws/sts/config.rb

@@ -0,0 +1,18 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'STS', 'sts', 'sts'
+
+end

data/lib/aws/sts/errors.rb

@@ -0,0 +1,22 @@
+# 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 STS
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/sts/federated_session.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 STS
+
+    # Represents a federated session using temporary AWS credentials.
+    # Use {STS#new_federated_session} to get an instance of this
+    # class.
+    class FederatedSession < Session
+
+      # The string identifying the federated user associated with the
+      # session, similar to the UserId of an IAM user.
+      #
+      # @return [String]
+      attr_reader :user_id
+
+      # The ARN specifying the federated user associated with the
+      # session. For more information about ARNs and how to use them
+      # in policies, see
+      # {http://docs.amazonwebservices.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html
+      # Identifiers for IAM Entities} in <i>Using AWS Identity and
+      # Access Management</i>.
+      #
+      # @return [String]
+      attr_reader :user_arn
+
+      # A percentage value indicating the size of the policy in packed
+      # form. Policies for which the packed size is greater than 100%
+      # of the allowed value are rejected by the service.
+      #
+      # @return [Integer]
+      attr_reader :packed_policy_size
+
+      # @api private
+      def initialize(opts = {})
+        @user_id = opts[:user_id]
+        @user_arn = opts[:user_arn]
+        @packed_policy_size = opts[:packed_policy_size]
+        super
+      end
+
+    end
+
+  end
+end