delete_domain ( $domain_name, $opt )

The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.

Running DeleteDomain on a domain that does not exist or running the function multiple times using the same domain name will not result in an error response.

Access

public

Parameters

Parameter

Type

Required

Description

$domain_name

string

Required

The name of the domain to delete.

$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 a domain.

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->delete_domain('example-domain');

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

Related Methods

Source

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

public function delete_domain($domain_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['DomainName'] = $domain_name;
    
    return $this->authenticate('DeleteDomain', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback