StartDataSourceSyncJobCommand

Suggest an Edit

Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.

Example Syntax

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

import { KendraClient, StartDataSourceSyncJobCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, StartDataSourceSyncJobCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // StartDataSourceSyncJobRequest
  Id: "STRING_VALUE", // required
  IndexId: "STRING_VALUE", // required
};
const command = new StartDataSourceSyncJobCommand(input);
const response = await client.send(command);
// { // StartDataSourceSyncJobResponse
//   ExecutionId: "STRING_VALUE",
// };

StartDataSourceSyncJobCommand Input

See StartDataSourceSyncJobCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The identifier of the data source connector to synchronize.

IndexId
Required
string | undefined

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

StartDataSourceSyncJobCommand Output

See StartDataSourceSyncJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ExecutionId
string | undefined

Identifies a particular synchronization job.

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.

ResourceInUseException
client

The resource you want to use is currently in use. Please check you have provided the correct resource and try again.

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.