finspace / Client / create_kx_volume
create_kx_volume#
- finspace.Client.create_kx_volume(**kwargs)#
Creates a new volume with a specific amount of throughput and storage capacity.
See also: AWS API Documentation
Request Syntax
response = client.create_kx_volume( clientToken='string', environmentId='string', volumeType='NAS_1', volumeName='string', description='string', nas1Configuration={ 'type': 'SSD_1000'|'SSD_250'|'HDD_12', 'size': 123 }, azMode='SINGLE'|'MULTI', availabilityZoneIds=[ 'string', ], tags={ 'string': 'string' } )
- Parameters:
clientToken (string) –
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, whose clusters can attach to the volume.
volumeType (string) –
[REQUIRED]
The type of file system volume. Currently, FinSpace only supports
NAS_1
volume type. When you selectNAS_1
volume type, you must also providenas1Configuration
.volumeName (string) –
[REQUIRED]
A unique identifier for the volume.
description (string) – A description of the volume.
nas1Configuration (dict) –
Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose
volumeType
as NAS_1.type (string) –
The type of the network attached storage.
size (integer) –
The size of the network attached storage.
azMode (string) –
[REQUIRED]
The number of availability zones you want to assign per cluster. Currently, FinSpace only support
SINGLE
for volumes.availabilityZoneIds (list) –
[REQUIRED]
The identifier of the availability zones.
(string) –
tags (dict) –
A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
(string) –
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'environmentId': 'string', 'volumeName': 'string', 'volumeType': 'NAS_1', 'volumeArn': 'string', 'nas1Configuration': { 'type': 'SSD_1000'|'SSD_250'|'HDD_12', 'size': 123 }, 'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED', 'statusReason': 'string', 'azMode': 'SINGLE'|'MULTI', 'description': 'string', 'availabilityZoneIds': [ 'string', ], 'createdTimestamp': datetime(2015, 1, 1) }
Response Structure
(dict) –
environmentId (string) –
A unique identifier for the kdb environment, whose clusters can attach to the volume.
volumeName (string) –
A unique identifier for the volume.
volumeType (string) –
The type of file system volume. Currently, FinSpace only supports
NAS_1
volume type.volumeArn (string) –
The ARN identifier of the volume.
nas1Configuration (dict) –
Specifies the configuration for the Network attached storage (NAS_1) file system volume.
type (string) –
The type of the network attached storage.
size (integer) –
The size of the network attached storage.
status (string) –
The status of volume creation.
CREATING – The volume creation is in progress.
CREATE_FAILED – The volume creation has failed.
ACTIVE – The volume is active.
UPDATING – The volume is in the process of being updated.
UPDATE_FAILED – The update action failed.
UPDATED – The volume is successfully updated.
DELETING – The volume is in the process of being deleted.
DELETE_FAILED – The system failed to delete the volume.
DELETED – The volume is successfully deleted.
statusReason (string) –
The error message when a failed state occurs.
azMode (string) –
The number of availability zones you want to assign per cluster. Currently, FinSpace only support
SINGLE
for volumes.description (string) –
A description of the volume.
availabilityZoneIds (list) –
The identifier of the availability zones.
(string) –
createdTimestamp (datetime) –
The timestamp at which the volume 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.ResourceAlreadyExistsException
finspace.Client.exceptions.AccessDeniedException