aws-sdk-iam 1.0.0.rc1

data/lib/aws-sdk-iam/current_user.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 IAM
+    class CurrentUser
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(options = {})
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # The path to the user. For more information about paths, see [IAM
+      # Identifiers][1] in the *Using IAM* guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def path
+        data.path
+      end
+
+      # The friendly name identifying the user.
+      # @return [String]
+      def user_name
+        data.user_name
+      end
+
+      # The stable and unique string identifying the user. For more
+      # information about IDs, see [IAM Identifiers][1] in the *Using IAM*
+      # guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def user_id
+        data.user_id
+      end
+
+      # The Amazon Resource Name (ARN) that identifies the user. For more
+      # information about ARNs and how to use ARNs in policies, see [IAM
+      # Identifiers][1] in the *Using IAM* guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def arn
+        data.arn
+      end
+
+      # The date and time, in [ISO 8601 date-time format][1], when the user
+      # was created.
+      #
+      #
+      #
+      # [1]: http://www.iso.org/iso/iso8601
+      # @return [Time]
+      def create_date
+        data.create_date
+      end
+
+      # The date and time, in [ISO 8601 date-time format][1], when the user's
+      # password was last used to sign in to an AWS website. For a list of AWS
+      # websites that capture a user's last sign-in time, see the [Credential
+      # Reports][2] topic in the *Using IAM* guide. If a password is used more
+      # than once in a five-minute span, only the first use is returned in
+      # this field. This field is null (not present) when:
+      #
+      # * The user does not have a password
+      #
+      # * The password exists but has never been used (at least not since IAM
+      #   started tracking this information on October 20th, 2014
+      #
+      # * there is no sign-in data associated with the user
+      #
+      # This value is returned only in the GetUser and ListUsers actions.
+      #
+      #
+      #
+      # [1]: http://www.iso.org/iso/iso8601
+      # [2]: http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html
+      # @return [Time]
+      def password_last_used
+        data.password_last_used
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {CurrentUser}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     current_user.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_user
+        @data = resp.user
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::User]
+      #   Returns the data for this {CurrentUser}. Calls
+      #   {Client#get_user} 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 Associations
+
+      # @example Request syntax with placeholder values
+      #
+      #   accesskeys = current_user.access_keys({
+      #     user_name: "existingUserNameType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :user_name
+      #   The name of the user.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [AccessKey::Collection]
+      def access_keys(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_access_keys(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.access_key_metadata.each do |a|
+              batch << AccessKey.new(
+                user_name: a.user_name,
+                id: a.access_key_id,
+                data: a,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        AccessKey::Collection.new(batches)
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   mfadevices = current_user.mfa_devices({
+      #     user_name: "existingUserNameType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :user_name
+      #   The name of the user whose MFA devices you want to list.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [MfaDevice::Collection]
+      def mfa_devices(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_mfa_devices(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.mfa_devices.each do |m|
+              batch << MfaDevice.new(
+                user_name: m.user_name,
+                serial_number: m.serial_number,
+                data: m,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        MfaDevice::Collection.new(batches)
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   signingcertificates = current_user.signing_certificates({
+      #     user_name: "existingUserNameType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :user_name
+      #   The name of the IAM user whose signing certificates you want to
+      #   examine.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [SigningCertificate::Collection]
+      def signing_certificates(options = {})
+        batches = Enumerator.new do |y|
+          resp = @client.list_signing_certificates(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.certificates.each do |c|
+              batch << SigningCertificate.new(
+                user_name: c.user_name,
+                id: c.certificate_id,
+                data: c,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        SigningCertificate::Collection.new(batches)
+      end
+
+      # @return [User, nil]
+      def user
+        if data.user_name
+          User.new(
+            name: data.user_name,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {}
+      end
+      deprecated(:identifiers)
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+# customizations to generated classes
+require 'aws-sdk-iam/customizations/resource'

data/lib/aws-sdk-iam/customizations/resource.rb

@@ -0,0 +1,19 @@
+module Aws
+  module IAM
+    class Resource
+
+      # @return [Seahorse::Client::Response, false] Returns the response
+      #   from {Client#delete_account_alias} if an alias was deleted.
+      #   Returns `false` if this account had no alias to remove.
+      # @see Client#delete_account_alias
+      def delete_account_alias
+        if name = @client.list_account_aliases.account_aliases.first
+          @client.delete_account_alias(account_alias: name)
+        else
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/aws-sdk-iam/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 IAM
+    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-iam/group.rb

@@ -0,0 +1,459 @@
+# 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 IAM
+    class Group
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(name, options = {})
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :group_name :name
+
+      # The path to the group. For more information about paths, see [IAM
+      # Identifiers][1] in the *Using IAM* guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def path
+        data.path
+      end
+
+      # The stable and unique string identifying the group. For more
+      # information about IDs, see [IAM Identifiers][1] in the *Using IAM*
+      # guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def group_id
+        data.group_id
+      end
+
+      # The Amazon Resource Name (ARN) specifying the group. For more
+      # information about ARNs and how to use them in policies, see [IAM
+      # Identifiers][1] in the *Using IAM* guide.
+      #
+      #
+      #
+      # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      # @return [String]
+      def arn
+        data.arn
+      end
+
+      # The date and time, in [ISO 8601 date-time format][1], when the group
+      # was created.
+      #
+      #
+      #
+      # [1]: http://www.iso.org/iso/iso8601
+      # @return [Time]
+      def create_date
+        data.create_date
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Group}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     group.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.get_group(group_name: @name)
+        @data = resp.group
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::Group]
+      #   Returns the data for this {Group}. Calls
+      #   {Client#get_group} 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
+      #
+      #   group.add_user({
+      #     user_name: "existingUserNameType", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :user_name
+      #   The name of the user to add.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [EmptyStructure]
+      def add_user(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.add_user_to_group(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group.attach_policy({
+      #     policy_arn: "arnType", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :policy_arn
+      #   The Amazon Resource Name (ARN) of the IAM policy you want to attach.
+      #
+      #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
+      #   AWS Service Namespaces][1] in the *AWS General Reference*.
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+      # @return [EmptyStructure]
+      def attach_policy(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.attach_group_policy(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group = group.create({
+      #     path: "pathType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :path
+      #   The path to the group. For more information about paths, see [IAM
+      #   Identifiers][1] in the *IAM User Guide*.
+      #
+      #   This parameter is optional. If it is not included, it defaults to a
+      #   slash (/).
+      #
+      #   The [regex pattern][2] for this parameter is a string of characters
+      #   consisting of either a forward slash (/) by itself or a string that
+      #   must begin and end with forward slashes, containing any ASCII
+      #   character from the ! (\\u0021) thru the DEL character (\\u007F),
+      #   including most punctuation characters, digits, and upper and
+      #   lowercased letters.
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
+      #   [2]: http://wikipedia.org/wiki/regex
+      # @return [Group]
+      def create(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.create_group(options)
+        Group.new(
+          name: options[:group_name],
+          data: resp.data.group,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   grouppolicy = group.create_policy({
+      #     policy_name: "policyNameType", # required
+      #     policy_document: "policyDocumentType", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :policy_name
+      #   The name of the policy document.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @option options [required, String] :policy_document
+      #   The policy document.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of any printable ASCII character ranging from the space
+      #   character (\\u0020) through end of the ASCII character range
+      #   (\\u00FF). It also includes the special characters tab (\\u0009), line
+      #   feed (\\u000A), and carriage return (\\u000D).
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [GroupPolicy]
+      def create_policy(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.put_group_policy(options)
+        GroupPolicy.new(
+          group_name: @name,
+          name: options[:policy_name],
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group.delete()
+      # @param [Hash] options ({})
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.delete_group(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group.detach_policy({
+      #     policy_arn: "arnType", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :policy_arn
+      #   The Amazon Resource Name (ARN) of the IAM policy you want to detach.
+      #
+      #   For more information about ARNs, see [Amazon Resource Names (ARNs) and
+      #   AWS Service Namespaces][1] in the *AWS General Reference*.
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
+      # @return [EmptyStructure]
+      def detach_policy(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.detach_group_policy(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group.remove_user({
+      #     user_name: "existingUserNameType", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :user_name
+      #   The name of the user to remove.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [EmptyStructure]
+      def remove_user(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.remove_user_from_group(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   group = group.update({
+      #     new_path: "pathType",
+      #     new_group_name: "groupNameType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :new_path
+      #   New path for the IAM group. Only include this if changing the group's
+      #   path.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of either a forward slash (/) by itself or a string that
+      #   must begin and end with forward slashes, containing any ASCII
+      #   character from the ! (\\u0021) thru the DEL character (\\u007F),
+      #   including most punctuation characters, digits, and upper and
+      #   lowercased letters.
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @option options [String] :new_group_name
+      #   New name for the IAM group. Only include this if changing the group's
+      #   name.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of upper and lowercase alphanumeric characters with no
+      #   spaces. You can also include any of the following characters: =,.@-
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [Group]
+      def update(options = {})
+        options = options.merge(group_name: @name)
+        resp = @client.update_group(options)
+        Group.new(
+          name: options[:new_group_name],
+          client: @client
+        )
+      end
+
+      # @!group Associations
+
+      # @example Request syntax with placeholder values
+      #
+      #   attachedpolicies = group.attached_policies({
+      #     path_prefix: "policyPathType",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :path_prefix
+      #   The path prefix for filtering the results. This parameter is optional.
+      #   If it is not included, it defaults to a slash (/), listing all
+      #   policies.
+      #
+      #   The [regex pattern][1] for this parameter is a string of characters
+      #   consisting of either a forward slash (/) by itself or a string that
+      #   must begin and end with forward slashes, containing any ASCII
+      #   character from the ! (\\u0021) thru the DEL character (\\u007F),
+      #   including most punctuation characters, digits, and upper and
+      #   lowercased letters.
+      #
+      #
+      #
+      #   [1]: http://wikipedia.org/wiki/regex
+      # @return [Policy::Collection]
+      def attached_policies(options = {})
+        batches = Enumerator.new do |y|
+          options = options.merge(group_name: @name)
+          resp = @client.list_attached_group_policies(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.attached_policies.each do |a|
+              batch << Policy.new(
+                arn: a.policy_arn,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        Policy::Collection.new(batches)
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   policies = group.policies()
+      # @param [Hash] options ({})
+      # @return [GroupPolicy::Collection]
+      def policies(options = {})
+        batches = Enumerator.new do |y|
+          options = options.merge(group_name: @name)
+          resp = @client.list_group_policies(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.policy_names.each do |p|
+              batch << GroupPolicy.new(
+                group_name: @name,
+                name: p,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        GroupPolicy::Collection.new(batches)
+      end
+
+      # @param [String] name
+      # @return [GroupPolicy]
+      def policy(name)
+        GroupPolicy.new(
+          group_name: @name,
+          name: name,
+          client: @client
+        )
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   users = group.users()
+      # @param [Hash] options ({})
+      # @return [User::Collection]
+      def users(options = {})
+        batches = Enumerator.new do |y|
+          options = options.merge(group_name: @name)
+          resp = @client.get_group(options)
+          resp.each_page do |page|
+            batch = []
+            page.data.users.each do |u|
+              batch << User.new(
+                name: u.user_name,
+                data: u,
+                client: @client
+              )
+            end
+            y.yield(batch)
+          end
+        end
+        User::Collection.new(batches)
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { name: @name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_name(args, options)
+        value = args[0] || options.delete(:name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :name"
+        else
+          msg = "expected :name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end