Skip to content
AWS for Query.Farm

aws.chime.get_voice_connector

Example SQL Queries

SELECT * FROM
aws.chime.get_voice_connector
WHERE
"voice_connector_id" = 'VALUE';

Description

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

This API is is no longer supported and will not be updated. We recommend using the latest version, GetVoiceConnector, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Table Definition

Column NameColumn Data Type
voice_connector_id Required Input Column

The Amazon Chime Voice Connector ID.

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.

voice_connector

The Amazon Chime Voice Connector details.

STRUCT(
    "voice_connector_id" VARCHAR,
    "aws_region" VARCHAR,
    "name" VARCHAR,
    "outbound_host_name" VARCHAR,
    "require_encryption" BOOLEAN,
    "created_timestamp" TIMESTAMP_S,
    "updated_timestamp" TIMESTAMP_S,
    "voice_connector_arn" VARCHAR
)
Show child fields
voice_connector.aws_region

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

voice_connector.created_timestamp

The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

voice_connector.name

The name of the Amazon Chime Voice Connector.

voice_connector.outbound_host_name

The outbound host name for the Amazon Chime Voice Connector.

voice_connector.require_encryption

Designates whether encryption is required for the Amazon Chime Voice Connector.

voice_connector.updated_timestamp

The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

voice_connector.voice_connector_arn

The ARN of the specified Amazon Chime Voice Connector.

voice_connector.voice_connector_id

The Amazon Chime Voice Connector ID.