[ aws . backup-gateway ]

get-gateway

Description

By providing the ARN (Amazon Resource Name), this API returns the gateway.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-gateway
--gateway-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--gateway-arn (string)

The Amazon Resource Name (ARN) of the gateway.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Gateway -> (structure)

By providing the ARN (Amazon Resource Name), this API returns the gateway.

GatewayArn -> (string)

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

GatewayDisplayName -> (string)

The display name of the gateway.

GatewayType -> (string)

The type of the gateway type.

HypervisorId -> (string)

The hypervisor ID of the gateway.

LastSeenTime -> (timestamp)

Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

NextUpdateAvailabilityTime -> (timestamp)

Details showing the next update availability time of the gateway.

VpcEndpoint -> (string)

The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.