Skip to content

list_data_source_sync_jobs

Operation

list_data_source_sync_jobs

list_data_source_sync_jobs(request: ListDataSourceSyncJobsInput | ListDataSourceSyncJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataSourceSyncJobsInputDict]) -> ListDataSourceSyncJobsOutput

Get information about an Amazon Q Business data source connector synchronization.

Parameters:

Name Type Description Default
request ListDataSourceSyncJobsInput | ListDataSourceSyncJobsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDataSourceSyncJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataSourceSyncJobsOutput

An instance of ListDataSourceSyncJobsOutput.

list_data_source_sync_jobs async

list_data_source_sync_jobs(request: ListDataSourceSyncJobsInput | ListDataSourceSyncJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDataSourceSyncJobsInputDict]) -> ListDataSourceSyncJobsOutput

Get information about an Amazon Q Business data source connector synchronization.

Parameters:

Name Type Description Default
request ListDataSourceSyncJobsInput | ListDataSourceSyncJobsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDataSourceSyncJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDataSourceSyncJobsOutput

An instance of ListDataSourceSyncJobsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListDataSourceSyncJobsInputDict

Bases: TypedDict

Dictionary form of ListDataSourceSyncJobsInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

data_source_id instance-attribute
data_source_id: Required[str]

The identifier of the data source connector.

end_time instance-attribute
end_time: datetime | None

The end time of the data source connector sync.

index_id instance-attribute
index_id: Required[str]

The identifier of the index used with the Amazon Q Business data source connector.

max_results instance-attribute
max_results: int | None

The maximum number of synchronization jobs to return in the response.

next_token instance-attribute
next_token: str | 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.

start_time instance-attribute
start_time: datetime | None

The start time of the data source connector sync.

status_filter instance-attribute
status_filter: str | None

Only returns synchronization jobs with the Status field equal to the specified status.

ListDataSourceSyncJobsInput dataclass

Bases: _SerdeShape

Dataclass for ListDataSourceSyncJobsInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

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

data_source_id class-attribute instance-attribute
data_source_id: str | None = ...

The identifier of the data source connector.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The end time of the data source connector sync.

index_id class-attribute instance-attribute
index_id: str | None = ...

The identifier of the index used with the Amazon Q Business data source connector.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of synchronization jobs to return in the response.

next_token class-attribute instance-attribute
next_token: str | 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.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The start time of the data source connector sync.

status_filter class-attribute instance-attribute
status_filter: str | None = ...

Only returns synchronization jobs with the Status field equal to the specified status.

Output

ListDataSourceSyncJobsOutput dataclass

Bases: _SerdeShape

Dataclass for ListDataSourceSyncJobsOutput structure.

Attributes

history class-attribute instance-attribute
history: list[DataSourceSyncJob] | None = ...

A history of synchronization jobs for the data source connector.

next_token class-attribute instance-attribute
next_token: str | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.