Skip to content
AWS for Query.Farm

aws.kendra.list_data_source_sync_jobs

Example SQL Queries

SELECT * FROM
aws.kendra.list_data_source_sync_jobs
WHERE
"id" = 'VALUE'
AND "index_id" = 'VALUE';

Description

Gets statistics about synchronizing a data source connector.

Table Definition

Column NameColumn Data Type
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 data source connector.

VARCHAR
max_results Input Column

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

BIGINT
next_token Input Column

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of jobs.

VARCHAR
start_time_filter Input Column

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

STRUCT(
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S
)
Show child fields
start_time_filter.end_time

The Unix timestamp for the end of the time range.

start_time_filter.start_time

The Unix timestamp for the beginning of the time range.

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
history

A history of synchronization jobs for the data source connector.

STRUCT(
    "execution_id" VARCHAR,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "status" VARCHAR,
    "error_message" VARCHAR,
    "error_code" VARCHAR,
    "data_source_error_code" VARCHAR,
    "metrics" STRUCT(
        "documents_added" VARCHAR,
        "documents_modified" VARCHAR,
        "documents_deleted" VARCHAR,
        "documents_failed" VARCHAR,
        "documents_scanned" VARCHAR
    )
)[]
Show child fields
history[]
Show child fields
history[].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.

history[].end_time

The Unix timestamp when the synchronization job completed.

history[].error_code

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

history[].error_message

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

history[].execution_id

A identifier for the synchronization job.

history[].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.

Show child fields
history[].metrics.documents_added

The number of documents added from the data source up to now in the data source sync.

history[].metrics.documents_deleted

The number of documents deleted from the data source up to now in the data source sync run.

history[].metrics.documents_failed

The number of documents that failed to sync from the data source up to now in the data source sync run.

history[].metrics.documents_modified

The number of documents modified in the data source up to now in the data source sync run.

history[].metrics.documents_scanned

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

history[].start_time

The Unix timestamp when the synchronization job started.

history[].status

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