list_data_source_sync_jobs¶
Operation¶
async
¶
list_data_source_sync_jobs(input: ListDataSourceSyncJobsInput, plugins: list[Plugin] | None = None) -> ListDataSourceSyncJobsOutput
Get information about an Amazon Q Business data source connector synchronization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListDataSourceSyncJobsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListDataSourceSyncJobsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListDataSourceSyncJobsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application connected to the data source.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.
class-attribute
instance-attribute
¶
end_time: datetime | None = None
The end time of the data source connector sync.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index used with the Amazon Q Business data source connector.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of synchronization jobs to return in the response.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults 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.
class-attribute
instance-attribute
¶
start_time: datetime | None = None
The start time of the data source connector sync.
class-attribute
instance-attribute
¶
status_filter: DataSourceSyncJobStatus | None = None
Only returns synchronization jobs with the Status field equal to the
specified status.
Output¶
dataclass
¶
Dataclass for ListDataSourceSyncJobsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
history: list[DataSourceSyncJob] | None = None
A history of synchronization jobs for the data source connector.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.