Skip to content
AWS for Query.Farm

aws.qbusiness.get_retriever

Example SQL Queries

SELECT * FROM
aws.qbusiness.get_retriever
WHERE
"application_id" = 'VALUE'
AND "retriever_id" = 'VALUE';

Description

Gets information about an existing retriever used by an Amazon Q Business application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the Amazon Q Business application using the retriever. 

VARCHAR
retriever_id Required Input Column

The identifier of the retriever.

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
configuration

Provides information on how the retriever used for your Amazon Q Business application is configured.

STRUCT(
    "native_index_configuration" STRUCT(
        "index_id" VARCHAR,
        "boosting_override" MAP(VARCHAR, STRUCT(
                "number_configuration" STRUCT(
                    "boosting_level" VARCHAR,
                    "boosting_type" VARCHAR
                ),
                "string_configuration" STRUCT(
                    "boosting_level" VARCHAR,
                    "attribute_value_boosting" MAP(VARCHAR, VARCHAR)
                ),
                "date_configuration" STRUCT(
                    "boosting_level" VARCHAR,
                    "boosting_duration_in_seconds" BIGINT
                ),
                "string_list_configuration" STRUCT(
                    "boosting_level" VARCHAR
                )
            ))
    ),
    "kendra_index_configuration" STRUCT(
        "index_id" VARCHAR
    )
)
Show child fields
configuration.kendra_index_configuration

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

Show child fields
configuration.kendra_index_configuration.index_id

The identifier of the Amazon Kendra index.

configuration.native_index_configuration

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

Show child fields
configuration.native_index_configuration.boosting_override

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

configuration.native_index_configuration.index_id

The identifier for the Amazon Q Business index.

created_at

The Unix timestamp when the retriever was created.

TIMESTAMP_S
display_name

The name of the retriever.

VARCHAR
retriever_arn

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

VARCHAR
role_arn

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

VARCHAR
status

The status of the retriever.

VARCHAR
type

The type of the retriever.

VARCHAR
updated_at

The Unix timestamp when the retriever was last updated.

TIMESTAMP_S