storagegateway_update_gateway_information: Updates a gateway's metadata, which includes the gateway's...

Description Usage Arguments Value Request syntax Examples

View source: R/storagegateway_operations.R

Description

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.

Usage

1
2
storagegateway_update_gateway_information(GatewayARN, GatewayName,
  GatewayTimezone, CloudWatchLogGroupARN)

Arguments

GatewayARN

[required]

GatewayName
GatewayTimezone

A value that indicates the time zone of the gateway.

CloudWatchLogGroupARN

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What is Amazon CloudWatch Logs?

Value

A list with the following syntax:

1
2
3
4
list(
  GatewayARN = "string",
  GatewayName = "string"
)

Request syntax

1
2
3
4
5
6
svc$update_gateway_information(
  GatewayARN = "string",
  GatewayName = "string",
  GatewayTimezone = "string",
  CloudWatchLogGroupARN = "string"
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Updates a gateway's metadata, which includes the gateway's name and time
# zone.
svc$update_gateway_information(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  GatewayName = "MyGateway2",
  GatewayTimezone = "GMT-12:00"
)

## End(Not run)

paws.storage documentation built on March 7, 2021, 5:07 p.m.