:doc:`NetworkManager <../../networkmanager>` / Client / update_device

*************
update_device
*************



.. py:method:: NetworkManager.Client.update_device(**kwargs)

  

  Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkmanager-2019-07-05/UpdateDevice>`_  


  **Request Syntax**
  ::

    response = client.update_device(
        GlobalNetworkId='string',
        DeviceId='string',
        AWSLocation={
            'Zone': 'string',
            'SubnetArn': 'string'
        },
        Description='string',
        Type='string',
        Vendor='string',
        Model='string',
        SerialNumber='string',
        Location={
            'Address': 'string',
            'Latitude': 'string',
            'Longitude': 'string'
        },
        SiteId='string'
    )
    
  :type GlobalNetworkId: string
  :param GlobalNetworkId: **[REQUIRED]** 

    The ID of the global network.

    

  
  :type DeviceId: string
  :param DeviceId: **[REQUIRED]** 

    The ID of the device.

    

  
  :type AWSLocation: dict
  :param AWSLocation: 

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

    

  
    - **Zone** *(string) --* 

      The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

      

    
    - **SubnetArn** *(string) --* 

      The Amazon Resource Name (ARN) of the subnet that the device is located in.

      

    
  
  :type Description: string
  :param Description: 

    A description of the device.

     

    Constraints: Maximum length of 256 characters.

    

  
  :type Type: string
  :param Type: 

    The type of the device.

    

  
  :type Vendor: string
  :param Vendor: 

    The vendor of the device.

     

    Constraints: Maximum length of 128 characters.

    

  
  :type Model: string
  :param Model: 

    The model of the device.

     

    Constraints: Maximum length of 128 characters.

    

  
  :type SerialNumber: string
  :param SerialNumber: 

    The serial number of the device.

     

    Constraints: Maximum length of 128 characters.

    

  
  :type Location: dict
  :param Location: 

    Describes a location.

    

  
    - **Address** *(string) --* 

      The physical address.

      

    
    - **Latitude** *(string) --* 

      The latitude.

      

    
    - **Longitude** *(string) --* 

      The longitude.

      

    
  
  :type SiteId: string
  :param SiteId: 

    The ID of the site.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Device': {
              'DeviceId': 'string',
              'DeviceArn': 'string',
              'GlobalNetworkId': 'string',
              'AWSLocation': {
                  'Zone': 'string',
                  'SubnetArn': 'string'
              },
              'Description': 'string',
              'Type': 'string',
              'Vendor': 'string',
              'Model': 'string',
              'SerialNumber': 'string',
              'Location': {
                  'Address': 'string',
                  'Latitude': 'string',
                  'Longitude': 'string'
              },
              'SiteId': 'string',
              'CreatedAt': datetime(2015, 1, 1),
              'State': 'PENDING'|'AVAILABLE'|'DELETING'|'UPDATING',
              'Tags': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Device** *(dict) --* 

        Information about the device.

        
        

        - **DeviceId** *(string) --* 

          The ID of the device.

          
        

        - **DeviceArn** *(string) --* 

          The Amazon Resource Name (ARN) of the device.

          
        

        - **GlobalNetworkId** *(string) --* 

          The ID of the global network.

          
        

        - **AWSLocation** *(dict) --* 

          The Amazon Web Services location of the device.

          
          

          - **Zone** *(string) --* 

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

            
          

          - **SubnetArn** *(string) --* 

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

            
      
        

        - **Description** *(string) --* 

          The description of the device.

          
        

        - **Type** *(string) --* 

          The device type.

          
        

        - **Vendor** *(string) --* 

          The device vendor.

          
        

        - **Model** *(string) --* 

          The device model.

          
        

        - **SerialNumber** *(string) --* 

          The device serial number.

          
        

        - **Location** *(dict) --* 

          The site location.

          
          

          - **Address** *(string) --* 

            The physical address.

            
          

          - **Latitude** *(string) --* 

            The latitude.

            
          

          - **Longitude** *(string) --* 

            The longitude.

            
      
        

        - **SiteId** *(string) --* 

          The site ID.

          
        

        - **CreatedAt** *(datetime) --* 

          The date and time that the site was created.

          
        

        - **State** *(string) --* 

          The device state.

          
        

        - **Tags** *(list) --* 

          The tags for the device.

          
          

          - *(dict) --* 

            Describes a tag.

            
            

            - **Key** *(string) --* 

              The tag key.

               

              Constraints: Maximum length of 128 characters.

              
            

            - **Value** *(string) --* 

              The tag value.

               

              Constraints: Maximum length of 256 characters.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`NetworkManager.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkManager.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ConflictException`

  
  *   :py:class:`NetworkManager.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkManager.Client.exceptions.InternalServerException`

  