Skip to content
AWS for Query.Farm

aws.finspace.list_kx_volumes

Example SQL Queries

SELECT * FROM
aws.finspace.list_kx_volumes
WHERE
"environment_id" = 'VALUE';

Description

Lists all the volumes in a kdb environment.

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
max_results Input Column

The maximum number of results to return in this request.

BIGINT
next_token Input Column

A token that indicates where a results page should begin.

VARCHAR
volume_type Input Column

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

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
kx_volume_summaries

A summary of volumes. 

STRUCT(
    "volume_name" VARCHAR,
    "volume_type" VARCHAR,
    "status" VARCHAR,
    "description" VARCHAR,
    "status_reason" VARCHAR,
    "az_mode" VARCHAR,
    "availability_zone_ids" VARCHAR[],
    "created_timestamp" TIMESTAMP_S,
    "last_modified_timestamp" TIMESTAMP_S
)[]
Show child fields
kx_volume_summaries[]
Show child fields
kx_volume_summaries[].availability_zone_ids[]
kx_volume_summaries[].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.

kx_volume_summaries[].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.

kx_volume_summaries[].description

A description of the volume.

kx_volume_summaries[].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.

kx_volume_summaries[].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.

kx_volume_summaries[].status_reason

The error message when a failed state occurs.

kx_volume_summaries[].volume_name

A unique identifier for the volume.

kx_volume_summaries[].volume_type

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