:doc:`Transfer <../../transfer>` / Client / update_host_key

***************
update_host_key
***************



.. py:method:: Transfer.Client.update_host_key(**kwargs)

  

  Updates the description for the host key that's specified by the ``ServerId`` and ``HostKeyId`` parameters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateHostKey>`_  


  **Request Syntax**
  ::

    response = client.update_host_key(
        ServerId='string',
        HostKeyId='string',
        Description='string'
    )
    
  :type ServerId: string
  :param ServerId: **[REQUIRED]** 

    The identifier of the server that contains the host key that you are updating.

    

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

    The identifier of the host key that you are updating.

    

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

    An updated description for the host key.

    

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

    
    ::

      {
          'ServerId': 'string',
          'HostKeyId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ServerId** *(string) --* 

        Returns the server identifier for the server that contains the updated host key.

        
      

      - **HostKeyId** *(string) --* 

        Returns the host key identifier for the updated host key.

        
  
  **Exceptions**
  
  *   :py:class:`Transfer.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Transfer.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`Transfer.Client.exceptions.InternalServiceError`

  
  *   :py:class:`Transfer.Client.exceptions.ServiceUnavailableException`

  