Initialize connection to IAM
options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection
iam = IAM.new( :aws_access_key_id => your_aws_access_key_id, :aws_secret_access_key => your_aws_secret_access_key )
options<~Hash> - config arguments for connection. Defaults to {}.
# File lib/fog/aws/iam.rb, line 150 def initialize(options={}) require 'fog/core/parser' @aws_access_key_id = options[:aws_access_key_id] @aws_secret_access_key = options[:aws_secret_access_key] @connection_options = options[:connection_options] || {} @instrumentor = options[:instrumentor] @instrumentor_name = options[:instrumentor_name] || 'fog.aws.iam' @hmac = Fog::HMAC.new('sha256', @aws_secret_access_key) @host = options[:host] || 'iam.amazonaws.com' @path = options[:path] || '/' @persistent = options[:persistent] || false @port = options[:port] || 443 @scheme = options[:scheme] || 'https' @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}#{@path}", @persistent, @connection_options) end
Add a role to an instance profile
instance_profile_name<~String>: Name of the instance profile to update.
role_name<~String>:Name of the role to add.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_AddRoleToInstanceProfile.html
# File lib/fog/aws/requests/iam/add_role_to_instance_profile.rb, line 22 def add_role_to_instance_profile(role_name, instance_profile_name) request( 'Action' => 'AddRoleToInstanceProfile', 'InstanceProfileName' => instance_profile_name, 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Add a user to a group
group_name<~String>: name of the group
user_name<~String>: name of user to add
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_AddUserToGroup.html
# File lib/fog/aws/requests/iam/add_user_to_group.rb, line 22 def add_user_to_group(group_name, user_name) request( 'Action' => 'AddUserToGroup', 'GroupName' => group_name, 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Create a access keys for user (by default detects user from access credentials)
options<~Hash>:
'UserName'<~String> - name of the user to create (do not include path)
response<~Excon::Response>:
body<~Hash>:
'AccessKey'<~Hash>:
'AccessKeyId'<~String> -
'UserName'<~String> -
'SecretAccessKey'<~String> -
'Status'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateAccessKey.html
# File lib/fog/aws/requests/iam/create_access_key.rb, line 27 def create_access_key(options = {}) request({ 'Action' => 'CreateAccessKey', :parser => Fog::Parsers::AWS::IAM::CreateAccessKey.new }.merge!(options)) end
# File lib/fog/aws/requests/iam/create_account_alias.rb, line 8 def create_account_alias(account_alias) request( 'Action' => 'CreateAccountAlias', 'AccountAlias' => account_alias, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Create a new group
group_name<~String>: name of the group to create (do not include path)
path<~String>: optional path to group, defaults to '/'
response<~Excon::Response>:
body<~Hash>:
'Group'<~Hash>:
Arn<~String> -
GroupId<~String> -
GroupName<~String> -
Path<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateGroup.html
# File lib/fog/aws/requests/iam/create_group.rb, line 27 def create_group(group_name, path = '/') request( 'Action' => 'CreateGroup', 'GroupName' => group_name, 'Path' => path, :parser => Fog::Parsers::AWS::IAM::CreateGroup.new ) end
Create a new instance_profile
instance_profile_name<~String>: name of the instance profile to create (do not include path)
path<~String>: optional path to group, defaults to '/'
response<~Excon::Response>:
body<~Hash>:
'InstanceProfile'<~Hash>:
Arn<~String> -
CreateDate<~Date>
InstanceProfileId<~String> -
InstanceProfileName<~String> -
Path<~String> -
Roles<~Array> - role<~Hash>:
* 'Arn'<~String> - * 'AssumeRolePolicyDocument'<~String< * 'Path'<~String> - * 'RoleId'<~String> - * 'RoleName'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateInstanceProfile.html
# File lib/fog/aws/requests/iam/create_instance_profile.rb, line 35 def create_instance_profile(instance_profile_name, path='/', options={}) request({ 'Action' => 'CreateInstanceProfile', 'InstanceProfileName' => instance_profile_name, 'Path' => path, :parser => Fog::Parsers::AWS::IAM::InstanceProfile.new }.merge!(options)) end
Creates a login profile for a user
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateLoginProfile.html
user_name<~String> - Name of user to create a login profile for
password<~String> - The new password for this user
response<~Excon::Response>:
body<~Hash>:
'LoginProfile'<~Hash>
* UserName<~String> * CreateDate
'RequestId'<~String> - Id of the request
# File lib/fog/aws/requests/iam/create_login_profile.rb, line 24 def create_login_profile(user_name, password) request({ 'Action' => 'CreateLoginProfile', 'UserName' => user_name, 'Password' => password, :parser => Fog::Parsers::AWS::IAM::LoginProfile.new }) end
Creates a new role for your AWS account
RoleName<~String>: name of the role to create
AssumeRolePolicyDocument<~String>: The policy that grants an entity permission to assume the role.
Path<~String>: This parameter is optional. If it is not included, it defaults to a slash (/).
response<~Excon::Response>:
body<~Hash>:
'Role'<~Hash>:
'Arn'<~String> -
'AssumeRolePolicyDocument'<~String<
'Path'<~String> -
'RoleId'<~String> -
'RoleName'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateRole.html
# File lib/fog/aws/requests/iam/create_role.rb, line 43 def create_role(role_name, assume_role_policy_document, path = '/') request( 'Action' => 'CreateRole', 'RoleName' => role_name, 'AssumeRolePolicyDocument' => assume_role_policy_document, 'Path' => path, :parser => Fog::Parsers::AWS::IAM::SingleRole.new ) end
Create a new user
user_name<~String>: name of the user to create (do not include path)
path<~String>: optional path to group, defaults to '/'
response<~Excon::Response>:
body<~Hash>:
'User'<~Hash>:
'Arn'<~String> -
'Path'<~String> -
'UserId'<~String> -
'UserName'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateUser.html
# File lib/fog/aws/requests/iam/create_user.rb, line 27 def create_user(user_name, path = '/') request( 'Action' => 'CreateUser', 'UserName' => user_name, 'Path' => path, :parser => Fog::Parsers::AWS::IAM::CreateUser.new ) end
Delete an access key
access_key_id<~String> - Access key id to delete
options<~Hash>:
'UserName'<~String> - name of the user to create (do not include path)
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteAccessKey.html
# File lib/fog/aws/requests/iam/delete_access_key.rb, line 23 def delete_access_key(access_key_id, options = {}) request({ 'AccessKeyId' => access_key_id, 'Action' => 'DeleteAccessKey', :parser => Fog::Parsers::AWS::IAM::Basic.new }.merge!(options)) end
# File lib/fog/aws/requests/iam/delete_account_alias.rb, line 8 def delete_account_alias(account_alias) request( 'Action' => 'DeleteAccountAlias', 'AccountAlias' => account_alias, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Delete a group
group_name<~String>: name of the group to delete
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteGroup.html
# File lib/fog/aws/requests/iam/delete_group.rb, line 21 def delete_group(group_name) request( 'Action' => 'DeleteGroup', 'GroupName' => group_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Remove a policy from a group
group_name<~String>: name of the group
policy_name<~String>: name of policy document
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteGroupPolicy.html
# File lib/fog/aws/requests/iam/delete_group_policy.rb, line 22 def delete_group_policy(group_name, policy_name) request( 'Action' => 'DeleteGroupPolicy', 'GroupName' => group_name, 'PolicyName' => policy_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Delete a instance_profile
instance_profile_name<~String>: name of the instance_profile to delete
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteInstanceProfile.html
# File lib/fog/aws/requests/iam/delete_instance_profile.rb, line 21 def delete_instance_profile(instance_profile_name) request( 'Action' => 'DeleteInstanceProfile', 'InstanceProfileName' => instance_profile_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Deletes a user's login profile
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteLoginProfile.html
user_name<~String> - Name of user whose login profile you want to delete
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
# File lib/fog/aws/requests/iam/delete_login_profile.rb, line 20 def delete_login_profile(user_name) request({ 'Action' => 'DeleteLoginProfile', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new }) end
Delete a role
role_name<~String>: name of the role to delete
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteRole.html
# File lib/fog/aws/requests/iam/delete_role.rb, line 21 def delete_role(role_name) request( 'Action' => 'DeleteRole', 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Remove a policy from a role
role_name<~String>: name of the role
policy_name<~String>: name of policy document
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteRolePolicy.html
# File lib/fog/aws/requests/iam/delete_role_policy.rb, line 22 def delete_role_policy(role_name, policy_name) request( 'Action' => 'DeleteRolePolicy', 'PolicyName' => policy_name, 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Deletes the specified server certificate.
server_certificate_name<~String>: The name of the server certificate you want to delete.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteServerCertificate.html
# File lib/fog/aws/requests/iam/delete_server_certificate.rb, line 21 def delete_server_certificate(server_certificate_name) request({ 'Action' => 'DeleteServerCertificate', 'ServerCertificateName' => server_certificate_name, :parser => Fog::Parsers::AWS::IAM::Basic.new }) end
Upload signing certificate for user (by default detects user from access credentials)
options<~Hash>:
'UserName'<~String> - name of the user to upload certificate for (do not include path)
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_DeleteSigningCertificate.html
# File lib/fog/aws/requests/iam/delete_signing_certificate.rb, line 22 def delete_signing_certificate(certificate_id, options = {}) request({ 'Action' => 'DeleteSigningCertificate', 'CertificateId' => certificate_id, :parser => Fog::Parsers::AWS::IAM::Basic.new }.merge!(options)) end
Delete a user
user_name<~String>: name of the user to delete
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteUser.html
# File lib/fog/aws/requests/iam/delete_user.rb, line 21 def delete_user(user_name) request( 'Action' => 'DeleteUser', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Remove a policy from a user
user_name<~String>: name of the user
policy_name<~String>: name of policy document
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_DeleteUserPolicy.html
# File lib/fog/aws/requests/iam/delete_user_policy.rb, line 22 def delete_user_policy(user_name, policy_name) request( 'Action' => 'DeleteUserPolicy', 'PolicyName' => policy_name, 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Get Group
'GroupName'<~String>: Name of the Group
options<~Hash>:
'Marker'<~String>: Use this only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the Marker element in the response you just received.
'MaxItems'<~String>: Use this only when paginating results to indicate the maximum number of User names you want in the response. If there are additional User names beyond the maximum you specify, the IsTruncated response element is true.
response<~Excon::Response>:
body<~Hash>:
'Group'<~Hash> - Group
'Path'<~String>
'GroupName'<~String>
'Arn'<~String>
'Users'<~Hash>? - List of users belonging to the group.
'User'<~Hash> - User
Arn<~String> -
UserId<~String> -
UserName<~String> -
Path<~String> -
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_GetGroup.html
# File lib/fog/aws/requests/iam/get_group.rb, line 33 def get_group(group_name, options = {}) request({ 'Action' => 'GetGroup', 'GroupName' => group_name, :parser => Fog::Parsers::AWS::IAM::GetGroup.new }.merge!(options)) end
Get Group Policy
'PolicyName'<~String>: Name of the policy to get
'GroupName'<~String>: Name of the Group who the policy is associated with.
response<~Excon::Response>:
body<~Hash>:
* PolicyDocument<~String> The policy document. * PolicyName<~String> The name of the policy. * GroupName<~String> The Group the policy is associated with.
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetGroupPolicy.html
# File lib/fog/aws/requests/iam/get_group_policy.rb, line 24 def get_group_policy(policy_name, group_name) request({ 'Action' => 'GetGroupPolicy', 'PolicyName' => policy_name, 'GroupName' => group_name, :parser => Fog::Parsers::AWS::IAM::GetGroupPolicy.new }) end
Retrieves information about an instance profile
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetInstanceProfile.html
instance_profile_name<~String> - Name of instance_profile to retrieve the information for
response<~Excon::Response>:
body<~Hash>:
'InstanceProfile'<~Hash>:
Arn<~String> -
CreateDate<~Date>
InstanceProfileId<~String> -
InstanceProfileName<~String> -
Path<~String> -
Roles<~Array> - role<~Hash>:
* 'Arn'<~String> - * 'AssumeRolePolicyDocument'<~String< * 'Path'<~String> - * 'RoleId'<~String> - * 'RoleName'<~String> -
'RequestId'<~String> - Id of the request
# File lib/fog/aws/requests/iam/get_instance_profile.rb, line 31 def get_instance_profile(instance_profile_name) request({ 'Action' => 'GetInstanceProfile', 'InstanceProfileName' => instance_profile_name, :parser => Fog::Parsers::AWS::IAM::InstanceProfile.new }) end
Retrieves the login profile for a user
docs.amazonwebservices.com/IAM/latest/APIReference/API_CreateLoginProfile.html
user_name<~String> - Name of user to retrieve the login profile for
password<~String> - The new password for this user
response<~Excon::Response>:
body<~Hash>:
'LoginProfile'<~Hash>
* UserName<~String> * CreateDate
'RequestId'<~String> - Id of the request
# File lib/fog/aws/requests/iam/get_login_profile.rb, line 24 def get_login_profile(user_name) request({ 'Action' => 'GetLoginProfile', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::LoginProfile.new }) end
response<~Excon::Response>:
body<~Hash>:
Role<~Hash>:
'Arn'<~String> -
'AssumeRolePolicyDocument'<~String<
'Path'<~String> -
'RoleId'<~String> -
'RoleName'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetRole.html
# File lib/fog/aws/requests/iam/get_role.rb, line 27 def get_role(role_name) request( 'Action' => 'GetRole', 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::SingleRole.new ) end
Get Role Policy
'PolicyName'<~String>: Name of the policy to get
'RoleName'<~String>: Name of the Role who the policy is associated with.
response<~Excon::Response>:
body<~Hash>:
* PolicyDocument<~String> The policy document. * PolicyName<~String> The name of the policy. * RoleName<~String> The Role the policy is associated with.
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetRolePolicy.html
# File lib/fog/aws/requests/iam/get_role_policy.rb, line 24 def get_role_policy(role_name, policy_name) request({ 'Action' => 'GetRolePolicy', 'PolicyName' => policy_name, 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::GetRolePolicy.new }) end
Gets the specified server certificate.
server_certificate_name<~String>: The name of the server certificate you want to get.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetServerCertificate.html
# File lib/fog/aws/requests/iam/get_server_certificate.rb, line 21 def get_server_certificate(name) request({ 'Action' => 'GetServerCertificate', 'ServerCertificateName' => name, :parser => Fog::Parsers::AWS::IAM::UploadServerCertificate.new }) end
Get User
username<String>
options<~Hash>:
'UserName'<~String>: Name of the User. Defaults to current user
response<~Excon::Response>:
body<~Hash>:
'User'<~Hash> - User
Arn<~String> -
UserId<~String> -
UserName<~String> -
Path<~String> -
docs.amazonwebservices.com/IAM/latest/APIReference/API_Getuser.html
# File lib/fog/aws/requests/iam/get_user.rb, line 27 def get_user(username, options = {}) request({ 'Action' => 'GetUser', 'UserName' => username, :parser => Fog::Parsers::AWS::IAM::GetUser.new }.merge!(options)) end
'PolicyName'<~String>: Name of the policy to get
'UserName'<~String>: Name of the User who the policy is associated with.
response<~Excon::Response>:
body<~Hash>:
* PolicyDocument<~String> The policy document. * PolicyName<~String> The name of the policy. * UserName<~String> The User the policy is associated with.
docs.amazonwebservices.com/IAM/latest/APIReference/API_GetUserPolicy.html
# File lib/fog/aws/requests/iam/get_user_policy.rb, line 24 def get_user_policy(policy_name, user_name) request({ 'Action' => 'GetUserPolicy', 'PolicyName' => policy_name, 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::GetUserPolicy.new }) end
List access_keys
options<~Hash>:
'Marker'<~String> - used to paginate subsequent requests
'MaxItems'<~Integer> - limit results to this number per page
'UserName'<~String> - optional: username to lookup access keys for, defaults to current user
response<~Excon::Response>:
body<~Hash>:
'AccessKeys'<~Array> - Matching access keys
access_key<~Hash>:
AccessKeyId<~String> -
Status<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListAccessKeys.html
# File lib/fog/aws/requests/iam/list_access_keys.rb, line 30 def list_access_keys(options = {}) request({ 'Action' => 'ListAccessKeys', :parser => Fog::Parsers::AWS::IAM::ListAccessKeys.new }.merge!(options)) end
# File lib/fog/aws/requests/iam/list_account_aliases.rb, line 8 def list_account_aliases(options = {}) request({ 'Action' => 'ListAccountAliases', :parser => Fog::Parsers::AWS::IAM::ListAccountAliases.new }.merge!(options)) end
List policies for a group
group_name<~String> - Name of group to list policies for
options<~Hash>: Optional
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
'PolicyNames'<~Array> - Matching policy names
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroupPolicies.html
# File lib/fog/aws/requests/iam/list_group_policies.rb, line 28 def list_group_policies(group_name, options = {}) request({ 'Action' => 'ListGroupPolicies', 'GroupName' => group_name, :parser => Fog::Parsers::AWS::IAM::ListPolicies.new }.merge!(options)) end
List groups
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
'Groups'<~Array> - Matching groups
group<~Hash>:
Arn<~String> -
GroupId<~String> -
GroupName<~String> -
Path<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroups.html
# File lib/fog/aws/requests/iam/list_groups.rb, line 32 def list_groups(options = {}) request({ 'Action' => 'ListGroups', :parser => Fog::Parsers::AWS::IAM::ListGroups.new }.merge!(options)) end
List groups_for_user
user_name<~String> - the username you want to look up group membership for
options<~Hash>:
'Marker'<~String> - used to paginate subsequent requests
'MaxItems'<~Integer> - limit results to this number per page
response<~Excon::Response>:
body<~Hash>:
'GroupsForUser'<~Array> - Groups for a user
group_for_user<~Hash>:
'Arn' -
'GroupId' -
'GroupName' -
'Path' -
'IsTruncated'<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListGroupsForUser.html
# File lib/fog/aws/requests/iam/list_groups_for_user.rb, line 32 def list_groups_for_user(user_name, options = {}) request({ 'Action' => 'ListGroupsForUser', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::ListGroupsForUser.new }.merge!(options)) end
Lists instance profiles
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
'InstanceProfiles'<~Array>:
instance_profile <~Hash>:
Arn<~String> -
CreateDate<~Date>
InstanceProfileId<~String> -
InstanceProfileName<~String> -
Path<~String> -
Roles<~Array> - role<~Hash>:
* 'Arn'<~String> - * 'AssumeRolePolicyDocument'<~String< * 'Path'<~String> - * 'RoleId'<~String> - * 'RoleName'<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListInstanceProfiles.html
# File lib/fog/aws/requests/iam/list_instance_profiles.rb, line 40 def list_instance_profiles(options={}) request({ 'Action' => 'ListInstanceProfiles', :parser => Fog::Parsers::AWS::IAM::ListInstanceProfiles.new }.merge!(options)) end
Lists the instance profiles that have the specified associated role
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'RoleName'<~String>: The name of the role to list instance profiles for.
response<~Excon::Response>:
body<~Hash>:
'InstanceProfiles'<~Array>:
instance_profile <~Hash>:
Arn<~String> -
CreateDate<~Date>
InstanceProfileId<~String> -
InstanceProfileName<~String> -
Path<~String> -
Roles<~Array> - role<~Hash>:
* 'Arn'<~String> - * 'AssumeRolePolicyDocument'<~String< * 'Path'<~String> - * 'RoleId'<~String> - * 'RoleName'<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListInstanceProfilesForRole.html
# File lib/fog/aws/requests/iam/list_instance_profiles_for_role.rb, line 40 def list_instance_profiles_for_role(role_name,options={}) request({ 'Action' => 'ListInstanceProfilesForRole', 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::ListInstanceProfiles.new }.merge!(options)) end
Lists the names of policies associated with a role
role_name<~String>: the role to list policies for
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
response<~Excon::Response>:
body<~Hash>:
'PolicyNames'<~Array>:
policy_name <~String>
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListRoleProfiles.html
# File lib/fog/aws/requests/iam/list_role_policies.rb, line 28 def list_role_policies(role_name,options={}) request({ 'Action' => 'ListRolePolicies', 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::ListPolicies.new }.merge!(options)) end
Lists roles
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
Roles<~Array> - role<~Hash>:
* 'Arn'<~String> - * 'AssumeRolePolicyDocument'<~String< * 'Path'<~String> - * 'RoleId'<~String> - * 'RoleName'<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListRoles.html
# File lib/fog/aws/requests/iam/list_roles.rb, line 33 def list_roles(options={}) request({ 'Action' => 'ListRoles', :parser => Fog::Parsers::AWS::IAM::ListRoles.new }.merge!(options)) end
List server certificates
options<~Hash>:
'Marker'<~String> - The marker from the previous result (for pagination)
'MaxItems'<~String> - The maximum number of server certificates you want in the response
'PathPrefix'<~String> - The path prefix for filtering the results
response<~Excon::Response>:
body<~Hash>:
'Certificates'<~Array> - Matching server certificates
server_certificate<~Hash>:
Arn<~String> -
Path<~String> -
ServerCertificateId<~String> -
ServerCertificateName<~String> -
UploadDate<~Time> -
'IsTruncated'<~Boolean> - Whether or not the results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_ListServerCertificates.html
# File lib/fog/aws/requests/iam/list_server_certificates.rb, line 32 def list_server_certificates(options = {}) request({ 'Action' => 'ListServerCertificates', :parser => Fog::Parsers::AWS::IAM::ListServerCertificates.new }.merge!(options)) end
List signing certificates for user (by default detects user from access credentials)
options<~Hash>:
'UserName'<~String> - name of the user to list certificates for (do not include path)
response<~Excon::Response>:
body<~Hash>:
'SigningCertificates'<~Array> - Matching signing certificates
signing_certificate<~Hash>:
CertificateId<~String> -
Status<~String> -
'IsTruncated'<~Boolean> - Whether or not the results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_ListSigningCertificates.html
# File lib/fog/aws/requests/iam/list_signing_certificates.rb, line 28 def list_signing_certificates(options = {}) request({ 'Action' => 'ListSigningCertificates', :parser => Fog::Parsers::AWS::IAM::ListSigningCertificates.new }.merge!(options)) end
List policies for a user
user_name<~String> - Name of user to list policies for
options<~Hash>: Optional
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
'PolicyNames'<~Array> - Matching policy names
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListUserPolicies.html
# File lib/fog/aws/requests/iam/list_user_policies.rb, line 28 def list_user_policies(user_name, options = {}) request({ 'Action' => 'ListUserPolicies', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::ListPolicies.new }.merge!(options)) end
List users
options<~Hash>:
'Marker'<~String>: used to paginate subsequent requests
'MaxItems'<~Integer>: limit results to this number per page
'PathPrefix'<~String>: prefix for filtering results
response<~Excon::Response>:
body<~Hash>:
'Users'<~Array> - Matching groups
user<~Hash>:
Arn<~String> -
Path<~String> -
UserId<~String> -
UserName<~String> -
'IsTruncated<~Boolean> - Whether or not results were truncated
'Marker'<~String> - appears when IsTruncated is true as the next marker to use
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_ListUsers.html
# File lib/fog/aws/requests/iam/list_users.rb, line 32 def list_users(options = {}) request({ 'Action' => 'ListUsers', :parser => Fog::Parsers::AWS::IAM::ListUsers.new }.merge!(options)) end
Add or update a policy for a group
group_name<~String>: name of the group
policy_name<~String>: name of policy document
policy_document<~Hash>: policy document, see: docs.amazonwebservices.com/IAM/latest/UserGuide/PoliciesOverview.html
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_PutGroupPolicy.html
# File lib/fog/aws/requests/iam/put_group_policy.rb, line 23 def put_group_policy(group_name, policy_name, policy_document) request( 'Action' => 'PutGroupPolicy', 'GroupName' => group_name, 'PolicyName' => policy_name, 'PolicyDocument' => Fog::JSON.encode(policy_document), :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Add or update a policy for a role
role_name<~String>: name of the role
policy_name<~String>: name of policy document
policy_document<~Hash>: policy document, see: docs.amazonwebservices.com/IAM/latest/UserGuide/PoliciesOverview.html
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_PutRolePolicy.html
# File lib/fog/aws/requests/iam/put_role_policy.rb, line 23 def put_role_policy(role_name, policy_name, policy_document) request( 'Action' => 'PutRolePolicy', 'RoleName' => role_name, 'PolicyName' => policy_name, 'PolicyDocument' => Fog::JSON.encode(policy_document), :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Add or update a policy for a user
user_name<~String>: name of the user
policy_name<~String>: name of policy document
policy_document<~Hash>: policy document, see: docs.amazonwebservices.com/IAM/latest/UserGuide/PoliciesOverview.html
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_PutUserPolicy.html
# File lib/fog/aws/requests/iam/put_user_policy.rb, line 23 def put_user_policy(user_name, policy_name, policy_document) request( 'Action' => 'PutUserPolicy', 'PolicyName' => policy_name, 'PolicyDocument' => Fog::JSON.encode(policy_document), 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
# File lib/fog/aws/iam.rb, line 167 def reload @connection.reset end
removes a role from an instance profile
Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile.
instance_profile_name<~String>: Name of the instance profile to update.
role_name<~String>:Name of the role to remove.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_RemoveRoleFromInstanceProfile.html
# File lib/fog/aws/requests/iam/remove_role_from_instance_profile.rb, line 23 def remove_role_from_instance_profile(role_name, instance_profile_name) request( 'Action' => 'RemoveRoleFromInstanceProfile', 'InstanceProfileName' => instance_profile_name, 'RoleName' => role_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Remove a user from a group
group_name<~String>: name of the group
user_name<~String>: name of user to remove
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_RemoveUserFromGroup.html
# File lib/fog/aws/requests/iam/remove_user_from_group.rb, line 22 def remove_user_from_group(group_name, user_name) request( 'Action' => 'RemoveUserFromGroup', 'GroupName' => group_name, 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::Basic.new ) end
Update an access key for a user
access_key_id<~String> - Access key id to delete
status<~String> - status of keys in ['Active', 'Inactive']
options<~Hash>:
'UserName'<~String> - name of the user to create (do not include path)
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/API_UpdateAccessKey.html
# File lib/fog/aws/requests/iam/update_access_key.rb, line 24 def update_access_key(access_key_id, status, options = {}) request({ 'AccessKeyId' => access_key_id, 'Action' => 'UpdateAccessKey', 'Status' => status, :parser => Fog::Parsers::AWS::IAM::Basic.new }.merge!(options)) end
Update a Group
group_name<~String> - Required. Name of the Group to update. If you're changing the name of the Group, this is the original Group name.
options<~Hash>:
new_path<~String> - New path for the Group. Include this parameter only if you're changing the Group's path.
new_group_name<~String> - New name for the Group. Include this parameter only if you're changing the Group's name.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
'Group'<~Hash> - Changed Group info
'Arn'<~String> -
'Path'<~String> -
'GroupId'<~String> -
'GroupName'<~String> -
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateGroup.html
# File lib/fog/aws/requests/iam/update_group.rb, line 28 def update_group(group_name, options = {}) request({ 'Action' => 'UpdateGroup', 'GroupName' => group_name, :parser => Fog::Parsers::AWS::IAM::UpdateGroup.new }.merge!(options)) end
Updates a login profile for a user
docs.amazonwebservices.com/IAM/latest/APIReference/API_UpdateLoginProfile.html
user_name<~String> - Name of user to change the login profile for
password<~String> - The new password for this user
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
# File lib/fog/aws/requests/iam/update_login_profile.rb, line 21 def update_login_profile(user_name, password) request({ 'Action' => 'UpdateLoginProfile', 'UserName' => user_name, 'Password' => password, :parser => Fog::Parsers::AWS::IAM::Basic.new }) end
Updates the name and/or the path of the specified server certificate.
server_certificate_name<~String> - The name of the server certificate that you want to update.
options<~Hash>:
'NewPath'<~String> - The new path for the server certificate. Include this only if you are updating the server certificate's path.
'NewServerCertificateName'<~String> - The new name for the server certificate. Include this only if you are updating the server certificate's name.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateServerCertificate.html
# File lib/fog/aws/requests/iam/update_server_certificate.rb, line 26 def update_server_certificate(server_certificate_name, options = {}) request({ 'Action' => 'UpdateServerCertificate', 'ServerCertificateName' => server_certificate_name, :parser => Fog::Parsers::AWS::IAM::Basic.new }.merge!(options)) end
Update a Signing Certificate
certificate_id<~String> - Required. ID of the Certificate to update.
status<~String> - Required. Active/Inactive
options<~Hash>:
user_name<~String> - Name of the user the signing certificate belongs to.
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateSigningCertificate.html
# File lib/fog/aws/requests/iam/update_signing_certificate.rb, line 20 def update_signing_certificate(certificate_id, status, options = {}) request({ 'Action' => 'UpdateSigningCertificate', 'CertificateId' => certificate_id, 'Status' => status, :parser => Fog::Parsers::AWS::IAM::Basic.new }.merge!(options)) end
Update a user
user_name<~String> - Required. Name of the User to update. If you're changing the name of the User, this is the original User name.
options<~Hash>:
response<~Excon::Response>:
body<~Hash>:
'RequestId'<~String> - Id of the request
'User'<~Hash> - Changed user info
'Arn'<~String> -
'Path'<~String> -
'UserId'<~String> -
'UserName'<~String> -
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UpdateUser.html
# File lib/fog/aws/requests/iam/update_user.rb, line 28 def update_user(user_name, options = {}) request({ 'Action' => 'UpdateUser', 'UserName' => user_name, :parser => Fog::Parsers::AWS::IAM::UpdateUser.new }.merge!(options)) end
Uploads a server certificate entity for the AWS Account. Includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.
certificate<~Hash>: The contents of the public key certificate in PEM-encoded format.
private_key<~Hash>: The contents of the private key in PEM-encoded format.
name<~Hash>: The name for the server certificate. Do not include the path in this value.
options<~Hash>:
'CertificateChain'<~String> - The contents of the certificate chain. Typically a concatenation of the PEM-encoded public key certificates of the chain.
'Path'<~String> - The path for the server certificate.
response<~Excon::Response>:
body<~Hash>:
'Certificate'<~Hash>:
'Arn'<~String> -
'Path'<~String> -
'ServerCertificateId'<~String> -
'ServerCertificateName'<~String> -
'UploadDate'<~Time>
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html
# File lib/fog/aws/requests/iam/upload_server_certificate.rb, line 33 def upload_server_certificate(certificate, private_key, name, options = {}) request({ 'Action' => 'UploadServerCertificate', 'CertificateBody' => certificate, 'PrivateKey' => private_key, 'ServerCertificateName' => name, :parser => Fog::Parsers::AWS::IAM::UploadServerCertificate.new }.merge!(options)) end
Upload signing certificate for user (by default detects user from access credentials)
options<~Hash>:
'UserName'<~String> - name of the user to upload certificate for (do not include path)
response<~Excon::Response>:
body<~Hash>:
'Certificate'<~Hash>:
'CertificateId'<~String> -
'UserName'<~String> -
'CertificateBody'<~String> -
'Status'<~String> -
'RequestId'<~String> - Id of the request
docs.amazonwebservices.com/IAM/latest/APIReference/index.html?API_UploadSigningCertificate.html
# File lib/fog/aws/requests/iam/upload_signing_certificate.rb, line 27 def upload_signing_certificate(certificate, options = {}) request({ 'Action' => 'UploadSigningCertificate', 'CertificateBody' => certificate, :parser => Fog::Parsers::AWS::IAM::UploadSigningCertificate.new }.merge!(options)) end
Generated with the Darkfish Rdoc Generator 2.