Skip to content

UpdateKxVolumeResponse

Source code in docs_src/capo_finspace/types/update_kx_volume_response.py
class UpdateKxVolumeResponse(TypedDict, closed=True):
    environment_id: NotRequired["capo_finspace.types.kx_environment_id.KxEnvironmentId"]
    """<p>A unique identifier for the kdb environment where you want to update the volume. </p>"""
    volume_name: NotRequired["capo_finspace.types.kx_volume_name.KxVolumeName"]
    """<p>A unique identifier for the volume that you want to update.</p>"""
    volume_type: NotRequired["capo_finspace.types.kx_volume_type.KxVolumeType"]
    """<p> The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type. </p>"""
    volume_arn: NotRequired["capo_finspace.types.kx_volume_arn.KxVolumeArn"]
    """<p> The ARN identifier of the volume. </p>"""
    nas1_configuration: NotRequired[
        "capo_finspace.types.kx_nas1_configuration.KxNAS1Configuration"
    ]
    """<p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>"""
    status: NotRequired["capo_finspace.types.kx_volume_status.KxVolumeStatus"]
    """<p>The status of the volume.</p> <ul> <li> <p>CREATING – The volume creation is in progress.</p> </li> <li> <p>CREATE_FAILED – The volume creation has failed.</p> </li> <li> <p>ACTIVE – The volume is active.</p> </li> <li> <p>UPDATING – The volume is in the process of being updated.</p> </li> <li> <p>UPDATE_FAILED – The update action failed.</p> </li> <li> <p>UPDATED – The volume is successfully updated.</p> </li> <li> <p>DELETING – The volume is in the process of being deleted.</p> </li> <li> <p>DELETE_FAILED – The system failed to delete the volume.</p> </li> <li> <p>DELETED – The volume is successfully deleted.</p> </li> </ul>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p> The description for the volume. </p>"""
    status_reason: NotRequired[
        "capo_finspace.types.kx_volume_status_reason.KxVolumeStatusReason"
    ]
    """<p>The error message when a failed state occurs. </p>"""
    created_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p> 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.</p>"""
    az_mode: NotRequired["capo_finspace.types.kx_az_mode.KxAzMode"]
    """<p>The number of availability zones you want to assign per volume. Currently, FinSpace only supports <code>SINGLE</code> for volumes. This places dataview in a single AZ.</p>"""
    availability_zone_ids: NotRequired[
        "capo_finspace.types.availability_zone_ids.AvailabilityZoneIds"
    ]
    """<p>The identifier of the availability zones.</p>"""
    last_modified_timestamp: NotRequired["capo_finspace.types.timestamp.Timestamp"]
    """<p>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.</p>"""
    attached_clusters: NotRequired[
        "capo_finspace.types.kx_attached_clusters.KxAttachedClusters"
    ]
    """<p> Specifies the clusters that a volume is attached to. </p>"""

attached_clusters instance-attribute

attached_clusters: NotRequired[KxAttachedClusters]

Specifies the clusters that a volume is attached to.

availability_zone_ids instance-attribute

availability_zone_ids: NotRequired[AvailabilityZoneIds]

The identifier of the availability zones.

az_mode instance-attribute

az_mode: NotRequired[KxAzMode]

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.

created_timestamp instance-attribute

created_timestamp: NotRequired[Timestamp]

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.

description instance-attribute

description: NotRequired[Description]

The description for the volume.

environment_id instance-attribute

environment_id: NotRequired[KxEnvironmentId]

A unique identifier for the kdb environment where you want to update the volume.

last_modified_timestamp instance-attribute

last_modified_timestamp: NotRequired[Timestamp]

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.

nas1_configuration instance-attribute

nas1_configuration: NotRequired[KxNAS1Configuration]

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

status instance-attribute

status: NotRequired[KxVolumeStatus]

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.

status_reason instance-attribute

status_reason: NotRequired[KxVolumeStatusReason]

The error message when a failed state occurs.

volume_arn instance-attribute

volume_arn: NotRequired[KxVolumeArn]

The ARN identifier of the volume.

volume_name instance-attribute

volume_name: NotRequired[KxVolumeName]

A unique identifier for the volume that you want to update.

volume_type instance-attribute

volume_type: NotRequired[KxVolumeType]

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