GetSnapshotsRequest

import type { GetSnapshotsRequest } from "https://aws-api.deno.dev/v0.4/services/kendra.ts?docs=full";

interface GetSnapshotsRequest {

IndexId: string;

Interval: Interval;

MaxResults?: number | null;

MetricType: MetricType;

NextToken?: string | null;

}

§Properties

IndexId: string

[src]

The identifier of the index to get search metrics data.

Interval: Interval

[src]

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.

MaxResults?: number | null

[src]

The maximum number of returned data for the metric.

MetricType: MetricType

[src]

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.

NextToken?: string | null

[src]

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.