Skip to content
AWS for Query.Farm

aws.finspace.list_kx_environments

Example SQL Queries

SELECT * FROM
aws.finspace.list_kx_environments;

Description

Returns a list of kdb environments created in an account.

Table Definition

Column NameColumn Data Type
_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
availability_zone_ids

The identifier of the availability zones where subnets for the environment are created.

VARCHAR[]
Show child fields
availability_zone_ids[]
aws_account_id

The unique identifier of the AWS account in which you create the kdb environment.

VARCHAR
certificate_authority_arn

The Amazon Resource Name (ARN) of the certificate authority:

VARCHAR
creation_timestamp

The timestamp at which the kdb environment 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
custom_dns_configuration

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

STRUCT(
    "custom_dns_server_name" VARCHAR,
    "custom_dns_server_ip" VARCHAR
)[]
Show child fields
custom_dns_configuration[]
Show child fields
custom_dns_configuration[].custom_dns_server_ip

The IP address of the DNS server.

custom_dns_configuration[].custom_dns_server_name

The name of the DNS server.

dedicated_service_account_id

A unique identifier for the AWS environment infrastructure account.

VARCHAR
description

A description of the kdb environment.

VARCHAR
dns_status

The status of DNS configuration.

VARCHAR
environment_arn

The Amazon Resource Name (ARN) of your kdb environment.

VARCHAR
environment_id

A unique identifier for the kdb environment.

VARCHAR
error_message

Specifies the error message that appears if a flow fails. 

VARCHAR
kms_key_id

The unique identifier of the KMS key.

VARCHAR
name

The name of the kdb environment.

VARCHAR
status

The status of the environment creation.

  • CREATE_REQUESTED – Environment creation has been requested.

  • CREATING – Environment is in the process of being created.

  • FAILED_CREATION – Environment creation has failed.

  • CREATED – Environment is successfully created and is currently active.

  • DELETE REQUESTED – Environment deletion has been requested.

  • DELETING – Environment is in the process of being deleted.

  • RETRY_DELETION – Initial environment deletion failed, system is reattempting delete.

  • DELETED – Environment has been deleted.

  • FAILED_DELETION – Environment deletion has failed.

VARCHAR
tgw_status

The status of the network configuration.

VARCHAR
transit_gateway_configuration

Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

STRUCT(
    "transit_gateway_id" VARCHAR,
    "routable_cidr_space" VARCHAR,
    "attachment_network_acl_configuration" STRUCT(
        "rule_number" BIGINT,
        "protocol" VARCHAR,
        "rule_action" VARCHAR,
        "port_range" STRUCT(
            "from" BIGINT,
            "to" BIGINT
        ),
        "icmp_type_code" STRUCT(
            "type" BIGINT,
            "code" BIGINT
        ),
        "cidr_block" VARCHAR
    )[]
)
Show child fields
transit_gateway_configuration.attachment_network_acl_configuration[]
Show child fields
transit_gateway_configuration.attachment_network_acl_configuration[].cidr_block

The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

transit_gateway_configuration.attachment_network_acl_configuration[].icmp_type_code

Defines the ICMP protocol that consists of the ICMP type and code.

Show child fields
transit_gateway_configuration.attachment_network_acl_configuration[].icmp_type_code.code

The ICMP code. A value of -1 means all codes for the specified ICMP type.

transit_gateway_configuration.attachment_network_acl_configuration[].icmp_type_code.type

The ICMP type. A value of -1 means all types.

transit_gateway_configuration.attachment_network_acl_configuration[].port_range

The range of ports the rule applies to.

Show child fields
transit_gateway_configuration.attachment_network_acl_configuration[].port_range.from

The first port in the range.

transit_gateway_configuration.attachment_network_acl_configuration[].port_range.to

The last port in the range.

transit_gateway_configuration.attachment_network_acl_configuration[].protocol

The protocol number. A value of -1 means all the protocols.

transit_gateway_configuration.attachment_network_acl_configuration[].rule_action

Indicates whether to allow or deny the traffic that matches the rule.

transit_gateway_configuration.attachment_network_acl_configuration[].rule_number

The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.

transit_gateway_configuration.routable_cidr_space

The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.

transit_gateway_configuration.transit_gateway_id

The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.

update_timestamp

The timestamp at which the kdb environment was modified 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