civis (version 2.1.0)

clusters_get_workers: Describe a Worker Cluster

Description

Describe a Worker Cluster

Usage

clusters_get_workers(id)

Arguments

id

integer required. The ID of this cluster.

Value

A list containing the following elements:

id

integer, The ID of this cluster.

instanceType

string, The EC2 instance types in this cluster.

minInstances

integer, The minimum number of instances in this cluster.

maxInstances

integer, The maximum number of instances in this cluster.

instances

integer, The number of instances currently in this cluster.

instanceMaxMemory

integer, The amount of memory available to a single instance.

instanceMaxCpu

integer, The number of processor shares available to a single instance.

instanceMaxDiskSpace

number, The amount of memory available to a single instance.

region

string, The AWS region that this cluster is in.

activeJobsCount

integer, The number of jobs currently being run in the cluster.

queuedJobsCount

integer, The number of jobs currently waiting to be run on the cluster.