- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StopDataSourceSyncJobCommand
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KendraClient, StopDataSourceSyncJobCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, StopDataSourceSyncJobCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // StopDataSourceSyncJobRequest
Id: "STRING_VALUE", // required
IndexId: "STRING_VALUE", // required
};
const command = new StopDataSourceSyncJobCommand(input);
const response = await client.send(command);
// {};
StopDataSourceSyncJobCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Id Required | string | undefined | The identifier of the data source connector for which to stop the synchronization jobs. |
IndexId Required | string | undefined | The identifier of the index used with the data source connector. |
StopDataSourceSyncJobCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
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. |
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. |