Skip to content
AWS for Query.Farm

aws.workspaces.describe_connection_aliases

Example SQL Queries

SELECT * FROM
aws.workspaces.describe_connection_aliases;

Description

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Table Definition

Column NameColumn Data Type
alias_ids Input Column

The identifiers of the connection aliases to describe.

VARCHAR[]
Show child fields
alias_ids[]
limit Input Column

The maximum number of connection aliases to return.

BIGINT
next_token Input Column

The token to use to retrieve the next page of results. This value is null when there are no more results to return. 

VARCHAR
resource_id Input Column

The identifier of the directory associated with the connection alias.

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
connection_aliases

Information about the specified connection aliases.

STRUCT(
    "connection_string" VARCHAR,
    "alias_id" VARCHAR,
    "state" VARCHAR,
    "owner_account_id" VARCHAR,
    "associations" STRUCT(
        "association_status" VARCHAR,
        "associated_account_id" VARCHAR,
        "resource_id" VARCHAR,
        "connection_identifier" VARCHAR
    )[]
)[]
Show child fields
connection_aliases[]
Show child fields
connection_aliases[].alias_id

The identifier of the connection alias.

connection_aliases[].associations[]
Show child fields
connection_aliases[].associations[].associated_account_id

The identifier of the Amazon Web Services account that associated the connection alias with a directory.

connection_aliases[].associations[].association_status

The association status of the connection alias.

connection_aliases[].associations[].connection_identifier

The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.

connection_aliases[].associations[].resource_id

The identifier of the directory associated with a connection alias.

connection_aliases[].connection_string

The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.

connection_aliases[].owner_account_id

The identifier of the Amazon Web Services account that owns the connection alias.

connection_aliases[].state

The current state of the connection alias.