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.
Parameters:
-
id
(DataSourceId)
–
The identifier of the data source connector to synchronize.
-
index_id
(IndexId)
–
The identifier of the index used with the data source connector.
Raises:
-
AccessDeniedException
–
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
–
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
-
InternalServerException
–
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
–
The resource you want to use is currently in use. Please check you have provided the correct resource and try again.
-
ResourceNotFoundException
–
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
-
ThrottlingException
–
The request was denied due to request throttling. Please reduce the number of requests and try again.
-
ValidationException
–
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_kendra/_services/async_kendra.py
| async def start_data_source_sync_job(
self,
id: "capo_kendra.types.data_source_id.DataSourceId",
index_id: "capo_kendra.types.index_id.IndexId",
*,
config_overrides: Optional[AsynckendraClientConfig] = None,
) -> "capo_kendra.types.start_data_source_sync_job_response.StartDataSourceSyncJobResponse":
"""<p>Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a <code>ResourceInUseException</code> exception.</p> <p>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.</p>
Args:
id: <p>The identifier of the data source connector to synchronize.</p>
index_id: <p>The identifier of the index used with the data source connector.</p>
Raises:
capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
capo_kendra.errors.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistences with your resources and try again.</p>
capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
capo_kendra.errors.resource_in_use_exception.ResourceInUseException: <p>The resource you want to use is currently in use. Please check you have provided the correct resource and try again.</p>
capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_kendra.types.start_data_source_sync_job_request.StartDataSourceSyncJobRequest]",
) -> AsyncOperationResponse[
"capo_kendra.types.start_data_source_sync_job_response.StartDataSourceSyncJobResponse"
]:
import capo_kendra._operations.aws_kendra_frontend_service.start_data_source_sync_job
(
output,
http_response,
) = await capo_kendra._operations.aws_kendra_frontend_service.start_data_source_sync_job.async_start_data_source_sync_job(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StartDataSourceSyncJob")
)
input_: capo_kendra.types.start_data_source_sync_job_request.StartDataSourceSyncJobRequest = {
"id": id,
"index_id": index_id,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|