KxVolume - Amazon FinSpace
ContentsSee 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.

KxVolume

The structure that contains the metadata of the volume.

Contents

Note

In the following list, the required parameters are described first.

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

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

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

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

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

Required: No

status

The status of 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

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

Required: No

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

Required: No

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

volumeType

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

Type: String

Valid Values: NAS_1

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: