Skip to content
AWS for Query.Farm

aws.qbusiness.get_index

Example SQL Queries

SELECT * FROM
aws.qbusiness.get_index
WHERE
"application_id" = 'VALUE'
AND "index_id" = 'VALUE';

Description

Gets information about an existing Amazon Q Business index.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the Amazon Q Business application associated with the index.

VARCHAR
index_id Required Input Column

The identifier of the Amazon Q Business index.

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
capacity_configuration

The storage capacity units chosen for your Amazon Q Business index.

STRUCT(
    "units" BIGINT
)
Show child fields
capacity_configuration.units

The number of storage units configured for an Amazon Q Business index.

created_at

The Unix timestamp when the Amazon Q Business index was created.

TIMESTAMP_S
description

The description for the Amazon Q Business index.

VARCHAR
display_name

The name of the Amazon Q Business index.

VARCHAR
document_attribute_configurations

Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

STRUCT(
    "name" VARCHAR,
    "type" VARCHAR,
    "search" VARCHAR
)[]
Show child fields
document_attribute_configurations[]
Show child fields
document_attribute_configurations[].name

The name of the document attribute.

document_attribute_configurations[].search

Information about whether the document attribute can be used by an end user to search for information on their web experience.

document_attribute_configurations[].type

The type of document attribute.

error

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

STRUCT(
    "error_message" VARCHAR,
    "error_code" VARCHAR
)
Show child fields
error.error_code

The code associated with the data source sync error.

error.error_message

The message explaining the data source sync error.

index_arn

The Amazon Resource Name (ARN) of the Amazon Q Business index. 

VARCHAR
index_statistics

Provides information about the number of documents indexed.

STRUCT(
    "text_document_statistics" STRUCT(
        "indexed_text_bytes" BIGINT,
        "indexed_text_document_count" BIGINT
    )
)
Show child fields
index_statistics.text_document_statistics

The number of documents indexed.

Show child fields
index_statistics.text_document_statistics.indexed_text_bytes

The total size, in bytes, of the indexed documents.

index_statistics.text_document_statistics.indexed_text_document_count

The number of text documents indexed.

status

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

VARCHAR
type

The type of index attached to your Amazon Q Business application.

VARCHAR
updated_at

The Unix timestamp when the Amazon Q Business index was last updated.

TIMESTAMP_S