

# DescribeHostKey
<a name="API_DescribeHostKey"></a>

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

## Request Syntax
<a name="API_DescribeHostKey_RequestSyntax"></a>

```
{
   "HostKeyId": "string",
   "ServerId": "string"
}
```

## Request Parameters
<a name="API_DescribeHostKey_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HostKeyId](#API_DescribeHostKey_RequestSyntax) **   <a name="TransferFamily-DescribeHostKey-request-HostKeyId"></a>
The identifier of the host key that you want described.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `hostkey-[0-9a-f]{17}`   
Required: Yes

 ** [ServerId](#API_DescribeHostKey_RequestSyntax) **   <a name="TransferFamily-DescribeHostKey-request-ServerId"></a>
The identifier of the server that contains the host key that you want described.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: Yes

## Response Syntax
<a name="API_DescribeHostKey_ResponseSyntax"></a>

```
{
   "HostKey": { 
      "Arn": "string",
      "DateImported": number,
      "Description": "string",
      "HostKeyFingerprint": "string",
      "HostKeyId": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_DescribeHostKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HostKey](#API_DescribeHostKey_ResponseSyntax) **   <a name="TransferFamily-DescribeHostKey-response-HostKey"></a>
Returns the details for the specified host key.  
Type: [DescribedHostKey](API_DescribedHostKey.md) object

## Errors
<a name="API_DescribeHostKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
This exception is thrown when an error occurs in the AWS Transfer Family service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
This exception is thrown when the client submits a malformed request.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
This exception is thrown when a resource is not found by the AWSTransfer Family service.  
HTTP Status Code: 400

 ** ServiceUnavailableException **   
The request has failed because the AWSTransfer Family service is not available.  
HTTP Status Code: 500

## See Also
<a name="API_DescribeHostKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/transfer-2018-11-05/DescribeHostKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribeHostKey) 