Skip to content
AWS for Query.Farm

aws.connect.describe_view

Example SQL Queries

SELECT * FROM
aws.connect.describe_view
WHERE
"instance_id" = 'VALUE'
AND "view_id" = 'VALUE';

Description

Retrieves the view for the specified Amazon Connect instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

$SAVED needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Table Definition

Column NameColumn Data Type
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

VARCHAR
view_id Required Input Column

The ViewId of the view. This must be an ARN for Amazon Web Services managed views.

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
view

All view data is contained within the View object.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "status" VARCHAR,
    "type" VARCHAR,
    "description" VARCHAR,
    "version" BIGINT,
    "version_description" VARCHAR,
    "content" STRUCT(
        "input_schema" VARCHAR,
        "template" VARCHAR,
        "actions" VARCHAR[]
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "created_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S,
    "view_content_sha256" VARCHAR
)
Show child fields
view.arn

The Amazon Resource Name (ARN) of the view.

view.content

View content containing all content necessary to render a view except for runtime input data.

Show child fields
view.content.actions[]
view.content.input_schema

The data schema matching data that the view template must be provided to render.

view.content.template

The view template representing the structure of the view.

view.created_time

The timestamp of when the view was created.

view.description

The description of the view.

view.id

The identifier of the view.

view.last_modified_time

Latest timestamp of the UpdateViewContent or CreateViewVersion operations.

view.name

The name of the view.

view.status

Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.

view.tags

The tags associated with the view resource (not specific to view version).

view.type

The type of the view - CUSTOMER_MANAGED.

view.version

Current version of the view.

view.version_description

The description of the version.

view.view_content_sha256

Indicates the checksum value of the latest published view content.