get_group ( $group_name, $opt )

Returns a list of users that are in the specified group. You can paginate the results using the MaxItems and Marker parameters.

Access

public

Parameters

Parameter

Type

Required

Description

$group_name

string

Required

Name of the group. [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:

  • Marker - string - Optional - 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. [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 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

Get an existing group.

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

// Create a new parent group
$response = $iam->get_group('wxyz_group');

// 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 get_group($group_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['GroupName'] = $group_name;
    
    return $this->authenticate('GetGroup', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback