stop_data_source_sync_job `async` ¶

stop_data_source_sync_job(
    id: DataSourceId,
    index_id: IndexId,
    *,
    config_overrides: Optional[AsynckendraClientConfig] = None,
) -> None

Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

Parameters:

id (DataSourceId) –

The identifier of the data source connector for which to stop the synchronization jobs.
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.
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.
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 stop_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,
) -> None:
    """<p>Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.</p>

    Args:
        id: <p>The identifier of the data source connector for which to stop the synchronization jobs.</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.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_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.stop_data_source_sync_job_request.StopDataSourceSyncJobRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_kendra._operations.aws_kendra_frontend_service.stop_data_source_sync_job

        (
            output,
            http_response,
        ) = await capo_kendra._operations.aws_kendra_frontend_service.stop_data_source_sync_job.async_stop_data_source_sync_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopDataSourceSyncJob")
    )
    input_: capo_kendra.types.stop_data_source_sync_job_request.StopDataSourceSyncJobRequest = {
        "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

stop_data_source_sync_job async ¶

stop_data_source_sync_job `async` ¶