QBusiness / Client / start_data_source_sync_job

start_data_source_sync_job

QBusiness.Client.start_data_source_sync_job(**kwargs)

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.

See also: AWS API Documentation

Request Syntax

response = client.start_data_source_sync_job(
    applicationId='string',
    dataSourceId='string',
    indexId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of Amazon Q application the data source is connected to.

• dataSourceId (string) –

  [REQUIRED]

  The identifier of the data source connector.

• indexId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'executionId': 'string'
}

Response Structure

• (dict) –

  • executionId (string) –

    The identifier for a particular synchronization job.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ConflictException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException

• QBusiness.Client.exceptions.ServiceQuotaExceededException