Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateKxVolume

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

Request Syntax


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

{
   "clientToken": "string",
   "description": "string",
   "nas1Configuration": { 
      "size": number,
      "type": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment where you created the storage volume.

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

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

Required: Yes

volumeName

A unique identifier for the volume.

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

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

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

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

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.

Type: KxNAS1Configuration object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "attachedClusters": [ 
      { 
         "clusterName": "string",
         "clusterStatus": "string",
         "clusterType": "string"
      }
   ],
   "availabilityZoneIds": [ "string" ],
   "azMode": "string",
   "createdTimestamp": number,
   "description": "string",
   "environmentId": "string",
   "lastModifiedTimestamp": number,
   "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.

attachedClusters

Specifies the clusters that a volume is attached to.

Type: Array of KxAttachedCluster objects

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

The description for 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 where you want to update the volume.

Type: String

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

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

lastModifiedTimestamp

The last time that the volume 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

nas1Configuration

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

Type: KxNAS1Configuration object

status

The status of the volume.

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

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 that you want to update.

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

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