list_data_source_sync_jobs ¶

def list_data_source_sync_jobs(
    self,
    data_source_id: "capo_qbusiness.types.data_source_id.DataSourceId",
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    index_id: "capo_qbusiness.types.index_id.IndexId",
    *,
    config_overrides: Optional[QBusinessClientConfig] = None,
    next_token: Optional["capo_qbusiness.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_qbusiness.types.max_results_integer_for_list_data_sources_sync_jobs.MaxResultsIntegerForListDataSourcesSyncJobs"
    ] = None,
    start_time: Optional["capo_qbusiness.types.timestamp.Timestamp"] = None,
    end_time: Optional["capo_qbusiness.types.timestamp.Timestamp"] = None,
    status_filter: Optional[
        "capo_qbusiness.types.data_source_sync_job_status.DataSourceSyncJobStatus"
    ] = None,
) -> "capo_qbusiness.types.list_data_source_sync_jobs_response.ListDataSourceSyncJobsResponse":
    """<p>Get information about an Amazon Q Business data source connector synchronization.</p>

    Args:
        data_source_id: <p> The identifier of the data source connector.</p>
        application_id: <p>The identifier of the Amazon Q Business application connected to the data source.</p>
        index_id: <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
        next_token: <p>If the <code>maxResults</code> response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.</p>
        max_results: <p>The maximum number of synchronization jobs to return in the response.</p>
        start_time: <p> The start time of the data source connector sync. </p>
        end_time: <p> The end time of the data source connector sync.</p>
        status_filter: <p>Only returns synchronization jobs with the <code>Status</code> field equal to the specified status.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.conflict_exception.ConflictException: <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_qbusiness.types.list_data_source_sync_jobs_request.ListDataSourceSyncJobsRequest]",
    ) -> OperationResponse[
        "capo_qbusiness.types.list_data_source_sync_jobs_response.ListDataSourceSyncJobsResponse"
    ]:
        import capo_qbusiness._operations.expert_q.list_data_source_sync_jobs

        output, http_response = (
            capo_qbusiness._operations.expert_q.list_data_source_sync_jobs.list_data_source_sync_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDataSourceSyncJobs")
    )
    input_: capo_qbusiness.types.list_data_source_sync_jobs_request.ListDataSourceSyncJobsRequest = {
        "data_source_id": data_source_id,
        "application_id": application_id,
        "index_id": index_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if status_filter is not None:
        input_["status_filter"] = status_filter

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output