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

See also: AWS API Documentation

Request Syntax

response = client.describe_device(
managedDeviceId (string) --


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

Return type
Response Syntax
    'associatedWithJob': 'string',
    'deviceCapacities': [
            'available': 123,
            'name': 'string',
            'total': 123,
            'unit': 'string',
            'used': 123
    'deviceState': 'UNLOCKED'|'LOCKED'|'UNLOCKING',
    'deviceType': 'string',
    'lastReachedOutAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'managedDeviceArn': 'string',
    'managedDeviceId': 'string',
    'physicalNetworkInterfaces': [
            'defaultGateway': 'string',
            'ipAddress': 'string',
            'ipAddressAssignment': 'DHCP'|'STATIC',
            'macAddress': 'string',
            'netmask': 'string',
            'physicalConnectorType': 'RJ45'|'SFP_PLUS'|'QSFP'|'RJ45_2'|'WIFI',
            'physicalNetworkInterfaceId': 'string'
    'software': {
        'installState': 'string',
        'installedVersion': 'string',
        'installingVersion': 'string'
    'tags': {
        'string': 'string'

Response Structure

  • (dict) --
    • associatedWithJob (string) --

      The ID of the job used when ordering the device.

    • deviceCapacities (list) --

      The hardware specifications of the device.

      • (dict) --

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

        • available (integer) --

          The amount of capacity available for use on the device.

        • name (string) --

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

        • total (integer) --

          The total capacity on the device.

        • unit (string) --

          The unit of measure for the type of capacity.

        • used (integer) --

          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 (datetime) --

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

    • lastUpdatedAt (datetime) --

      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.

      • (dict) --

        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 (dict) --

      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 (dict) --

      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.

      • (string) --
        • (string) --


  • SnowDeviceManagement.Client.exceptions.ThrottlingException
  • SnowDeviceManagement.Client.exceptions.InternalServerException
  • SnowDeviceManagement.Client.exceptions.ResourceNotFoundException
  • SnowDeviceManagement.Client.exceptions.ValidationException
  • SnowDeviceManagement.Client.exceptions.AccessDeniedException