ListedHostKey - AWS Transfer Family

ListedHostKey

Returns properties of the host key that's specified.

Contents

Arn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: Yes

DateImported

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

Type: Timestamp

Required: No

Description

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: [\p{Print}]*

Required: No

Fingerprint

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

Type: String

Required: No

HostKeyId

A unique identifier for the host key.

Type: String

Length Constraints: Fixed length of 25.

Pattern: hostkey-[0-9a-f]{17}

Required: No

Type

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: