# Amazon CloudWatch API Reference

> Amazon CloudWatch enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. This guide provides detailed information about CloudWatch actions, data types, parameters, and errors. For more information about CloudWatch features, see Amazon CloudWatch and the Amazon CloudWatch User Guide.

- [Welcome](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Operations.md)

- [AssociateDatasetKmsKey](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AssociateDatasetKmsKey.md): Associates an AWS Key Management Service (AWS KMS) customer managed key with the specified dataset.
- [DeleteAlarmMuteRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteAlarmMuteRule.md): Deletes a specific alarm mute rule.
- [DeleteAlarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteAlarms.md): Deletes the specified alarms.
- [DeleteAnomalyDetector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteAnomalyDetector.md): Deletes the specified anomaly detection model from your account.
- [DeleteDashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteDashboards.md): Deletes all dashboards that you specify.
- [DeleteInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteInsightRules.md): Permanently deletes the specified Contributor Insights rules.
- [DeleteMetricStream](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DeleteMetricStream.md): Permanently deletes the metric stream that you specify.
- [DescribeAlarmContributors](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmContributors.md): Returns the information of the current alarm contributors that are in ALARM state.
- [DescribeAlarmHistory](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.md): Retrieves the history for the specified alarm.
- [DescribeAlarms](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.md): Retrieves the specified alarms.
- [DescribeAlarmsForMetric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmsForMetric.md): Retrieves the alarms for the specified metric.
- [DescribeAnomalyDetectors](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAnomalyDetectors.md): Lists the anomaly detection models that you have created in your account.
- [DescribeInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.md): Returns a list of all the Contributor Insights rules in your account.
- [DisableAlarmActions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DisableAlarmActions.md): Disables the actions for the specified alarms.
- [DisableInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DisableInsightRules.md): Disables the specified Contributor Insights rules.
- [DisassociateDatasetKmsKey](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DisassociateDatasetKmsKey.md): Removes the customer managed AWS Key Management Service (AWS KMS) key association from the specified dataset.
- [EnableAlarmActions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_EnableAlarmActions.md): Enables the actions for the specified alarms.
- [EnableInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_EnableInsightRules.md): Enables the specified Contributor Insights rules.
- [GetAlarmMuteRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetAlarmMuteRule.md): Retrieves details for a specific alarm mute rule.
- [GetDashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetDashboard.md): Displays the details of the dashboard that you specify.
- [GetDataset](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetDataset.md): Returns information about the specified dataset.
- [GetInsightRuleReport](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.md): This operation returns the time series data collected by a Contributor Insights rule.
- [GetMetricData](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.md): You can use the GetMetricData API to retrieve CloudWatch metric values.
- [GetMetricStatistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.md): Gets statistics for the specified metric.
- [GetMetricStream](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStream.md): Returns information about the metric stream that you specify.
- [GetMetricWidgetImage](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.md): You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image.
- [GetOTelEnrichment](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetOTelEnrichment.md): Returns the current status of vended metric enrichment for the account, including whether CloudWatch vended metrics are enriched with resource ARN and resource tag labels and queryable using PromQL.
- [ListAlarmMuteRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListAlarmMuteRules.md): Lists alarm mute rules in your AWS account and region.
- [ListDashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListDashboards.md): Returns a list of the dashboards for your account.
- [ListManagedInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListManagedInsightRules.md): Returns a list that contains the number of managed Contributor Insights rules in your account.
- [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.md): List the specified metrics.
- [ListMetricStreams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetricStreams.md): Returns a list of metric streams in this account.
- [ListTagsForResource](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListTagsForResource.md): Displays the tags associated with a CloudWatch resource.
- [PutAlarmMuteRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutAlarmMuteRule.md): Creates or updates an alarm mute rule.
- [PutAnomalyDetector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutAnomalyDetector.md): Creates an anomaly detection model for a CloudWatch metric.
- [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.md): Creates or updates a composite alarm.
- [PutDashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutDashboard.md): Creates a dashboard if it does not already exist, or updates an existing dashboard.
- [PutInsightRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutInsightRule.md): Creates a Contributor Insights rule.
- [PutLogAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutLogAlarm.md): Creates or updates a log alarm.
- [PutManagedInsightRules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutManagedInsightRules.md): Creates a managed Contributor Insights rule for a specified AWS resource.
- [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.md): Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, Metrics Insights query, or PromQL query.
- [PutMetricData](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricData.md): Publishes metric data to Amazon CloudWatch.
- [PutMetricStream](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricStream.md): Creates or updates a metric stream.
- [SetAlarmState](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_SetAlarmState.md): Temporarily sets the state of an alarm for testing purposes.
- [StartMetricStreams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StartMetricStreams.md): Starts the streaming of metrics for one or more of your metric streams.
- [StartOTelEnrichment](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StartOTelEnrichment.md): Enables enrichment and PromQL access for CloudWatch vended metrics for supported AWS resources in the account.
- [StopMetricStreams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StopMetricStreams.md): Stops the streaming of metrics for one or more of your metric streams.
- [StopOTelEnrichment](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StopOTelEnrichment.md): Disables enrichment and PromQL access for CloudWatch vended metrics for supported AWS resources in the account.
- [TagResource](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.md): Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
- [UntagResource](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.md): Removes one or more tags from the specified resource.


