List Kx Scaling Groups

finspace_list_kx_scaling_groups

R Documentation

Returns a list of scaling groups in a kdb environment

Description

Returns a list of scaling groups in a kdb environment.

Usage

finspace_list_kx_scaling_groups(environmentId, maxResults, nextToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.

maxResults

The maximum number of results to return in this request.

nextToken

A token that indicates where a results page should begin.

Value

A list with the following syntax:

list(
  scalingGroups = list(
    list(
      scalingGroupName = "string",
      hostType = "string",
      clusters = list(
        "string"
      ),
      availabilityZoneId = "string",
      status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"DELETING"|"DELETED"|"DELETE_FAILED",
      statusReason = "string",
      lastModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      createdTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_kx_scaling_groups(
  environmentId = "string",
  maxResults = 123,
  nextToken = "string"
)