list_account_aliases ( $opt )

Lists the account aliases associated with the account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management.

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:

  • 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 account aliases you want in the response. If there are additional account aliases 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 aliases for your account.

// Instantiate the class
$iam = new AmazonIAM(array(
	'key'    => 'USERS_KEY',
	'secret' => 'USERS_SECRET_KEY'
));

$response = $iam->list_account_aliases();

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

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback