finspace / Client / list_kx_volumes

list_kx_volumes#

finspace.Client.list_kx_volumes(**kwargs)#

Lists all the volumes in a kdb environment.

See also: AWS API Documentation

Request Syntax

response = client.list_kx_volumes(
    environmentId='string',
    maxResults=123,
    nextToken='string',
    volumeType='NAS_1'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return in this request.

  • nextToken (string) – A token that indicates where a results page should begin.

  • volumeType (string) – The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

Return type:

dict

Returns:

Response Syntax

{
    'kxVolumeSummaries': [
        {
            'volumeName': 'string',
            'volumeType': 'NAS_1',
            'status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATED'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETE_FAILED',
            'description': 'string',
            'statusReason': 'string',
            'azMode': 'SINGLE'|'MULTI',
            'availabilityZoneIds': [
                'string',
            ],
            'createdTimestamp': datetime(2015, 1, 1),
            'lastModifiedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • kxVolumeSummaries (list) –

      A summary of volumes.

      • (dict) –

        The structure that contains the metadata of the volume.

        • volumeName (string) –

          A unique identifier for the volume.

        • volumeType (string) –

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

        • status (string) –

          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.

        • description (string) –

          A description of the volume.

        • statusReason (string) –

          The error message when a failed state occurs.

        • azMode (string) –

          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.

        • availabilityZoneIds (list) –

          The identifier of the availability zones.

          • (string) –

        • createdTimestamp (datetime) –

          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.

        • lastModifiedTimestamp (datetime) –

          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.

    • nextToken (string) –

      A token that indicates where a results page should begin.

Exceptions