Module Values.GetKxVolumeResponseSource

Retrieves the information about the volume.

Sourcetype nonrec t = {
  1. environmentId : KxEnvironmentId.t option;
    (*

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

    *)
  2. volumeName : KxVolumeName.t option;
    (*

    A unique identifier for the volume.

    *)
  3. volumeType : KxVolumeType.t option;
    (*

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

    *)
  4. volumeArn : KxVolumeArn.t option;
    (*

    The ARN identifier of the volume.

    *)
  5. nas1Configuration : KxNAS1Configuration.t option;
    (*

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

    *)
  6. status : KxVolumeStatus.t option;
    (*

    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.

    *)
  7. statusReason : KxVolumeStatusReason.t option;
    (*

    The error message when a failed state occurs.

    *)
  8. createdTimestamp : Timestamp.t option;
    (*

    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.

    *)
  9. description : Description.t option;
    (*

    A description of the volume.

    *)
  10. azMode : KxAzMode.t option;
    (*

    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.

    *)
  11. availabilityZoneIds : AvailabilityZoneIds.t option;
    (*

    The identifier of the availability zones.

    *)
  12. lastModifiedTimestamp : Timestamp.t option;
    (*

    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.

    *)
  13. attachedClusters : KxAttachedClusters.t option;
    (*

    A list of cluster identifiers that a volume is attached to.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ConflictException of ConflictException.t
  3. | `InternalServerException of InternalServerException.t
  4. | `LimitExceededException of LimitExceededException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `ThrottlingException of ThrottlingException.t
  7. | `ValidationException of ValidationException.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?environmentId:??? -> ?volumeName:??? -> ?volumeType:??? -> ?volumeArn:??? -> ?nas1Configuration:??? -> ?status:??? -> ?statusReason:??? -> ?createdTimestamp:??? -> ?description:??? -> ?azMode:??? -> ?availabilityZoneIds:??? -> ?lastModifiedTimestamp:??? -> ?attachedClusters:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `InternalServerException of InternalServerException.t | `LimitExceededException of LimitExceededException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `InternalServerException of InternalServerException.t | `LimitExceededException of LimitExceededException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of AvailabilityZoneId.t | `Structure of (string * [> `Enum of string | `String of KxClusterName.t ]) list ] list | `String of KxEnvironmentId.t | `Structure of (string * [> `Enum of string | `Integer of KxNAS1Size.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t