Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_host_key

Transfer.Client.describe_host_key(**kwargs)

Returns the details of the host key that's specified by the HostKeyId and ServerId .

See also: AWS API Documentation

Request Syntax

response = client.describe_host_key(
    ServerId='string',
    HostKeyId='string'
)
Parameters
  • ServerId (string) --

    [REQUIRED]

    The identifier of the server that contains the host key that you want described.

  • HostKeyId (string) --

    [REQUIRED]

    The identifier of the host key that you want described.

Return type

dict

Returns

Response Syntax

{
    'HostKey': {
        'Arn': 'string',
        'HostKeyId': 'string',
        'HostKeyFingerprint': 'string',
        'Description': 'string',
        'Type': 'string',
        'DateImported': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • HostKey (dict) --

      Returns the details for the specified host key.

      • Arn (string) --

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

      • HostKeyId (string) --

        A unique identifier for the host key.

      • HostKeyFingerprint (string) --

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

      • Description (string) --

        The text description for this host key.

      • 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.

      • Tags (list) --

        Key-value pairs that can be used to group and search for host keys.

        • (dict) --

          Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

          • Key (string) --

            The name assigned to the tag that you create.

          • Value (string) --

            Contains one or more values that you assigned to the key name you create.

Exceptions

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