Skip to content
AWS for Query.Farm

aws.connect.describe_instance

Example SQL Queries

SELECT * FROM
aws.connect.describe_instance
WHERE
"instance_id" = 'VALUE';

Description

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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
instance

The name of the instance.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "identity_management_type" VARCHAR,
    "instance_alias" VARCHAR,
    "created_time" TIMESTAMP_S,
    "service_role" VARCHAR,
    "instance_status" VARCHAR,
    "status_reason" STRUCT(
        "message" VARCHAR
    ),
    "inbound_calls_enabled" BOOLEAN,
    "outbound_calls_enabled" BOOLEAN,
    "instance_access_url" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
instance.arn

The Amazon Resource Name (ARN) of the instance.

instance.created_time

When the instance was created.

instance.id

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

instance.identity_management_type

The identity management type.

instance.inbound_calls_enabled

Whether inbound calls are enabled.

instance.instance_access_url

This URL allows contact center users to access the Amazon Connect admin website.

instance.instance_alias

The alias of instance.

instance.instance_status

The state of the instance.

instance.outbound_calls_enabled

Whether outbound calls are enabled.

instance.service_role

The service role of the instance.

instance.status_reason

Relevant details why the instance was not successfully created.

Show child fields
instance.status_reason.message

The message.

instance.tags

The tags of an instance.