list_host_keys

Transfer.Client.list_host_keys(**kwargs)

Returns a list of host keys for the server that's specified by the ServerId parameter.

See also: AWS API Documentation

Request Syntax

response = client.list_host_keys(
    MaxResults=123,
    NextToken='string',
    ServerId='string'
)

Parameters

• MaxResults (integer) -- The maximum number of host keys to return.
• NextToken (string) -- When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListHostKeys to continue listing results.
• ServerId (string) --

  [REQUIRED]

  The identifier of the server that contains the host keys that you want to view.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ServerId': 'string',
    'HostKeys': [
        {
            'Arn': 'string',
            'HostKeyId': 'string',
            'Fingerprint': 'string',
            'Description': 'string',
            'Type': 'string',
            'DateImported': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    Returns a token that you can use to call ListHostKeys again and receive additional results, if there are any.

  • ServerId (string) --

    Returns the server identifier that contains the listed host keys.

  • HostKeys (list) --

    Returns an array, where each item contains the details of a host key.

    • (dict) --

      Returns properties of the host key that's specified.

      • Arn (string) --

        The unique Amazon Resource Name (ARN) of the host key.

      • HostKeyId (string) --

        A unique identifier for the host key.

      • Fingerprint (string) --

        The public key fingerprint, which is a short sequence of bytes used to identify the longer public key.

      • Description (string) --

        The current description for the host key. You can change it by calling the UpdateHostKey operation and providing a new description.

      • Type (string) --

        The encryption algorithm that is used for the host key. The Type parameter is specified by using one of the following values:

        • ssh-rsa
        • ssh-ed25519
        • ecdsa-sha2-nistp256
        • ecdsa-sha2-nistp384
        • ecdsa-sha2-nistp521

      • DateImported (datetime) --

        The date on which the host key was added to the server.

Exceptions

• Transfer.Client.exceptions.ServiceUnavailableException
• Transfer.Client.exceptions.InternalServiceError
• Transfer.Client.exceptions.InvalidNextTokenException
• Transfer.Client.exceptions.InvalidRequestException
• Transfer.Client.exceptions.ResourceNotFoundException