Amazon CloudWatch
Amazon CloudWatch enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. This guide…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
For information about the metrics that other Amazon Web Services products send to
CloudWatch, see the Amazon CloudWatch
Metrics and Dimensions Reference in the Amazon CloudWatch User
Guide .
Use the following links to get started using the CloudWatch Query API:
: An alphabetical list of all CloudWatch
actions.
: An alphabetical list of all CloudWatch data
types.
CommonParameters : Parameters that all Query actions can use.
CommonErrors : Client and server errors that all actions can
return.
Regions and Endpoints : Supported regions and endpoints for all Amazon Web
Services products.
Alternatively, you can use one of the Amazon Web Services SDKs to access CloudWatch using an API tailored
to your programming language or platform.
Developers in the Amazon Web Services developer community also provide their own
libraries, which you can find at the following Amazon Web Services developer
centers:
Java Developer Center
JavaScript Developer
Center
Amazon Web Services Mobile
Services
PHP Developer Center
Python Developer Center
Ruby Developer Center
Windows and .NET Developer
Center
Endpoints 59
- POSTAssociate dataset kms key
/#X-Amz-Target=GraniteServiceVersion20100801.AssociateDatasetKmsKeyAssociates an Amazon Web Services Key Management Service (Amazon Web Services KMS) customer managed key with the specified dataset. After this operation… - POSTCreate resource metrics configuration
/#X-Amz-Target=GraniteServiceVersion20100801.CreateResourceMetricsConfigurationCreates a resource metrics configuration for an Amazon Web Services resource. After you create a configuration, Amazon CloudWatch collects detailed metrics… - POSTDelete alarm mute rule
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteAlarmMuteRuleDeletes a specific alarm mute rule. When you delete a mute rule, any alarms that are currently being muted by that rule are immediately unmuted. If those… - POSTDelete alarms
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteAlarmsDeletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example,… - POSTDelete anomaly detector
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteAnomalyDetectorDeletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly… - POSTDelete dashboards
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteDashboardsDeletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, the operation attempts to… - POSTDelete insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteInsightRulesPermanently deletes the specified Contributor Insights rules. If you create a rule, delete it, and then re-create it with the same name, historical data from… - POSTDelete metric data query definition
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteMetricDataQueryDefinitionDeletes a metric data query definition. This operation is idempotent. If the definition doesn't exist, the operation succeeds without returning an error.… - POSTDelete metric stream
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteMetricStreamPermanently deletes the metric stream that you specify. - POSTDelete resource metrics configuration
/#X-Amz-Target=GraniteServiceVersion20100801.DeleteResourceMetricsConfigurationDeletes the resource metrics configuration for an Amazon Web Services resource. After you delete the configuration, Amazon CloudWatch stops collecting… - POSTDescribe alarm contributors
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeAlarmContributorsReturns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that… - POSTDescribe alarm history
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeAlarmHistoryRetrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for… - POSTDescribe alarms
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeAlarmsRetrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action. To use this… - POSTDescribe alarms for metric
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeAlarmsForMetricRetrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. This operation retrieves only standard alarms that… - POSTDescribe anomaly detectors
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeAnomalyDetectorsLists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account… - POSTDescribe insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.DescribeInsightRulesReturns a list of all the Contributor Insights rules in your account. For more information about Contributor Insights, see Using Contributor Insights to… - POSTDisable alarm actions
/#X-Amz-Target=GraniteServiceVersion20100801.DisableAlarmActionsDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes. - POSTDisable insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.DisableInsightRulesDisables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs. - POSTDisassociate dataset kms key
/#X-Amz-Target=GraniteServiceVersion20100801.DisassociateDatasetKmsKeyRemoves the customer managed Amazon Web Services Key Management Service (Amazon Web Services KMS) key association from the specified dataset. After this… - POSTEnable alarm actions
/#X-Amz-Target=GraniteServiceVersion20100801.EnableAlarmActionsEnables the actions for the specified alarms. - POSTEnable insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.EnableInsightRulesEnables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data. - POSTGet alarm mute rule
/#X-Amz-Target=GraniteServiceVersion20100801.GetAlarmMuteRuleRetrieves details for a specific alarm mute rule. This operation returns complete information about the mute rule, including its configuration, status,… - POSTGet dashboard
/#X-Amz-Target=GraniteServiceVersion20100801.GetDashboardDisplays the details of the dashboard that you specify. To copy an existing dashboard, use GetDashboard , and then use the data returned within DashboardBody… - POSTGet dataset
/#X-Amz-Target=GraniteServiceVersion20100801.GetDatasetReturns information about the specified dataset. This includes its identifier, Amazon Resource Name (ARN), and any customer managed Amazon Web Services Key… - POSTGet insight rule report
/#X-Amz-Target=GraniteServiceVersion20100801.GetInsightRuleReportThis operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log… - POSTGet metric data
/#X-Amz-Target=GraniteServiceVersion20100801.GetMetricDataYou can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more… - POSTGet metric data query definition
/#X-Amz-Target=GraniteServiceVersion20100801.GetMetricDataQueryDefinitionReturns a metric data query definition, including its expression. Permissions To get a definition, you need the cloudwatch:GetMetricDataQueryDefinition… - POSTGet metric statistics
/#X-Amz-Target=GraniteServiceVersion20100801.GetMetricStatisticsGets statistics for the specified metric. The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points,… - POSTGet metric stream
/#X-Amz-Target=GraniteServiceVersion20100801.GetMetricStreamReturns information about the metric stream that you specify. - POSTGet metric widget image
/#X-Amz-Target=GraniteServiceVersion20100801.GetMetricWidgetImageYou can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this… - POSTGet o tel enrichment
/#X-Amz-Target=GraniteServiceVersion20100801.GetOTelEnrichmentReturns the current status of vended metric enrichment for the account, including whether CloudWatch vended metrics are enriched with resource ARN and… - POSTGet resource metrics configuration
/#X-Amz-Target=GraniteServiceVersion20100801.GetResourceMetricsConfigurationRetrieves the current resource metrics configuration for an Amazon Web Services resource. The response includes the resource ARN, any metric selections, and… - POSTList alarm mute rules
/#X-Amz-Target=GraniteServiceVersion20100801.ListAlarmMuteRulesLists alarm mute rules in your Amazon Web Services account and region. You can filter the results by alarm name to find all mute rules targeting a specific… - POSTList dashboards
/#X-Amz-Target=GraniteServiceVersion20100801.ListDashboardsReturns a list of the dashboards for your account. If you include DashboardNamePrefix , only those dashboards with names starting with the prefix are listed.… - POSTList managed insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.ListManagedInsightRulesReturns a list that contains the number of managed Contributor Insights rules in your account. - POSTList metric data query definitions
/#X-Amz-Target=GraniteServiceVersion20100801.ListMetricDataQueryDefinitionsLists the metric data query definitions in your account and Region. The results are summaries that don't include the expression. To get the full definition,… - POSTList metric streams
/#X-Amz-Target=GraniteServiceVersion20100801.ListMetricStreamsReturns a list of metric streams in this account. - POSTList metrics
/#X-Amz-Target=GraniteServiceVersion20100801.ListMetricsList the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data. Up to 500 results are returned… - POSTList tags for resource
/#X-Amz-Target=GraniteServiceVersion20100801.ListTagsForResourceDisplays the tags associated with a CloudWatch resource. Currently, alarms, dashboards, metric streams and Contributor Insights rules support tagging. - POSTPut alarm mute rule
/#X-Amz-Target=GraniteServiceVersion20100801.PutAlarmMuteRuleCreates or updates an alarm mute rule. Alarm mute rules automatically mute alarm actions during predefined time windows. When a mute rule is active, targeted… - POSTPut anomaly detector
/#X-Amz-Target=GraniteServiceVersion20100801.PutAnomalyDetectorCreates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed. If… - POSTPut composite alarm
/#X-Amz-Target=GraniteServiceVersion20100801.PutCompositeAlarmCreates or updates a composite alarm . When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states… - POSTPut dashboard
/#X-Amz-Target=GraniteServiceVersion20100801.PutDashboardCreates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you… - POSTPut insight rule
/#X-Amz-Target=GraniteServiceVersion20100801.PutInsightRuleCreates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in… - POSTPut log alarm
/#X-Amz-Target=GraniteServiceVersion20100801.PutLogAlarmCreates or updates a log alarm. A log alarm evaluates the results of a CloudWatch Logs scheduled query against the configured threshold and comparison… - POSTPut managed insight rules
/#X-Amz-Target=GraniteServiceVersion20100801.PutManagedInsightRulesCreates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights… - POSTPut metric alarm
/#X-Amz-Target=GraniteServiceVersion20100801.PutMetricAlarmCreates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, Metrics Insights query, or PromQL… - POSTPut metric data
/#X-Amz-Target=GraniteServiceVersion20100801.PutMetricDataPublishes metric data to Amazon CloudWatch. CloudWatch associates the data with the specified metric. If the specified metric does not exist, CloudWatch… - POSTPut metric data query definition
/#X-Amz-Target=GraniteServiceVersion20100801.PutMetricDataQueryDefinitionCreates or updates a metric data query definition. A metric data query definition saves a metric query so that you can reuse it later. It includes the query… - POSTPut metric stream
/#X-Amz-Target=GraniteServiceVersion20100801.PutMetricStreamCreates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations, including Amazon S3, and… - POSTSet alarm state
/#X-Amz-Target=GraniteServiceVersion20100801.SetAlarmStateTemporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate… - POSTStart metric streams
/#X-Amz-Target=GraniteServiceVersion20100801.StartMetricStreamsStarts the streaming of metrics for one or more of your metric streams. - POSTStart o tel enrichment
/#X-Amz-Target=GraniteServiceVersion20100801.StartOTelEnrichmentEnables enrichment and PromQL access for CloudWatch vended metrics for supported Amazon Web Services resources in the account. Once enabled, metrics that… - POSTStop metric streams
/#X-Amz-Target=GraniteServiceVersion20100801.StopMetricStreamsStops the streaming of metrics for one or more of your metric streams. - POSTStop o tel enrichment
/#X-Amz-Target=GraniteServiceVersion20100801.StopOTelEnrichmentDisables enrichment and PromQL access for CloudWatch vended metrics for supported Amazon Web Services resources in the account. After disabling, these metrics… - POSTTag resource
/#X-Amz-Target=GraniteServiceVersion20100801.TagResourceAssigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms,… - POSTUntag resource
/#X-Amz-Target=GraniteServiceVersion20100801.UntagResourceRemoves one or more tags from the specified resource. Currently, alarms, dashboards, metric streams and Contributor Insights rules support tagging. - POSTUpdate o tel enrichment
/#X-Amz-Target=GraniteServiceVersion20100801.UpdateOTelEnrichmentReplaces the filters that determine which CloudWatch vended metrics are enriched with resource ARN and resource tag labels for the account. Enrichment must… - POSTUpdate resource metrics configuration
/#X-Amz-Target=GraniteServiceVersion20100801.UpdateResourceMetricsConfigurationUpdates the resource metrics configuration for an Amazon Web Services resource. The MetricSelections value that you provide replaces any existing metric…
API details
- Base URL
https://monitoring.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 59 operations on 59 pathsPOST 59
- Description format
- AWS Smithy model, API version
2010-08-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon CloudWatch in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CloudWatch collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate dataset kms key” (POST /#X-Amz-Target=GraniteServiceVersion20100801.AssociateDatasetKmsKey), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon CloudWatch?
Amazon CloudWatch enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. This guide… It is listed under Developer tools and has 59 endpoints.
Who publishes the Amazon CloudWatch?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon CloudWatch?
Requests go to https://monitoring.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon CloudWatch?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon CloudWatch have?
59 operations on 59 paths (59 POST).
Is forking the Amazon CloudWatch free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.