aws_sdk_sagemaker/client/
describe_monitoring_schedule.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeMonitoringSchedule`](crate::operation::describe_monitoring_schedule::builders::DescribeMonitoringScheduleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`monitoring_schedule_name(impl Into<String>)`](crate::operation::describe_monitoring_schedule::builders::DescribeMonitoringScheduleFluentBuilder::monitoring_schedule_name) / [`set_monitoring_schedule_name(Option<String>)`](crate::operation::describe_monitoring_schedule::builders::DescribeMonitoringScheduleFluentBuilder::set_monitoring_schedule_name):<br>required: **true**<br><p>Name of a previously created monitoring schedule.</p><br>
7    /// - On success, responds with [`DescribeMonitoringScheduleOutput`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput) with field(s):
8    ///   - [`monitoring_schedule_arn(Option<String>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::monitoring_schedule_arn): <p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>
9    ///   - [`monitoring_schedule_name(Option<String>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::monitoring_schedule_name): <p>Name of the monitoring schedule.</p>
10    ///   - [`monitoring_schedule_status(Option<ScheduleStatus>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::monitoring_schedule_status): <p>The status of an monitoring job.</p>
11    ///   - [`monitoring_type(Option<MonitoringType>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::monitoring_type): <p>The type of the monitoring job that this schedule runs. This is one of the following values.</p> <ul>  <li>   <p><code>DATA_QUALITY</code> - The schedule is for a data quality monitoring job.</p></li>  <li>   <p><code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring job.</p></li>  <li>   <p><code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p></li>  <li>   <p><code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability monitoring job.</p></li> </ul>
12    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::failure_reason): <p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.</p>
13    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::creation_time): <p>The time at which the monitoring job was created.</p>
14    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::last_modified_time): <p>The time at which the monitoring job was last modified.</p>
15    ///   - [`monitoring_schedule_config(Option<MonitoringScheduleConfig>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::monitoring_schedule_config): <p>The configuration object that specifies the monitoring schedule and defines the monitoring job.</p>
16    ///   - [`endpoint_name(Option<String>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::endpoint_name): <p>The name of the endpoint for the monitoring job.</p>
17    ///   - [`last_monitoring_execution_summary(Option<MonitoringExecutionSummary>)`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleOutput::last_monitoring_execution_summary): <p>Describes metadata on the last execution to run, if there was one.</p>
18    /// - On failure, responds with [`SdkError<DescribeMonitoringScheduleError>`](crate::operation::describe_monitoring_schedule::DescribeMonitoringScheduleError)
19    pub fn describe_monitoring_schedule(&self) -> crate::operation::describe_monitoring_schedule::builders::DescribeMonitoringScheduleFluentBuilder {
20        crate::operation::describe_monitoring_schedule::builders::DescribeMonitoringScheduleFluentBuilder::new(self.handle.clone())
21    }
22}