Skip to content

list_kx_cluster_nodes

list_kx_cluster_nodes(
    environment_id: KxEnvironmentId,
    cluster_name: KxClusterName,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ResultLimit] = None,
) -> ListKxClusterNodesResponse

Lists all the nodes in a kdb cluster.

Parameters:

  • environment_id (KxEnvironmentId) –

    A unique identifier for the kdb environment.

  • cluster_name (KxClusterName) –

    A unique name for the cluster.

  • next_token (Optional[PaginationToken], default: None ) –

    A token that indicates where a results page should begin.

  • max_results (Optional[ResultLimit], default: None ) –

    The maximum number of results to return in this request.

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py
def list_kx_cluster_nodes(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    cluster_name: "capo_finspace.types.kx_cluster_name.KxClusterName",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    next_token: Optional[
        "capo_finspace.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_finspace.types.result_limit.ResultLimit"] = None,
) -> (
    "capo_finspace.types.list_kx_cluster_nodes_response.ListKxClusterNodesResponse"
):
    """<p>Lists all the nodes in a kdb cluster.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        cluster_name: <p>A unique name for the cluster.</p>
        next_token: <p>A token that indicates where a results page should begin.</p>
        max_results: <p>The maximum number of results to return in this request.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.limit_exceeded_exception.LimitExceededException: <p>A service limit or quota is exceeded.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.list_kx_cluster_nodes_request.ListKxClusterNodesRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.list_kx_cluster_nodes_response.ListKxClusterNodesResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.list_kx_cluster_nodes

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.list_kx_cluster_nodes.list_kx_cluster_nodes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListKxClusterNodes")
    )
    input_: capo_finspace.types.list_kx_cluster_nodes_request.ListKxClusterNodesRequest = {
        "environment_id": environment_id,
        "cluster_name": cluster_name,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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