Skip to content

GetSnapshotsResponse

Source code in docs_src/capo_kendra/types/get_snapshots_response.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class GetSnapshotsResponse(TypedDict, closed=True):
    snap_shot_time_filter: NotRequired["capo_kendra.types.time_range.TimeRange"]
    """<p>The Unix timestamp for the beginning and end of the time window for the search metrics data.</p>"""
    snapshots_data_header: NotRequired[
        "capo_kendra.types.snapshots_data_header_fields.SnapshotsDataHeaderFields"
    ]
    """<p>The column headers for the search metrics data.</p>"""
    snapshots_data: NotRequired[
        "capo_kendra.types.snapshots_data_records.SnapshotsDataRecords"
    ]
    """<p>The search metrics data. The data returned depends on the metric type you requested.</p>"""
    next_token: NotRequired["capo_kendra.types.next_token.NextToken"]
    """<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>"""

next_token instance-attribute 

next_token: NotRequired[NextToken]

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.

snap_shot_time_filter instance-attribute 

snap_shot_time_filter: NotRequired[TimeRange]

The Unix timestamp for the beginning and end of the time window for the search metrics data.

snapshots_data instance-attribute 

snapshots_data: NotRequired[SnapshotsDataRecords]

The search metrics data. The data returned depends on the metric type you requested.

snapshots_data_header instance-attribute 

snapshots_data_header: NotRequired[SnapshotsDataHeaderFields]

The column headers for the search metrics data.