list_monitoring_alert_history ¶

def list_monitoring_alert_history(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    monitoring_schedule_name: Optional[
        "capo_sagemaker.types.monitoring_schedule_name.MonitoringScheduleName"
    ] = None,
    monitoring_alert_name: Optional[
        "capo_sagemaker.types.monitoring_alert_name.MonitoringAlertName"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.monitoring_alert_history_sort_key.MonitoringAlertHistorySortKey"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    status_equals: Optional[
        "capo_sagemaker.types.monitoring_alert_status.MonitoringAlertStatus"
    ] = None,
) -> "capo_sagemaker.types.list_monitoring_alert_history_response.ListMonitoringAlertHistoryResponse":
    """<p>Gets a list of past alerts in a model monitoring schedule.</p>

    Args:
        monitoring_schedule_name: <p>The name of a monitoring schedule.</p>
        monitoring_alert_name: <p>The name of a monitoring alert.</p>
        sort_by: <p>The field used to sort results. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order, whether <code>Ascending</code> or <code>Descending</code>, of the alert history. The default is <code>Descending</code>.</p>
        next_token: <p>If the result of the previous <code>ListMonitoringAlertHistory</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of alerts in the history, use the token in the next request.</p>
        max_results: <p>The maximum number of results to display. The default is 100.</p>
        creation_time_before: <p>A filter that returns only alerts created on or before the specified time.</p>
        creation_time_after: <p>A filter that returns only alerts created on or after the specified time.</p>
        status_equals: <p>A filter that retrieves only alerts with a specific status.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_monitoring_alert_history_request.ListMonitoringAlertHistoryRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_monitoring_alert_history_response.ListMonitoringAlertHistoryResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_monitoring_alert_history

        output, http_response = (
            capo_sagemaker._operations.sage_maker.list_monitoring_alert_history.list_monitoring_alert_history(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMonitoringAlertHistory")
    )
    input_: capo_sagemaker.types.list_monitoring_alert_history_request.ListMonitoringAlertHistoryRequest = {}
    if monitoring_schedule_name is not None:
        input_["monitoring_schedule_name"] = monitoring_schedule_name
    if monitoring_alert_name is not None:
        input_["monitoring_alert_name"] = monitoring_alert_name
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if status_equals is not None:
        input_["status_equals"] = status_equals

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