NAME

Net::Amazon::IAM - Perl interface to the Amazon Identity and Access Management.

VERSION

This is Net::Amazon::IAM version 0.03

IAM Query API version: '2010-05-08'

SYNOPSIS

use Net::Amazon::IAM;

my $iam = Net::Amazon::IAM->new(
  AWSAccessKeyId  => 'PUBLIC_KEY_HERE',
  SecretAccessKey => 'SECRET_KEY_HERE'
);

# create new user
my $user = $iam->create_user (
  UserName => 'testuser',
  Path     => '/path/to/test/user/',
);

# delete user
my $delete = $iam->delete_user(UserName => 'testuser');
if($delete->isa("Net::Amazon::IAM::Error")) {
  print Dumper $delete;
}else{
  print "User was successfuly deleted\n";
}

# add policy to user
my $policy_document = {
  Version => '2012-10-17',
  Statement => [
     {
        Effect   => 'Allow',
        Action   => [
           's3:Get*',
           's3:List*',
        ],
        Resource => [
           'arn:aws:s3:::sometestbucket',
           'arn:aws:s3:::sometestbucket/*',
        ],
     },
  ],
};

my $policy = $iam->put_user_policy ( PolicyName => 'somtestpolicy', UserName => 'sometestuser', PolicyDocument => $policy_document, );

if($policy->isa("Net::Amazon::IAM::Error")) {
  print Dumper $policy;
}else{
  print "Policy was added\n";
}

If an error occurs while communicating with IAM, these methods will throw a Net::Amazon::IAM::Error exception.

DESCRIPTION

This module is a Perl interface to Amazon's Identity and Access Management (IAM). It uses the Query API to communicate with Amazon's Web Services framework.

CLASS METHODS

new(%params)

This is the constructor, it will return you a Net::Amazon::IAM object to work with. It takes these parameters:

AWSAccessKeyId (required): Your AWS access key.
SecretAccessKey (required): Your secret key, WARNING! don't give this out or someone will be able to use your account and incur charges on your behalf.
debug (optional): A flag to turn on debugging. Among other useful things, it will make the failing api calls print a stack trace. It is turned off by default.

create_user(%params)

Create new IAM user

UserName (required): New user username
Path (optional): Where to create new user

Returns a Net::Amazon::IAM::User object on success or Net::Amazon::IAM::Error on fail.

delete_user(%params)

Delete IAM User

UserName (required): What user should be deleted

Returns true on success or Net::Amazon::IAM::Error on fail.

get_user(%params)

Get IAM user details

UserName (required): New user username

Returns a Net::Amazon::IAM::User object on success or Net::Amazon::IAM::Error on fail.

update_user(%params)

Updates the name and/or the path of the specified user.

UserName (required): Name of the user to update. If you're changing the name of the user, this is the original user name.
NewPath (optional): New path for the user. Include this parameter only if you're changing the user's path.
NewUserName (optional): New name for the user. Include this parameter only if you're changing the user's name.

Returns true on success or Net::Amazon::IAM::Error on fail.

add_user_to_group(%params)

Adds the specified user to the specified group.

GroupName (required): The name of the group to update.
UserName (required): The name of the user to add.

Returns true on success or Net::Amazon::IAM::Error on fail.

remove_user_from_group(%params)

Removes the specified user from the specified group.

GroupName (required): The name of the group to update.
UserName (required): The name of the user to remove.

Returns true on success or Net::Amazon::IAM::Error on fail.

create_group(%params)

Creates a new group.

GroupName (required): The name of the group to create.
Path (optional): The path to the group.

Returns Net::Amazon::IAM::Group object on success or Net::Amazon::IAM::Error on fail.

get_group(%params)

Returns group details and list of users that are in the specified group.

GroupName (required): The name of the group.

Returns Net::Amazon::IAM::Group object on success or Net::Amazon::IAM::Error on fail. If there one or more users in specified group, Net::Amazon::IAM::Group object will containt Users attribute wich is ArrayRef of Net::Amazon::IAM::User objects

delete_group(%params)

Deletes the specified group. The group must not contain any users or have any attached policies.

