Skip to content

List Data Source Sync Jobs

kendra_list_data_source_sync_jobs R Documentation

Gets statistics about synchronizing a data source connector

Description

Gets statistics about synchronizing a data source connector.

Usage

kendra_list_data_source_sync_jobs(Id, IndexId, NextToken, MaxResults,
  StartTimeFilter, StatusFilter)

Arguments

Id

[required] The identifier of the data source connector.

IndexId

[required] The identifier of the index used with the data source connector.

NextToken

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.

MaxResults

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.

StartTimeFilter

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

StatusFilter

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

Value

A list with the following syntax: 

list(
  History = list(
    list(
      ExecutionId = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "FAILED"|"SUCCEEDED"|"SYNCING"|"INCOMPLETE"|"STOPPING"|"ABORTED"|"SYNCING_INDEXING",
      ErrorMessage = "string",
      ErrorCode = "InternalError"|"InvalidRequest",
      DataSourceErrorCode = "string",
      Metrics = list(
        DocumentsAdded = "string",
        DocumentsModified = "string",
        DocumentsDeleted = "string",
        DocumentsFailed = "string",
        DocumentsScanned = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_data_source_sync_jobs(
  Id = "string",
  IndexId = "string",
  NextToken = "string",
  MaxResults = 123,
  StartTimeFilter = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  StatusFilter = "FAILED"|"SUCCEEDED"|"SYNCING"|"INCOMPLETE"|"STOPPING"|"ABORTED"|"SYNCING_INDEXING"
)