## [Data Types](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Types.md)

- [AlarmContributor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AlarmContributor.md): Represents an individual contributor to a multi-timeseries alarm, containing information about a specific time series and its contribution to the alarm's state.
- [AlarmHistoryItem](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AlarmHistoryItem.md): Represents the history of a specific alarm.
- [AlarmMuteRuleSummary](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AlarmMuteRuleSummary.md): Summary information about an alarm mute rule, including its name, status, and configuration details.
- [AlarmPromQLCriteria](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AlarmPromQLCriteria.md): Contains the configuration that determines how a PromQL alarm evaluates its contributors, including the query to run and the durations that define when contributors transition between states.
- [AnomalyDetector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AnomalyDetector.md): An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression.
- [AnomalyDetectorConfiguration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AnomalyDetectorConfiguration.md): 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_CompositeAlarm.md): The details about a composite alarm.
- [DashboardEntry](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DashboardEntry.md): Represents a specific dashboard.
- [DashboardValidationMessage](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DashboardValidationMessage.md): An error or warning for the operation.
- [Datapoint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Datapoint.md): Encapsulates the statistical data that CloudWatch computes from metric data.
- [Dimension](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Dimension.md): A dimension is a name/value pair that is part of the identity of a metric.
- [DimensionFilter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DimensionFilter.md): Represents filters for a dimension.
- [Entity](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Entity.md): An entity associated with metrics, to allow for finding related telemetry.
- [EntityMetricData](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_EntityMetricData.md): A set of metrics that are associated with an entity, such as a specific service or resource.
- [EvaluationCriteria](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_EvaluationCriteria.md): The evaluation criteria for an alarm.
- [EvaluationWindow](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_EvaluationWindow.md): The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs.
- [InsightRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRule.md): This structure contains the definition for a Contributor Insights rule.
- [InsightRuleContributor](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.md): One of the unique contributors found by a Contributor Insights rule.
- [InsightRuleContributorDatapoint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributorDatapoint.md): One data point related to one contributor.
- [InsightRuleMetricDatapoint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleMetricDatapoint.md): One data point from the metric time series returned in a Contributor Insights rule report.
- [LabelOptions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_LabelOptions.md): 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.
- [LogAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_LogAlarm.md): The details about a log alarm.
- [ManagedRule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ManagedRule.md): Contains the information that's required to enable a managed Contributor Insights rule for an AWS resource.
- [ManagedRuleDescription](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ManagedRuleDescription.md): Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.
- [ManagedRuleState](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ManagedRuleState.md): The status of a managed Contributor Insights rule.
- [MessageData](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MessageData.md): A message returned by the GetMetricDataAPI, including a code and a description.
- [Metric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.md): Represents a specific metric.
- [MetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricAlarm.md): The details about a metric alarm.
- [MetricCharacteristics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricCharacteristics.md): This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
- [MetricDataQuery](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.md): This structure is used in both GetMetricData and PutMetricAlarm.
- [MetricDataResult](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataResult.md): A GetMetricData call returns an array of MetricDataResult structures.
- [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.md): Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
- [MetricMathAnomalyDetector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricMathAnomalyDetector.md): Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input.
- [MetricStat](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricStat.md): This structure defines the metric to be returned, along with the statistics, period, and units.
- [MetricStreamEntry](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricStreamEntry.md): This structure contains the configuration information about one metric stream.
- [MetricStreamFilter](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricStreamFilter.md): 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricStreamStatisticsConfiguration.md): By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
- [MetricStreamStatisticsMetric](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricStreamStatisticsMetric.md): This object contains the information for one metric that is to be streamed with additional statistics.
- [MuteTargets](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MuteTargets.md): Specifies which alarms an alarm mute rule applies to.
- [PartialFailure](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PartialFailure.md): This array is empty if the API operation was successful for all the rules specified in the request.
- [Range](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Range.md): Specifies one range of days or times to exclude from use for training an anomaly detection model.
- [Rule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Rule.md): Defines the schedule configuration for an alarm mute rule.
- [Schedule](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Schedule.md): Specifies when and how long an alarm mute rule is active.
- [ScheduleConfiguration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ScheduleConfiguration.md): Contains the schedule expression and time-range offsets that define when a scheduled query runs and what time range each execution covers.
- [ScheduledQueryConfiguration](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ScheduledQueryConfiguration.md): The configuration of the CloudWatch Logs scheduled query that backs a log alarm.
- [SingleMetricAnomalyDetector](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_SingleMetricAnomalyDetector.md): Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.
- [SlidingWindow](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_SlidingWindow.md): An evaluation window that advances each time the alarm is evaluated, forming a rolling time window.
- [StatisticSet](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_StatisticSet.md): Represents a set of statistics that describes a specific metric.
- [Tag](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Tag.md): A key-value pair associated with a CloudWatch resource.
- [WallClockWindow](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_WallClockWindow.md): An evaluation window that aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week, optionally in a specific time zone.