describe_gateway_information ( $opt )

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • GatewayARN - string - Required - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.
  • 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

Shutdown and start a gateway.

$sg = new AmazonStorageGateway();

// Shutdown the gateway
$response = $sg->shutdown_gateway(array('GatewayARN' => $gateway_arn));

sleep(10);

// Wait until shutdown
do
{
	sleep(10); echo '.';
	$response = $sg->describe_gateway_information(array('GatewayARN' => $gateway_arn));
	$status = (string) $response->body->GatewayState;
} while ($status !== 'SHUTDOWN');

// Start the gateway
$response = $sg->start_gateway(array('GatewayARN' => $gateway_arn));

// Wait until running
do
{
	sleep(10); echo '.';
	$response = $sg->describe_gateway_information(array('GatewayARN' => $gateway_arn));
	$status = (string) $response->body->GatewayState;
} while ($status !== 'RUNNING');

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback