list_domains ( $opt )

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • MaxNumberOfDomains - integer - Optional - The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100.
  • NextToken - string - Optional - A string informing Amazon SimpleDB where to start the next list of domain names.
  • 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 all domains for an account.

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains();

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

List a maximum of one domain for an account.

// Instantiate
$sdb = new AmazonSDB();
$response = $sdb->list_domains(array(
	'MaxNumberOfDomains' => 1
));

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

Related Methods

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback