update_user ( $user_name, $opt )

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

You should understand the implications of changing a user’s path or name. For more information, see Renaming Users and Groups in Using AWS Identity and Access Management.

To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

Access

public

Parameters

Parameter

Type

Required

Description

$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. [Constraints: The value must be between 1 and 128 characters, and must match the following regular expression pattern: [\w+=,.@-]*]

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • NewPath - string - Optional - New path for the user. Include this parameter only if you’re changing the user’s path. [Constraints: The value must be between 1 and 512 characters, and must match the following regular expression pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)]
  • NewUserName - string - Optional - New name for the user. Include this parameter only if you’re changing the user’s name. [Constraints: The value must be between 1 and 64 characters, and must match the following regular expression pattern: [\w+=,.@-]*]
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Update an existing user.

// Instantiate the class
$iam = new AmazonIAM();

// Update a user
$response = $iam->update_user('johndoe', array(
	'NewUserName' => 'johndoe2'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/iam.class.php | Toggle source view (7 lines) | View on GitHub

public function update_user($user_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['UserName'] = $user_name;
    
    return $this->authenticate('UpdateUser', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback