Skip to content
AWS for Query.Farm

aws.finspace.list_kx_scaling_groups

Example SQL Queries

SELECT * FROM
aws.finspace.list_kx_scaling_groups
WHERE
"environment_id" = 'VALUE';

Description

Returns a list of scaling groups in a kdb environment.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

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

VARCHAR
max_results Input Column

The maximum number of results to return in this request.

BIGINT
next_token Input Column

A token that indicates where a results page should begin. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
scaling_groups

A list of scaling groups available in a kdb environment.

STRUCT(
    "scaling_group_name" VARCHAR,
    "host_type" VARCHAR,
    "clusters" VARCHAR[],
    "availability_zone_id" VARCHAR,
    "status" VARCHAR,
    "status_reason" VARCHAR,
    "last_modified_timestamp" TIMESTAMP_S,
    "created_timestamp" TIMESTAMP_S
)[]
Show child fields
scaling_groups[]
Show child fields
scaling_groups[].availability_zone_id

The identifier of the availability zones.

scaling_groups[].clusters[]
scaling_groups[].created_timestamp

The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

scaling_groups[].host_type

The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

You can add one of the following values:

  • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

  • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

  • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

  • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

  • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

  • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

scaling_groups[].last_modified_timestamp

The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

scaling_groups[].scaling_group_name

A unique identifier for the kdb scaling group.

scaling_groups[].status

The status of scaling groups.

scaling_groups[].status_reason

The error message when a failed state occurs.