#[non_exhaustive]pub struct AnomalyDetector {
pub anomaly_detector_id: Option<String>,
pub namespace: Option<String>,
pub metric_name: Option<String>,
pub dimensions: Option<Vec<Dimension>>,
pub stat: Option<String>,
pub configuration: Option<AnomalyDetectorConfiguration>,
pub state_value: Option<AnomalyDetectorStateValue>,
pub metric_characteristics: Option<MetricCharacteristics>,
pub single_metric_anomaly_detector: Option<SingleMetricAnomalyDetector>,
pub metric_math_anomaly_detector: Option<MetricMathAnomalyDetector>,
}Expand description
An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.
If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.anomaly_detector_id: Option<String>The unique identifier of the anomaly detector.
The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.
namespace: Option<String>Use SingleMetricAnomalyDetector.Namespace property.
The namespace of the metric associated with the anomaly detection model.
metric_name: Option<String>Use SingleMetricAnomalyDetector.MetricName property.
The name of the metric associated with the anomaly detection model.
dimensions: Option<Vec<Dimension>>Use SingleMetricAnomalyDetector.Dimensions property.
The metric dimensions associated with the anomaly detection model.
stat: Option<String>Use SingleMetricAnomalyDetector.Stat property.
The statistic associated with the anomaly detection model.
configuration: Option<AnomalyDetectorConfiguration>The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.
state_value: Option<AnomalyDetectorStateValue>The current status of the anomaly detector's training.
metric_characteristics: Option<MetricCharacteristics>This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.
single_metric_anomaly_detector: Option<SingleMetricAnomalyDetector>The CloudWatch metric and statistic for this anomaly detector.
metric_math_anomaly_detector: Option<MetricMathAnomalyDetector>The CloudWatch metric math expression for this anomaly detector.
Implementations§
Source§impl AnomalyDetector
impl AnomalyDetector
Sourcepub fn anomaly_detector_id(&self) -> Option<&str>
pub fn anomaly_detector_id(&self) -> Option<&str>
The unique identifier of the anomaly detector.
The identifier does not restrict access to a specific anomaly detector in an IAM policy. Permissions for anomaly detector operations apply to all anomaly detectors in the account.
Sourcepub fn namespace(&self) -> Option<&str>
👎Deprecated: Use SingleMetricAnomalyDetector.Namespace property.
pub fn namespace(&self) -> Option<&str>
Use SingleMetricAnomalyDetector.Namespace property.
The namespace of the metric associated with the anomaly detection model.
Sourcepub fn metric_name(&self) -> Option<&str>
👎Deprecated: Use SingleMetricAnomalyDetector.MetricName property.
pub fn metric_name(&self) -> Option<&str>
Use SingleMetricAnomalyDetector.MetricName property.
The name of the metric associated with the anomaly detection model.
Sourcepub fn dimensions(&self) -> &[Dimension]
👎Deprecated: Use SingleMetricAnomalyDetector.Dimensions property.
pub fn dimensions(&self) -> &[Dimension]
Use SingleMetricAnomalyDetector.Dimensions property.
The metric dimensions associated with the anomaly detection model.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none().
Sourcepub fn stat(&self) -> Option<&str>
👎Deprecated: Use SingleMetricAnomalyDetector.Stat property.
pub fn stat(&self) -> Option<&str>
Use SingleMetricAnomalyDetector.Stat property.
The statistic associated with the anomaly detection model.
Sourcepub fn configuration(&self) -> Option<&AnomalyDetectorConfiguration>
pub fn configuration(&self) -> Option<&AnomalyDetectorConfiguration>
The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.
Sourcepub fn state_value(&self) -> Option<&AnomalyDetectorStateValue>
pub fn state_value(&self) -> Option<&AnomalyDetectorStateValue>
The current status of the anomaly detector's training.
Sourcepub fn metric_characteristics(&self) -> Option<&MetricCharacteristics>
pub fn metric_characteristics(&self) -> Option<&MetricCharacteristics>
This object includes parameters that you can use to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the PeriodicSpikes parameter.
Sourcepub fn single_metric_anomaly_detector(
&self,
) -> Option<&SingleMetricAnomalyDetector>
pub fn single_metric_anomaly_detector( &self, ) -> Option<&SingleMetricAnomalyDetector>
The CloudWatch metric and statistic for this anomaly detector.
Sourcepub fn metric_math_anomaly_detector(&self) -> Option<&MetricMathAnomalyDetector>
pub fn metric_math_anomaly_detector(&self) -> Option<&MetricMathAnomalyDetector>
The CloudWatch metric math expression for this anomaly detector.
Source§impl AnomalyDetector
impl AnomalyDetector
Sourcepub fn builder() -> AnomalyDetectorBuilder
pub fn builder() -> AnomalyDetectorBuilder
Creates a new builder-style object to manufacture AnomalyDetector.
Trait Implementations§
Source§impl Clone for AnomalyDetector
impl Clone for AnomalyDetector
Source§fn clone(&self) -> AnomalyDetector
fn clone(&self) -> AnomalyDetector
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AnomalyDetector
impl Debug for AnomalyDetector
Source§impl PartialEq for AnomalyDetector
impl PartialEq for AnomalyDetector
impl StructuralPartialEq for AnomalyDetector
Auto Trait Implementations§
impl Freeze for AnomalyDetector
impl RefUnwindSafe for AnomalyDetector
impl Send for AnomalyDetector
impl Sync for AnomalyDetector
impl Unpin for AnomalyDetector
impl UnsafeUnpin for AnomalyDetector
impl UnwindSafe for AnomalyDetector
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);