CreateKxVolume - Amazon FinSpace
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

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 will not be affected. For more information, review the FAQ or contact AWS Support to assist with your transition.

CreateKxVolume

Creates a new volume with a specific amount of throughput and storage capacity.

Request Syntax

POST /kx/environments/environmentId/kxvolumes HTTP/1.1
Content-type: application/json

{
   "availabilityZoneIds": [ "string" ],
   "azMode": "string",
   "clientToken": "string",
   "description": "string",
   "nas1Configuration": { 
      "size": number,
      "type": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "volumeName": "string",
   "volumeType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment, whose clusters can attach to the volume.

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.

availabilityZoneIds

The identifier of the availability zones.

Type: Array of strings

Length Constraints: Minimum length of 8. Maximum length of 12.

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

azMode

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

Type: String

Valid Values: SINGLE | MULTI

Required: Yes

volumeName

A unique identifier for the volume.

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

volumeType

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.

Type: String

Valid Values: NAS_1

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: No

description

A description of the volume.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

Required: No

nas1Configuration

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: KxNAS1Configuration object

Required: No

tags

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

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

{
   "availabilityZoneIds": [ "string" ],
   "azMode": "string",
   "createdTimestamp": number,
   "description": "string",
   "environmentId": "string",
   "nas1Configuration": { 
      "size": number,
      "type": "string"
   },
   "status": "string",
   "statusReason": "string",
   "volumeArn": "string",
   "volumeName": "string",
   "volumeType": "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.

availabilityZoneIds

The identifier of the availability zones.

Type: Array of strings

Length Constraints: Minimum length of 8. Maximum length of 12.

Pattern: ^[a-zA-Z0-9-]+$

azMode

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

Type: String

Valid Values: SINGLE | MULTI

createdTimestamp

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.

Type: Timestamp

description

A description of the volume.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^[a-zA-Z0-9. ]{1,1000}$

environmentId

A unique identifier for the kdb environment, whose clusters can attach to the volume.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-z0-9]+$

nas1Configuration

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

Type: KxNAS1Configuration object

status

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.

Type: String

Valid Values: CREATING | CREATE_FAILED | ACTIVE | UPDATING | UPDATED | UPDATE_FAILED | DELETING | DELETED | DELETE_FAILED

statusReason

The error message when a failed state occurs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Pattern: ^[a-zA-Z0-9\_\-\.\s]+$

volumeArn

The ARN identifier of the volume.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}(/kxSharedVolume/[a-zA-Z0-9_-]{1,255})?$

volumeName

A unique identifier for the volume.

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]$

volumeType

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

Type: String

Valid Values: NAS_1

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

ResourceAlreadyExistsException

The specified resource group already exists.

HTTP Status Code: 409

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: