list_host_keys ¶

def list_host_keys(
    self,
    server_id: "capo_transfer.types.server_id.ServerId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    max_results: Optional["capo_transfer.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_transfer.types.next_token.NextToken"] = None,
) -> "capo_transfer.types.list_host_keys_response.ListHostKeysResponse":
    """<p>Returns a list of host keys for the server that's specified by the <code>ServerId</code> parameter.</p>

    Args:
        max_results: <p>The maximum number of items to return.</p>
        next_token: <p>When there are additional results that were not returned, a <code>NextToken</code> parameter is returned. You can use that value for a subsequent call to <code>ListHostKeys</code> to continue listing results.</p>
        server_id: <p>The identifier of the server that contains the host keys that you want to view.</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_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> parameter that was passed is invalid.</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.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.list_host_keys_request.ListHostKeysRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.list_host_keys_response.ListHostKeysResponse"
    ]:
        import capo_transfer._operations.transfer_service.list_host_keys

        output, http_response = (
            capo_transfer._operations.transfer_service.list_host_keys.list_host_keys(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListHostKeys")
    )
    input_: capo_transfer.types.list_host_keys_request.ListHostKeysRequest = {
        "server_id": server_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output