list_users ( $opt )

Lists the users that have the specified path prefix. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • PathPrefix - string - Optional - The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. [Constraints: The value must be between 1 and 512 characters, and must match the following regular expression pattern: \u002F[\u0021-\u007F]*]
  • Marker - string - Optional - Use this parameter 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. [Constraints: The value must be between 1 and 320 characters, and must match the following regular expression pattern: [\u0020-\u00FF]*]
  • MaxItems - integer - Optional - Use this parameter 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.
  • 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

List the users available on this account.

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

$response = $iam->list_users();

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

Related Methods

Source

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

public function list_users($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('ListUsers', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback