AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeGatewayInformationAsync.

Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public abstract DescribeGatewayInformationResponse DescribeGatewayInformation(
         DescribeGatewayInformationRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.DescribeGatewayInformationRequest

Container for the necessary parameters to execute the DescribeGatewayInformation service method.

Return Value
The response from the DescribeGatewayInformation service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Examples

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 describe metadata about the gateway


var response = client.DescribeGatewayInformation(new DescribeGatewayInformationRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
});

string gatewayARN = response.GatewayARN;
string gatewayId = response.GatewayId;
string gatewayName = response.GatewayName;
List gatewayNetworkInterfaces = response.GatewayNetworkInterfaces;
string gatewayState = response.GatewayState;
string gatewayTimezone = response.GatewayTimezone;
string gatewayType = response.GatewayType;
string lastSoftwareUpdate = response.LastSoftwareUpdate;
string nextUpdateAvailabilityDate = response.NextUpdateAvailabilityDate;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also