Skip to content

get_cluster()

Get information about a cluster.

get_cluster(name=nothing, ...)

Description

This function retrieves information about a cluster with the given name. It retrieves the cluster status, the number of running sessions, and the ARN of the cluster's S3 bucket.

Required Parameters

name (String)

Name of cluster to retrieve information about

Returns (Cluster)

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_cluster("mycluster")