Skip to content
AWS for Query.Farm

aws.qbusiness.get_data_source

Example SQL Queries

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

Description

Gets information about an existing Amazon Q Business data source connector.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the Amazon Q Business application.

VARCHAR
data_source_id Required Input Column

The identifier of the data source connector.

VARCHAR
index_id Required Input Column

The identifier of the index linked to the data source connector.

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

The details of how the data source connector is configured.

VARCHAR
created_at

The Unix timestamp when the data source connector was created.

TIMESTAMP_S
data_source_arn

The Amazon Resource Name (ARN) of the data source.

VARCHAR
description

The description for the data source connector.

VARCHAR
display_name

The name for the data source connector.

VARCHAR
document_enrichment_configuration

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

STRUCT(
    "inline_configurations" STRUCT(
        "condition" STRUCT(
            "key" VARCHAR,
            "operator" VARCHAR,
            "value" STRUCT(
                "string_value" VARCHAR,
                "string_list_value" VARCHAR[],
                "long_value" BIGINT,
                "date_value" TIMESTAMP_S
            )
        ),
        "target" STRUCT(
            "key" VARCHAR,
            "value" STRUCT(
                "string_value" VARCHAR,
                "string_list_value" VARCHAR[],
                "long_value" BIGINT,
                "date_value" TIMESTAMP_S
            ),
            "attribute_value_operator" VARCHAR
        ),
        "document_content_operator" VARCHAR
    )[],
    "pre_extraction_hook_configuration" STRUCT(
        "invocation_condition" STRUCT(
            "key" VARCHAR,
            "operator" VARCHAR,
            "value" STRUCT(
                "string_value" VARCHAR,
                "string_list_value" VARCHAR[],
                "long_value" BIGINT,
                "date_value" TIMESTAMP_S
            )
        ),
        "lambda_arn" VARCHAR,
        "s3_bucket_name" VARCHAR,
        "role_arn" VARCHAR
    ),
    "post_extraction_hook_configuration" STRUCT(
        "invocation_condition" STRUCT(
            "key" VARCHAR,
            "operator" VARCHAR,
            "value" STRUCT(
                "string_value" VARCHAR,
                "string_list_value" VARCHAR[],
                "long_value" BIGINT,
                "date_value" TIMESTAMP_S
            )
        ),
        "lambda_arn" VARCHAR,
        "s3_bucket_name" VARCHAR,
        "role_arn" VARCHAR
    )
)
Show child fields
document_enrichment_configuration.inline_configurations[]
Show child fields
document_enrichment_configuration.inline_configurations[].condition

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

Show child fields
document_enrichment_configuration.inline_configurations[].condition.key

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

document_enrichment_configuration.inline_configurations[].condition.operator

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

document_enrichment_configuration.inline_configurations[].condition.value

The value of a document attribute. You can only provide one value for a document attribute.

Show child fields
document_enrichment_configuration.inline_configurations[].condition.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

document_enrichment_configuration.inline_configurations[].condition.value.long_value

A long integer value.

document_enrichment_configuration.inline_configurations[].condition.value.string_list_value[]
document_enrichment_configuration.inline_configurations[].condition.value.string_value

A string.

document_enrichment_configuration.inline_configurations[].document_content_operator

TRUE to delete content if the condition used for the target attribute is met.

document_enrichment_configuration.inline_configurations[].target

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

Show child fields
document_enrichment_configuration.inline_configurations[].target.attribute_value_operator

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

document_enrichment_configuration.inline_configurations[].target.key

The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

document_enrichment_configuration.inline_configurations[].target.value

The value of a document attribute. You can only provide one value for a document attribute.

Show child fields
document_enrichment_configuration.inline_configurations[].target.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

document_enrichment_configuration.inline_configurations[].target.value.long_value

A long integer value.

document_enrichment_configuration.inline_configurations[].target.value.string_list_value[]
document_enrichment_configuration.inline_configurations[].target.value.string_value

A string.

document_enrichment_configuration.post_extraction_hook_configuration

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

Show child fields
document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

Show child fields
document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.key

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.operator

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value

The value of a document attribute. You can only provide one value for a document attribute.

Show child fields
document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.long_value

A long integer value.

document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_list_value[]
document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.value.string_value

A string.

document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

document_enrichment_configuration.post_extraction_hook_configuration.role_arn

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket_name

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

document_enrichment_configuration.pre_extraction_hook_configuration

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.

If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Custom document enrichment.

Show child fields
document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

Show child fields
document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.key

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.operator

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support _document_body as an attribute key used for the condition.

document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value

The value of a document attribute. You can only provide one value for a document attribute.

Show child fields
document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.date_value

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.long_value

A long integer value.

document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.string_list_value[]
document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.value.string_value

A string.

document_enrichment_configuration.pre_extraction_hook_configuration.lambda_arn

The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

document_enrichment_configuration.pre_extraction_hook_configuration.role_arn

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

document_enrichment_configuration.pre_extraction_hook_configuration.s3_bucket_name

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

error

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

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.

role_arn

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

VARCHAR
status

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

VARCHAR
sync_schedule

The schedule for Amazon Q Business to update the index.

VARCHAR
type

The type of the data source connector. For example, S3.

VARCHAR
updated_at

The Unix timestamp when the data source connector was last updated.

TIMESTAMP_S
vpc_configuration

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

STRUCT(
    "subnet_ids" VARCHAR[],
    "security_group_ids" VARCHAR[]
)
Show child fields
vpc_configuration.security_group_ids[]
vpc_configuration.subnet_ids[]