Module aws_sdk_cloudwatch::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Amazon CloudWatch can respond with.

Structs

• AlarmHistoryItem

  Represents the history of a specific alarm.

• AnomalyDetector

  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.

• 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.

• CompositeAlarm

  The details about a composite alarm.

• DashboardEntry

  Represents a specific dashboard.

• DashboardValidationMessage

  An error or warning for the operation.

• Datapoint

  Encapsulates the statistical data that CloudWatch computes from metric data.

• Dimension

  A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

• DimensionFilter

  Represents filters for a dimension.

• InsightRule

  This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.

• InsightRuleContributor

  One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

• InsightRuleContributorDatapoint

  One data point related to one contributor.

• InsightRuleMetricDatapoint

  One data point from the metric time series returned in a Contributor Insights rule report.

• LabelOptions

  This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone.

• ManagedRule

  Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.

• ManagedRuleDescription

  Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.

• ManagedRuleState

  The status of a managed Contributor Insights rule.

• MessageData

  A message returned by the GetMetricDataAPI, including a code and a description.

• Metric

  Represents a specific metric.

• MetricAlarm

  The details about a metric alarm.

• MetricCharacteristics

  This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.

• MetricDataQuery

  This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

• MetricDataResult

  A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

• MetricDatum

  Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

• MetricMathAnomalyDetector

  Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.

• MetricStat

  This structure defines the metric to be returned, along with the statistics, period, and units.

• MetricStreamEntry

  This structure contains the configuration information about one metric stream.

• MetricStreamFilter

  This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.

• MetricStreamStatisticsConfiguration

  By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions.

• MetricStreamStatisticsMetric

  This object contains the information for one metric that is to be streamed with additional statistics.

• PartialFailure

  This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

• Range

  Specifies one range of days or times to exclude from use for training an anomaly detection model.

• SingleMetricAnomalyDetector

  Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input. 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.

• StatisticSet

  Represents a set of statistics that describes a specific metric.

• Tag

  A key-value pair associated with a CloudWatch resource.

Enums

• ActionsSuppressedBy
  When writing a match expression against ActionsSuppressedBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AlarmType
  When writing a match expression against AlarmType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AnomalyDetectorStateValue
  When writing a match expression against AnomalyDetectorStateValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AnomalyDetectorType
  When writing a match expression against AnomalyDetectorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ComparisonOperator
  When writing a match expression against ComparisonOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EvaluationState
  When writing a match expression against EvaluationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• HistoryItemType
  When writing a match expression against HistoryItemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• MetricStreamOutputFormat
  When writing a match expression against MetricStreamOutputFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RecentlyActive
  When writing a match expression against RecentlyActive, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ScanBy
  When writing a match expression against ScanBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StandardUnit
  When writing a match expression against StandardUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StateValue
  When writing a match expression against StateValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Statistic
  When writing a match expression against Statistic, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• StatusCode
  When writing a match expression against StatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.