paws.storage (version 0.1.12)

storagegateway_describe_gateway_information: Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not)

Description

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.

Usage

storagegateway_describe_gateway_information(GatewayARN)

Value

A list with the following syntax:

list(
  GatewayARN = "string",
  GatewayId = "string",
  GatewayName = "string",
  GatewayTimezone = "string",
  GatewayState = "string",
  GatewayNetworkInterfaces = list(
    list(
      Ipv4Address = "string",
      MacAddress = "string",
      Ipv6Address = "string"
    )
  ),
  GatewayType = "string",
  NextUpdateAvailabilityDate = "string",
  LastSoftwareUpdate = "string",
  Ec2InstanceId = "string",
  Ec2InstanceRegion = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  VPCEndpoint = "string",
  CloudWatchLogGroupARN = "string",
  HostEnvironment = "VMWARE"|"HYPER-V"|"EC2"|"KVM"|"OTHER",
  EndpointType = "string",
  SoftwareUpdatesEndDate = "string",
  DeprecationDate = "string"
)

Arguments

GatewayARN

[required]

Request syntax

svc$describe_gateway_information(
  GatewayARN = "string"
)

Examples

if (FALSE) {
# Returns metadata about a gateway such as its name, network interfaces,
# configured time zone, and the state (whether the gateway is running or
# not).
svc$describe_gateway_information(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)
}