get_clusters()

Get information about all clusters.

get_clusters(...)

Description

This function retrieves information about all clusters that you have permission to. It retrieves the cluster status, the number of running sessions, and the ARN of the cluster's S3 bucket for each cluster.

Returns (Array[Cluster])

List of Banyan struct Cluster dictionary, containing the cluster configuration.

[
    Cluster(
        "mycluster",  # name
        :running,  # status
        4,  # num_sessions_running
        "arn:aws:s3:::banyan-cluster-data-mycluster-1234abcd"  # s3_bucket_arn
    ),
]

Example Usage

get_clusters()