Skip to content
AWS for Query.Farm

aws.directconnect.describe_hosted_connections

Example SQL Queries

SELECT * FROM
aws.directconnect.describe_hosted_connections
WHERE
"connection_id" = 'VALUE';

Description

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by Direct Connect Partners only.

Table Definition

Column NameColumn Data Type
connection_id Required Input Column

The ID of the interconnect or LAG.

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
connections

The connections.

STRUCT(
    "owner_account" VARCHAR,
    "connection_id" VARCHAR,
    "connection_name" VARCHAR,
    "connection_state" VARCHAR,
    "region" VARCHAR,
    "location" VARCHAR,
    "bandwidth" VARCHAR,
    "vlan" BIGINT,
    "partner_name" VARCHAR,
    "loa_issue_time" TIMESTAMP_S,
    "lag_id" VARCHAR,
    "aws_device" VARCHAR,
    "jumbo_frame_capable" BOOLEAN,
    "aws_device_v2" VARCHAR,
    "aws_logical_device_id" VARCHAR,
    "has_logical_redundancy" VARCHAR,
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "provider_name" VARCHAR,
    "mac_sec_capable" BOOLEAN,
    "port_encryption_status" VARCHAR,
    "encryption_mode" VARCHAR,
    "mac_sec_keys" STRUCT(
        "secret_arn" VARCHAR,
        "ckn" VARCHAR,
        "state" VARCHAR,
        "start_on" VARCHAR
    )[]
)[]
Show child fields
connections[]
Show child fields
connections[].aws_device

The Direct Connect endpoint on which the physical connection terminates.

connections[].aws_device_v2

The Direct Connect endpoint that terminates the physical connection.

connections[].aws_logical_device_id

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

connections[].bandwidth

The bandwidth of the connection.

connections[].connection_id

The ID of the connection.

connections[].connection_name

The name of the connection.

connections[].connection_state

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

connections[].encryption_mode

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connections[].has_logical_redundancy

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connections[].jumbo_frame_capable

Indicates whether jumbo frames are supported.

connections[].lag_id

The ID of the LAG.

connections[].loa_issue_time

The time of the most recent call to DescribeLoa for this connection.

connections[].location

The location of the connection.

connections[].mac_sec_capable

Indicates whether the connection supports MAC Security (MACsec).

connections[].mac_sec_keys[]
Show child fields
connections[].mac_sec_keys[].ckn

The Connection Key Name (CKN) for the MAC Security secret key.

connections[].mac_sec_keys[].secret_arn

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

connections[].mac_sec_keys[].start_on

The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

connections[].mac_sec_keys[].state

The state of the MAC Security (MACsec) secret key.

The possible values are:

  • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.

  • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.

  • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG

  • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

connections[].owner_account

The ID of the Amazon Web Services account that owns the connection.

connections[].partner_name

The name of the Direct Connect service provider associated with the connection.

connections[].port_encryption_status

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connections[].provider_name

The name of the service provider associated with the connection.

connections[].region

The Amazon Web Services Region where the connection is located.

connections[].tags[]
Show child fields
connections[].tags[].key

The key.

connections[].tags[].value

The value.

connections[].vlan

The ID of the VLAN.