list_kx_clusters async ¶

async def list_kx_clusters(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    cluster_type: Optional[
        "capo_finspace.types.kx_cluster_type.KxClusterType"
    ] = None,
    max_results: Optional["capo_finspace.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_finspace.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_finspace.types.list_kx_clusters_response.ListKxClustersResponse":
    """<p>Returns a list of clusters.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        cluster_type: <p>Specifies the type of KDB database that is being created. The following types are available: </p> <ul> <li> <p>HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.</p> </li> <li> <p>RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the <code>savedownStorageConfiguration</code> parameter.</p> </li> <li> <p>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</p> </li> <li> <p>GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only <code>SINGLE</code> AZ mode.</p> </li> <li> <p>Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.</p> </li> </ul>
        max_results: <p>The maximum number of results to return in this request.</p>
        next_token: <p>A token that indicates where a results page should begin.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.list_kx_clusters_request.ListKxClustersRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.list_kx_clusters_response.ListKxClustersResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.list_kx_clusters

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.list_kx_clusters.async_list_kx_clusters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListKxClusters")
    )
    input_: capo_finspace.types.list_kx_clusters_request.ListKxClustersRequest = {
        "environment_id": environment_id
    }
    if cluster_type is not None:
        input_["cluster_type"] = cluster_type
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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