finspace / Client / list_kx_scaling_groups

list_kx_scaling_groups#

finspace.Client.list_kx_scaling_groups(**kwargs)#

Returns a list of scaling groups in a kdb environment.

Request Syntax

response = client.list_kx_scaling_groups(
    environmentId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
maxResults (integer) – The maximum number of results to return in this request.
nextToken (string) – A token that indicates where a results page should begin.

Return type:

dict

Returns:

Response Syntax

{
    'scalingGroups': [
        {
            'scalingGroupName': 'string',
            'hostType': 'string',
            'clusters': [
                'string',
            ],
            'availabilityZoneId': 'string',
            'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'|'DELETE_FAILED',
            'statusReason': 'string',
            'lastModifiedTimestamp': datetime(2015, 1, 1),
            'createdTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- scalingGroups (list) –
  
  A list of scaling groups available in a kdb environment.
  - (dict) –
    
    A structure for storing metadata of scaling group.
    - scalingGroupName (string) –
      
      A unique identifier for the kdb scaling group.
    - hostType (string) –
      
      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.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.
      - kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.
      - kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.
      - 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.
    - clusters (list) –
      
      The list of clusters currently active in a given scaling group.
      - (string) –
    - availabilityZoneId (string) –
      
      The identifier of the availability zones.
    - status (string) –
      
      The status of scaling groups.
    - statusReason (string) –
      
      The error message when a failed state occurs.
    - lastModifiedTimestamp (datetime) –
      
      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.
    - createdTimestamp (datetime) –
      
      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.
- nextToken (string) –
  
  A token that indicates where a results page should begin.

Exceptions

finspace.Client.exceptions.InternalServerException
finspace.Client.exceptions.ValidationException
finspace.Client.exceptions.ThrottlingException
finspace.Client.exceptions.AccessDeniedException
finspace.Client.exceptions.LimitExceededException
finspace.Client.exceptions.ConflictException
finspace.Client.exceptions.ResourceNotFoundException