Skip to content

describe_monitoring_schedule

describe_monitoring_schedule(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    monitoring_schedule_name: Optional[MonitoringScheduleName] = None,
) -> DescribeMonitoringScheduleResponse

Describes the schedule for a monitoring job.

Parameters:

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_monitoring_schedule(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    monitoring_schedule_name: Optional[
        "capo_sagemaker.types.monitoring_schedule_name.MonitoringScheduleName"
    ] = None,
) -> "capo_sagemaker.types.describe_monitoring_schedule_response.DescribeMonitoringScheduleResponse":
    """<p>Describes the schedule for a monitoring job.</p>

    Args:
        monitoring_schedule_name: <p>Name of a previously created monitoring schedule.</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.describe_monitoring_schedule_request.DescribeMonitoringScheduleRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_monitoring_schedule_response.DescribeMonitoringScheduleResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_monitoring_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMonitoringSchedule")
    )
    input_: capo_sagemaker.types.describe_monitoring_schedule_request.DescribeMonitoringScheduleRequest = {}
    if monitoring_schedule_name is not None:
        input_["monitoring_schedule_name"] = monitoring_schedule_name

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