Transfer / Client / update_host_key

update_host_key

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

Request Syntax

response = client.update_host_key(
    ServerId='string',
    HostKeyId='string',
    Description='string'
)

Parameters:

• ServerId (string) –

  [REQUIRED]

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

• HostKeyId (string) –

  [REQUIRED]

  The identifier of the host key that you are updating.

• Description (string) –

  [REQUIRED]

  An updated description for the host key.

Return type:

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

• Transfer.Client.exceptions.ResourceNotFoundException

• Transfer.Client.exceptions.InvalidRequestException

• Transfer.Client.exceptions.ThrottlingException

• Transfer.Client.exceptions.InternalServiceError

• Transfer.Client.exceptions.ServiceUnavailableException