Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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.

post/#X-Amz-Target=StorageGateway_20130630.UpdateGatewayInformation

Headers

X-Amz-Target'StorageGateway_20130630.UpdateGatewayInformation' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

GatewayNamestring

The name you configured for your gateway.

GatewayTimezonestring

A value that indicates the time zone of the gateway.

CloudWatchLogGroupARNstring
<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html">What is Amazon CloudWatch Logs?</a> </p>
GatewayCapacity'Small' | 'Medium' | 'Large'

Specifies the size of the gateway's metadata cache.

Response

Success

GatewayARNstring

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

GatewayNamestring

The name you configured for your gateway.

Example response

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  "GatewayName": ""
}