Skip to content
AWS for Query.Farm

aws.finspace.list_kx_users

Example SQL Queries

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

Description

Lists all the users in a kdb environment.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

A unique identifier for the kdb environment.

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
_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
users

A list of users in a kdb environment.

STRUCT(
    "user_arn" VARCHAR,
    "user_name" VARCHAR,
    "iam_role" VARCHAR,
    "create_timestamp" TIMESTAMP_S,
    "update_timestamp" TIMESTAMP_S
)[]
Show child fields
users[]
Show child fields
users[].create_timestamp

The timestamp at which the kdb user was created.

users[].iam_role

The IAM role ARN that is associated with the user.

users[].update_timestamp

The timestamp at which the kdb user was updated.

users[].user_arn

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

users[].user_name

A unique identifier for the user.