get_kx_cluster ¶

get_kx_cluster(
    environment_id: KxEnvironmentId,
    cluster_name: KxClusterName,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
) -> GetKxClusterResponse

Retrieves information about a kdb cluster.

Parameters:

environment_id (KxEnvironmentId) –

A unique identifier for the kdb environment.
cluster_name (KxClusterName) –

The name of the cluster that you want to retrieve.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

There was a conflict with this action, and it could not be completed.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure.
LimitExceededException –

A service limit or quota is exceeded.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an AWS service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_finspace/_services/finspace.py

def get_kx_cluster(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    cluster_name: "capo_finspace.types.kx_cluster_name.KxClusterName",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
) -> "capo_finspace.types.get_kx_cluster_response.GetKxClusterResponse":
    """<p>Retrieves information about a kdb cluster.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        cluster_name: <p>The name of the cluster that you want to retrieve.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</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.get_kx_cluster_request.GetKxClusterRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.get_kx_cluster_response.GetKxClusterResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.get_kx_cluster

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKxCluster")
    )
    input_: capo_finspace.types.get_kx_cluster_request.GetKxClusterRequest = {
        "environment_id": environment_id,
        "cluster_name": cluster_name,
    }

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