get_snapshots ¶

def get_snapshots(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    interval: "capo_kendra.types.interval.Interval",
    metric_type: "capo_kendra.types.metric_type.MetricType",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    next_token: Optional["capo_kendra.types.next_token.NextToken"] = None,
    max_results: Optional["capo_kendra.types.integer.Integer"] = None,
) -> "capo_kendra.types.get_snapshots_response.GetSnapshotsResponse":
    """<p>Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.</p>

    Args:
        index_id: <p>The identifier of the index to get search metrics data.</p>
        interval: <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>
        metric_type: <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>
        next_token: <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>
        max_results: <p>The maximum number of returned data for the metric.</p>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.invalid_request_exception.InvalidRequestException: <p>The input to the request is not valid. Please provide the correct input and try again.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.get_snapshots_request.GetSnapshotsRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.get_snapshots_response.GetSnapshotsResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.get_snapshots

        output, http_response = (
            capo_kendra._operations.aws_kendra_frontend_service.get_snapshots.get_snapshots(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSnapshots")
    )
    input_: capo_kendra.types.get_snapshots_request.GetSnapshotsRequest = {
        "index_id": index_id,
        "interval": interval,
        "metric_type": metric_type,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output