ListDataSourceSyncJobsCommand

Suggest an Edit

Gets statistics about synchronizing a data source connector.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KendraClient, ListDataSourceSyncJobsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ListDataSourceSyncJobsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ListDataSourceSyncJobsRequest
  Id: "STRING_VALUE", // required
  IndexId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  StartTimeFilter: { // TimeRange
    StartTime: new Date("TIMESTAMP"),
    EndTime: new Date("TIMESTAMP"),
  },
  StatusFilter: "FAILED" || "SUCCEEDED" || "SYNCING" || "INCOMPLETE" || "STOPPING" || "ABORTED" || "SYNCING_INDEXING",
};
const command = new ListDataSourceSyncJobsCommand(input);
const response = await client.send(command);
// { // ListDataSourceSyncJobsResponse
//   History: [ // DataSourceSyncJobHistoryList
//     { // DataSourceSyncJob
//       ExecutionId: "STRING_VALUE",
//       StartTime: new Date("TIMESTAMP"),
//       EndTime: new Date("TIMESTAMP"),
//       Status: "FAILED" || "SUCCEEDED" || "SYNCING" || "INCOMPLETE" || "STOPPING" || "ABORTED" || "SYNCING_INDEXING",
//       ErrorMessage: "STRING_VALUE",
//       ErrorCode: "InternalError" || "InvalidRequest",
//       DataSourceErrorCode: "STRING_VALUE",
//       Metrics: { // DataSourceSyncJobMetrics
//         DocumentsAdded: "STRING_VALUE",
//         DocumentsModified: "STRING_VALUE",
//         DocumentsDeleted: "STRING_VALUE",
//         DocumentsFailed: "STRING_VALUE",
//         DocumentsScanned: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListDataSourceSyncJobsCommand Input

See ListDataSourceSyncJobsCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The identifier of the data source connector.

IndexId
Required
string | undefined

The identifier of the index used with the data source connector.

MaxResults
number | undefined

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.

NextToken
string | undefined

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.

StartTimeFilter
TimeRange | undefined

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

StatusFilter
DataSourceSyncJobStatus | undefined

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

ListDataSourceSyncJobsCommand Output

See ListDataSourceSyncJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
History
DataSourceSyncJob[] | undefined

A history of synchronization jobs for the data source connector.

NextToken
string | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ConflictException
client

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to request throttling. Please reduce the number of requests and try again.

ValidationException
client

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

KendraServiceException
Base exception class for all service exceptions from Kendra service.