Amazon FinSpace Dataset Browser will be discontinued on November 29,
2024
. Starting November 29, 2023
, FinSpace will no longer accept the creation of new Dataset Browser
environments. Customers using Amazon FinSpace with Managed Kdb Insights
CreateKxScalingGroup
Creates a new scaling group.
Request Syntax
POST /kx/environments/environmentId
/scalingGroups HTTP/1.1
Content-type: application/json
{
"availabilityZoneId": "string
",
"clientToken": "string
",
"hostType": "string
",
"scalingGroupName": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- environmentId
-
A unique identifier for the kdb environment, where you want to create the scaling group.
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-z0-9]+$
Required: Yes
Request Body
The request accepts the following data in JSON format.
- availabilityZoneId
-
The identifier of the availability zones.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 12.
Pattern:
^[a-zA-Z0-9-]+$
Required: Yes
- clientToken
-
A token that ensures idempotency. This token expires in 10 minutes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
.*\S.*
Required: Yes
- hostType
-
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.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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9._]+
Required: Yes
-
- scalingGroupName
-
A unique identifier for the kdb scaling group.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$
Required: Yes
-
A list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Value Pattern:
^[a-zA-Z0-9+-=._:@ ]+$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"availabilityZoneId": "string",
"createdTimestamp": number,
"environmentId": "string",
"hostType": "string",
"lastModifiedTimestamp": number,
"scalingGroupName": "string",
"status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- availabilityZoneId
-
The identifier of the availability zones.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 12.
Pattern:
^[a-zA-Z0-9-]+$
- createdTimestamp
-
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.
Type: Timestamp
- environmentId
-
A unique identifier for the kdb environment, where you create the scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-z0-9]+$
- hostType
-
The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9._]+
- lastModifiedTimestamp
-
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.
Type: Timestamp
- scalingGroupName
-
A unique identifier for the kdb scaling group.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$
- status
-
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.
Type: String
Valid Values:
CREATING | CREATE_FAILED | ACTIVE | DELETING | DELETED | DELETE_FAILED
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There was a conflict with this action, and it could not be completed.
HTTP Status Code: 409
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- LimitExceededException
-
A service limit or quota is exceeded.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: