finspace / Client / create_kx_scaling_group

create_kx_scaling_group#

finspace.Client.create_kx_scaling_group(**kwargs)#

Creates a new scaling group.

See also: AWS API Documentation

Request Syntax

response = client.create_kx_scaling_group(
    clientToken='string',
    environmentId='string',
    scalingGroupName='string',
    hostType='string',
    availabilityZoneId='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    [REQUIRED]

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment, where you want to create the scaling group.

  • scalingGroupName (string) –

    [REQUIRED]

    A unique identifier for the kdb scaling group.

  • hostType (string) –

    [REQUIRED]

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

  • availabilityZoneId (string) –

    [REQUIRED]

    The identifier of the availability zones.

  • tags (dict) –

    A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string',
    'scalingGroupName': 'string',
    'hostType': 'string',
    'availabilityZoneId': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'DELETED'|'DELETE_FAILED',
    'lastModifiedTimestamp': datetime(2015, 1, 1),
    'createdTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • environmentId (string) –

      A unique identifier for the kdb environment, where you create the 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.

    • availabilityZoneId (string) –

      The identifier of the availability zones.

    • status (string) –

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

    • 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.

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

  • finspace.Client.exceptions.AccessDeniedException