You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::ListDataSourceSyncJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListDataSourceSyncJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "DataSourceId", # required
  index_id: "IndexId", # required
  next_token: "NextToken",
  max_results: 1,
  start_time_filter: {
    start_time: Time.now,
    end_time: Time.now,
  },
  status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#id ⇒ String

The identifier of the data source.

Returns:

  • (String) —

    The identifier of the data source.

#index_id ⇒ String

The identifier of the index that contains the data source.

Returns:

  • (String) —

    The identifier of the index that contains the data source.

#max_results ⇒ Integer

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

  • (Integer) —

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

#next_token ⇒ String

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

Returns:

  • (String) —

    If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

#start_time_filter ⇒ Types::TimeRange

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

Returns:

  • (Types::TimeRange) —

    When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

#status_filter ⇒ String

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Possible values:

  • FAILED
  • SUCCEEDED
  • SYNCING
  • INCOMPLETE
  • STOPPING
  • ABORTED
  • SYNCING_INDEXING

Returns:

  • (String) —

    When specified, only returns synchronization jobs with the Status field equal to the specified status.