[ aws . snow-device-management ]

describe-device

Description

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-device
--managed-device-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--managed-device-id (string)

The ID of the device that you are checking the information of.

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

associatedWithJob -> (string)

The ID of the job used when ordering the device.

deviceCapacities -> (list)

The hardware specifications of the device.

(structure)

The physical capacity of the Amazon Web Services Snow Family device.

available -> (long)

The amount of capacity available for use on the device.

name -> (string)

The name of the type of capacity, such as memory.

total -> (long)

The total capacity on the device.

unit -> (string)

The unit of measure for the type of capacity.

used -> (long)

The amount of capacity used on the device.

deviceState -> (string)

The current state of the device.

deviceType -> (string)

The type of Amazon Web Services Snow Family device.

lastReachedOutAt -> (timestamp)

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

lastUpdatedAt -> (timestamp)

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

managedDeviceArn -> (string)

The Amazon Resource Name (ARN) of the device.

managedDeviceId -> (string)

The ID of the device that you checked the information for.

physicalNetworkInterfaces -> (list)

The network interfaces available on the device.

(structure)

The details about the physical network interface for the device.

defaultGateway -> (string)

The default gateway of the device.

ipAddress -> (string)

The IP address of the device.

ipAddressAssignment -> (string)

A value that describes whether the IP address is dynamic or persistent.

macAddress -> (string)

The MAC address of the device.

netmask -> (string)

The netmask used to divide the IP address into subnets.

physicalConnectorType -> (string)

The physical connector type.

physicalNetworkInterfaceId -> (string)

The physical network interface ID.

software -> (structure)

The software installed on the device.

installState -> (string)

The state of the software that is installed or that is being installed on the device.

installedVersion -> (string)

The version of the software currently installed on the device.

installingVersion -> (string)

The version of the software being installed on the device.

tags -> (map)

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

key -> (string)

value -> (string)