1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetSnapshots`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`index_id(impl Into<String>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index to get search metrics data.</p><br>
    ///   - [`interval(Interval)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::interval) / [`set_interval(Option<Interval>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::set_interval):<br>required: **true**<br><p>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:</p> <ul>  <li>   <p><code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the day before the current date.</p></li>  <li>   <p><code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on the following Saturday.</p></li>  <li>   <p><code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday and ending on the following Saturday.</p></li>  <li>   <p><code>THIS_MONTH</code>: The current month, starting on the first day of the month and ending on the day before the current date.</p></li>  <li>   <p><code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the month and ending on the last day of the month.</p></li>  <li>   <p><code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the first day of the month and ending on last day of the month.</p></li> </ul><br>
    ///   - [`metric_type(MetricType)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::metric_type) / [`set_metric_type(Option<MetricType>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::set_metric_type):<br>required: **true**<br><p>The metric you want to retrieve. You can specify only one metric per call.</p> <p>For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining insights with search analytics</a>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of returned data for the metric.</p><br>
    /// - On success, responds with [`GetSnapshotsOutput`](crate::operation::get_snapshots::GetSnapshotsOutput) with field(s):
    ///   - [`snap_shot_time_filter(Option<TimeRange>)`](crate::operation::get_snapshots::GetSnapshotsOutput::snap_shot_time_filter): <p>The Unix timestamp for the beginning and end of the time window for the search metrics data.</p>
    ///   - [`snapshots_data_header(Option<Vec::<String>>)`](crate::operation::get_snapshots::GetSnapshotsOutput::snapshots_data_header): <p>The column headers for the search metrics data.</p>
    ///   - [`snapshots_data(Option<Vec::<Vec::<String>>>)`](crate::operation::get_snapshots::GetSnapshotsOutput::snapshots_data): <p>The search metrics data. The data returned depends on the metric type you requested.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_snapshots::GetSnapshotsOutput::next_token): <p>If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.</p>
    /// - On failure, responds with [`SdkError<GetSnapshotsError>`](crate::operation::get_snapshots::GetSnapshotsError)
    pub fn get_snapshots(&self) -> crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder {
        crate::operation::get_snapshots::builders::GetSnapshotsFluentBuilder::new(self.handle.clone())
    }
}