delete_account_alias ( $account_alias, $opt )

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access Management.

Access

public

Parameters

Parameter

Type

Required

Description

$account_alias

string

Required

Name of the account alias to delete. [Constraints: The value must be between 3 and 63 characters, and must match the following regular expression pattern: ^a-z0-9?$]

$opt

array

Optional

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

  • 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

Delete an alias for your account.

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

$response = $iam->delete_account_alias('joe');

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

Source

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

public function delete_account_alias($account_alias, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['AccountAlias'] = $account_alias;
    
    return $this->authenticate('DeleteAccountAlias', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback