Skip to content
AWS for Query.Farm

aws.qbusiness.list_data_source_sync_jobs

Example SQL Queries

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

Description

Get information about an Amazon Q Business data source connector synchronization.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The identifier of the Amazon Q Business application connected to the data source.

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 used with the Amazon Q Business data source connector.

VARCHAR
end_time Input Column

The Unix timestamp when the synchronization job completed.

TIMESTAMP_S
start_time Input Column

The Unix time stamp when the data source synchronization job started.

TIMESTAMP_S
status_filter Input Column

Only returns synchronization jobs with the Status field equal to the specified status.

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
data_source_error_code

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

VARCHAR
error

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed. 

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.

execution_id

The identifier of a data source synchronization job.

VARCHAR
metrics

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

STRUCT(
    "documents_added" VARCHAR,
    "documents_modified" VARCHAR,
    "documents_deleted" VARCHAR,
    "documents_failed" VARCHAR,
    "documents_scanned" VARCHAR
)
Show child fields
metrics.documents_added

The current count of documents added from the data source during the data source sync.

metrics.documents_deleted

The current count of documents deleted from the data source during the data source sync.

metrics.documents_failed

The current count of documents that failed to sync from the data source during the data source sync.

metrics.documents_modified

The current count of documents modified in the data source during the data source sync.

metrics.documents_scanned

The current count of documents crawled by the ongoing sync job in the data source.

status

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.

VARCHAR