AmazonStorageGatewayClient.UpdateGatewayInformation Method (UpdateGatewayInformationRequest)

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateGatewayInformationAsync.

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

Syntax

public virtual UpdateGatewayInformationResponse UpdateGatewayInformation(
         UpdateGatewayInformationRequest request
)

Parameters

request: Type: Amazon.StorageGateway.Model.UpdateGatewayInformationRequest

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

Return Value

Type: UpdateGatewayInformationResponse

The response from the UpdateGatewayInformation service method, as returned by StorageGateway.

Exceptions

Exception	Condition
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

Updates a gateway's metadata, which includes the gateway's name and time zone.

To update a gateway's metadata


var client = new AmazonStorageGatewayClient();
var response = client.UpdateGatewayInformation(new UpdateGatewayInformationRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
    GatewayName = "MyGateway2",
    GatewayTimezone = "GMT-12:00"
});

string gatewayARN = response.GatewayARN;
string gatewayName = response.GatewayName;

Version Information

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

AmazonStorageGatewayClient.UpdateGatewayInformation (UpdateGatewayInformationRequest)

Method