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 |
---|---|---|---|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
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