list_gateways ( $opt )

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response-that is, the response returns only a truncated list of your gateways-the response contains a marker that you can specify in your next request to fetch the next page of gateways.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • Marker - string - Optional - An opaque string that indicates the position at which to begin the returned list of gateways.
  • Limit - integer - Optional - Specifies that the list of gateways returned be limited to the specified number of items.
  • 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 Gateways.

$sg = new AmazonStorageGateway();

// List gateways
$response = $sg->list_gateways();

// Success?
var_dump($response->isOK());

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback