Skip to content

describe_host_key async

describe_host_key(
    server_id: ServerId,
    host_key_id: HostKeyId,
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> DescribeHostKeyResponse

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

Parameters:

  • server_id (ServerId) –

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

  • host_key_id (HostKeyId) –

    The identifier of the host key that you want described.

Raises:

Source code in docs_src/capo_transfer/_services/async_transfer.py
async def describe_host_key(
    self,
    server_id: "capo_transfer.types.server_id.ServerId",
    host_key_id: "capo_transfer.types.host_key_id.HostKeyId",
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> "capo_transfer.types.describe_host_key_response.DescribeHostKeyResponse":
    """<p>Returns the details of the host key that's specified by the <code>HostKeyId</code> and <code>ServerId</code>.</p>

    Args:
        server_id: <p>The identifier of the server that contains the host key that you want described.</p>
        host_key_id: <p>The identifier of the host key that you want described.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transfer.types.describe_host_key_request.DescribeHostKeyRequest]",
    ) -> AsyncOperationResponse[
        "capo_transfer.types.describe_host_key_response.DescribeHostKeyResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_host_key

        (
            output,
            http_response,
        ) = await capo_transfer._operations.transfer_service.describe_host_key.async_describe_host_key(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeHostKey")
    )
    input_: capo_transfer.types.describe_host_key_request.DescribeHostKeyRequest = {
        "server_id": server_id,
        "host_key_id": host_key_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output