get_device#

AlexaForBusiness.Client.get_device(**kwargs)#

Gets the details of a device by device ARN.

Request Syntax

response = client.get_device(
    DeviceArn='string'
)

Parameters:

DeviceArn (string) – The ARN of the device for which to request details. Required.

Return type:

dict

Returns:

Response Syntax

{
    'Device': {
        'DeviceArn': 'string',
        'DeviceSerialNumber': 'string',
        'DeviceType': 'string',
        'DeviceName': 'string',
        'SoftwareVersion': 'string',
        'MacAddress': 'string',
        'RoomArn': 'string',
        'DeviceStatus': 'READY'|'PENDING'|'WAS_OFFLINE'|'DEREGISTERED'|'FAILED',
        'DeviceStatusInfo': {
            'DeviceStatusDetails': [
                {
                    'Feature': 'BLUETOOTH'|'VOLUME'|'NOTIFICATIONS'|'LISTS'|'SKILLS'|'NETWORK_PROFILE'|'SETTINGS'|'ALL',
                    'Code': 'DEVICE_SOFTWARE_UPDATE_NEEDED'|'DEVICE_WAS_OFFLINE'|'CREDENTIALS_ACCESS_FAILURE'|'TLS_VERSION_MISMATCH'|'ASSOCIATION_REJECTION'|'AUTHENTICATION_FAILURE'|'DHCP_FAILURE'|'INTERNET_UNAVAILABLE'|'DNS_FAILURE'|'UNKNOWN_FAILURE'|'CERTIFICATE_ISSUING_LIMIT_EXCEEDED'|'INVALID_CERTIFICATE_AUTHORITY'|'NETWORK_PROFILE_NOT_FOUND'|'INVALID_PASSWORD_STATE'|'PASSWORD_NOT_FOUND'|'PASSWORD_MANAGER_ACCESS_DENIED'|'CERTIFICATE_AUTHORITY_ACCESS_DENIED'
                },
            ],
            'ConnectionStatus': 'ONLINE'|'OFFLINE',
            'ConnectionStatusUpdatedTime': datetime(2015, 1, 1)
        },
        'NetworkProfileInfo': {
            'NetworkProfileArn': 'string',
            'CertificateArn': 'string',
            'CertificateExpirationTime': datetime(2015, 1, 1)
        }
    }
}

Response Structure

(dict) –
- Device (dict) –
  
  The details of the device requested. Required.
  - DeviceArn (string) –
    
    The ARN of a device.
  - DeviceSerialNumber (string) –
    
    The serial number of a device.
  - DeviceType (string) –
    
    The type of a device.
  - DeviceName (string) –
    
    The name of a device.
  - SoftwareVersion (string) –
    
    The software version of a device.
  - MacAddress (string) –
    
    The MAC address of a device.
  - RoomArn (string) –
    
    The room ARN of a device.
  - DeviceStatus (string) –
    
    The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
  - DeviceStatusInfo (dict) –
    
    Detailed information about a device’s status.
    - DeviceStatusDetails (list) –
      
      One or more device status detail descriptions.
      - (dict) –
        
        Details of a device’s status.
        
        Feature (string) –
        
        The list of available features on the device.
        
        Code (string) –
        
        The device status detail code.
    - ConnectionStatus (string) –
      
      The latest available information about the connection status of a device.
    - ConnectionStatusUpdatedTime (datetime) –
      
      The time (in epoch) when the device connection status changed.
  - NetworkProfileInfo (dict) –
    
    Detailed information about a device’s network profile.
    - NetworkProfileArn (string) –
      
      The ARN of the network profile associated with a device.
    - CertificateArn (string) –
      
      The ARN of the certificate associated with a device.
    - CertificateExpirationTime (datetime) –
      
      The time (in epoch) when the certificate expires.

Exceptions

AlexaForBusiness.Client.exceptions.NotFoundException