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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ListDataSourceSyncJobsRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The identifier of the data source.

Returns:

  • (String)

3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index that contains the data source.

Returns:

  • (String)

3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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)

3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)

3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_filterTypes::TimeRange

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

Returns:


3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end

#status_filterString

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

Returns:

  • (String)

3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
# File 'lib/aws-sdk-kendra/types.rb', line 3911

class ListDataSourceSyncJobsRequest < Struct.new(
  :id,
  :index_id,
  :next_token,
  :max_results,
  :start_time_filter,
  :status_filter)
  SENSITIVE = []
  include Aws::Structure
end