Class: Aws::Kendra::Types::GetSnapshotsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::GetSnapshotsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #index_id ⇒ String

  The identifier of the index to get search metrics data.

• #interval ⇒ String

  The time interval or time window to get search metrics data.

• #max_results ⇒ Integer

  The maximum number of returned data for the metric.

• #metric_type ⇒ String

  The metric you want to retrieve.

• #next_token ⇒ String

  If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response.

Instance Attribute Details

#index_id ⇒ String

The identifier of the index to get search metrics data.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5828

class GetSnapshotsRequest < Struct.new(
  :index_id,
  :interval,
  :metric_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ String

The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:

• ‘THIS_WEEK`: The current week, starting on the Sunday and ending on the day before the current date.

• ‘ONE_WEEK_AGO`: The previous week, starting on the Sunday and ending on the following Saturday.

• ‘TWO_WEEKS_AGO`: The week before the previous week, starting on the Sunday and ending on the following Saturday.

• ‘THIS_MONTH`: The current month, starting on the first day of the month and ending on the day before the current date.

• ‘ONE_MONTH_AGO`: The previous month, starting on the first day of the month and ending on the last day of the month.

• ‘TWO_MONTHS_AGO`: The month before the previous month, starting on the first day of the month and ending on last day of the month.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5828

class GetSnapshotsRequest < Struct.new(
  :index_id,
  :interval,
  :metric_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of returned data for the metric.

Returns:

• (Integer)

# File 'lib/aws-sdk-kendra/types.rb', line 5828

class GetSnapshotsRequest < Struct.new(
  :index_id,
  :interval,
  :metric_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#metric_type ⇒ String

The metric you want to retrieve. You can specify only one metric per call.

For more information about the metrics you can view, see [Gaining insights with search analytics].

[1]: docs.aws.amazon.com/kendra/latest/dg/search-analytics.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5828

class GetSnapshotsRequest < Struct.new(
  :index_id,
  :interval,
  :metric_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5828

class GetSnapshotsRequest < Struct.new(
  :index_id,
  :interval,
  :metric_type,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end