Skip to content
AWS for Query.Farm

aws.finspace.get_kx_volume

Example SQL Queries

SELECT * FROM
aws.finspace.get_kx_volume
WHERE
"environment_id" = 'VALUE'
AND "volume_name" = 'VALUE';

Description

Retrieves the information about the volume.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

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

VARCHAR
volume_name Required Input Column

A unique identifier for the volume.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
attached_clusters

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

STRUCT(
    "cluster_name" VARCHAR,
    "cluster_type" VARCHAR,
    "cluster_status" VARCHAR
)[]
Show child fields
attached_clusters[]
Show child fields
attached_clusters[].cluster_name

A unique name for the attached cluster.

attached_clusters[].cluster_status

The status of the attached cluster.

  • PENDING – The cluster is pending creation.

  • CREATING – The cluster creation process is in progress.

  • CREATE_FAILED – The cluster creation process has failed.

  • RUNNING – The cluster creation process is running.

  • UPDATING – The cluster is in the process of being updated.

  • DELETING – The cluster is in the process of being deleted.

  • DELETED – The cluster has been deleted.

  • DELETE_FAILED – The cluster failed to delete.

attached_clusters[].cluster_type

Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

availability_zone_ids

The identifier of the availability zones.

VARCHAR[]
Show child fields
availability_zone_ids[]
az_mode

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.

VARCHAR
created_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. 

TIMESTAMP_S
description

A description of the volume. 

VARCHAR
last_modified_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.

TIMESTAMP_S
nas1_configuration

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

STRUCT(
    "type" VARCHAR,
    "size" BIGINT
)
Show child fields
nas1_configuration.size

The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

nas1_configuration.type

The type of the network attached storage.

status

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.

VARCHAR
status_reason

The error message when a failed state occurs. 

VARCHAR
volume_arn

The ARN identifier of the volume. 

VARCHAR
volume_type

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

VARCHAR