GroupName (required): The name of the group to delete.

Returns true on success or Net::Amazon::IAM::Error on fail.

create_policy(%params)

Creates a new managed policy for your AWS account.

PolicyName (required): The name of the policy document.
PolicyDocument (required): The policy document.
Description (optional): A friendly description of the policy.
Path (optional): The path for the policy.

Returns Net::Amazon::IAM::Policy object on success or Net::Amazon::IAM::Error on fail.

get_policy(%params)

Retrieves information about the specified managed policy.

PolicyArn (required): The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

Returns Net::Amazon::IAM::Policy object on success or Net::Amazon::IAM::Error on fail.

delete_policy(%params)

Deletes the specified managed policy.

PolicyArn (required): The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

Returns true on success or Net::Amazon::IAM::Error on fail.

list_policies(%params)

Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

OnlyAttached (optional)

A flag to filter the results to only the attached policies. When OnlyAttached is true, the returned list contains only the policies that are attached to a user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

PathPrefix (optional)

The path prefix for filtering the results. If it is not included, it defaults to a slash (/), listing all policies.

Scope (optional)

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local. If it is not included, or if it is set to All, all policies are returned.

Returns Net::Amazon::IAM::Policies on success or Net::Amazon::IAM::Error on fail. When no policies found, the Policies attribute will be just empty array.

put_user_policy(%params)

Deletes the specified managed policy.

PolicyDocument (required): The policy document. Must be HashRef.
PolicyName (required): The name of the policy document.
UserName (required): The name of the user to associate the policy with.

Returns true on success or Net::Amazon::IAM::Error on fail.

get_user_policy(%params)

Retrieves the specified inline policy document that is embedded in the specified user.

PolicyName (required): The name of the policy document to get.
UserName (required): The name of the user who the policy is associated with.

Returns Net::Amazon::IAM::UserPolicy object on success or Net::Amazon::IAM::Error on fail.

delete_user_policy(%params)

Deletes the specified inline policy that is embedded in the specified user.

PolicyName (required): The name identifying the policy document to delete.
UserName (required): The name (friendly name, not ARN) identifying the user that the policy is embedded in.

Returns true on success or Net::Amazon::IAM::Error on fail.

list_user_policies(%params)

Lists the names of the inline policies embedded in the specified user.

UserName (required): The name of the user to list policies for.

When found one or more policies, this method will return ArrayRef with policy names. Once no policies found, will return undef; Net::Amazon::IAM::Error will be returned on error

create_access_key(%params)

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

Important: To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

UserName (optional): The user name that the new key will belong to.

Returns Net::Amazon::IAM::AccessKey object on success or Net::Amazon::IAM::Error on fail.

delete_access_key(%params)

Deletes the access key associated with the specified user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

AccessKeyId (required): The access key ID for the access key ID and secret access key you want to delete.
UserName (optional): The name of the user whose key you want to delete.

Returns true on success or Net::Amazon::IAM::Error on fail.

list_access_keys(%params)

Returns information about the access key IDs associated with the specified user. If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

UserName (optional): The name of the user.

Returns Net::Amazon::IAM::AccessKeysList on success. If specified user has no keys, "Keys" attribute of Net::Amazon::IAM::AccessKeysList object will be just empty array. Returns Net::Amazon::IAM::Error on fail.

AUTHOR

Igor Tsigankov <tsiganenok@gmail.com>

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install Net::Amazon::IAM, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Net::Amazon::IAM

CPAN shell

perl -MCPAN -e shell
install Net::Amazon::IAM

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

CLASS METHODS

new(%params)

create_user(%params)

delete_user(%params)

get_user(%params)

update_user(%params)

add_user_to_group(%params)

remove_user_from_group(%params)

create_group(%params)

get_group(%params)

delete_group(%params)

create_policy(%params)

get_policy(%params)

delete_policy(%params)

list_policies(%params)

put_user_policy(%params)

get_user_policy(%params)

delete_user_policy(%params)

list_user_policies(%params)

create_access_key(%params)

delete_access_key(%params)

list_access_keys(%params)

AUTHOR

COPYRIGHT

Module Install Instructions