Amazon CloudWatch is a monitoring and observability service that provides data and actionable insights for AWS, hybrid, and on-premises applications and infrastructure resources.
opencollection: 1.0.0
info:
name: AWS CloudWatch Amazon CloudWatch API
version: '2010-08-01'
request:
auth:
type: apikey
key: Authorization
value: '{{Authorization}}'
placement: header
items:
- info:
name: Metrics
type: folder
items:
- info:
name: Aws Cloudwatch Publish Metric Data Points to Cloudwatch
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/
headers:
- name: Content-Type
value: ''
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric.
If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take
up to fifteen minutes for the metric to appear in calls to ListMetrics. Each PutMetricData request is limited to 1 MB
in size for HTTP POST requests and is limited to 40 KB for HTTP GET requests. The maximum number of metric datum items
per PutMetricData request is 1
- info:
name: Aws Cloudwatch Retrieve Metric Data From Cloudwatch
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#GetMetricData
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Retrieves CloudWatch metric values. You can use GetMetricData to retrieve as many as 500 different metrics in a
single request, with a total of as many as 100,800 data points per request. You can also optionally perform metric math
expressions on the values of the returned statistics. CloudWatch returns aggregated data points based on the statistical
values requested.
- info:
name: Aws Cloudwatch Retrieve Statistics for a Specified Metric
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#GetMetricStatistics
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Gets 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, CloudWatch returns an error. CloudWatch retains metric data as follows -
data points with a period of less than 60 seconds are available for 3 hours, data points with a period of 60 seconds
are available for 15 days, data points with a period of 300 seconds are available for 63 days, and data points with
a period of 3600 seconds are availab
- info:
name: Aws Cloudwatch List the Specified Metrics
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#ListMetrics
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical
data. Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent
calls. CloudWatch retains metric data for 15 months.
- info:
name: Aws Cloudwatch Assign Tags to a Cloudwatch Resource
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#TagResource
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch
resources that can be tagged are alarms and Contributor Insights rules. Tags can help you organize and categorize your
resources.
- info:
name: Aws Cloudwatch Remove Tags From a Cloudwatch Resource
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#UntagResource
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Removes one or more tags from the specified resource.
- info:
name: Aws Cloudwatch List Tags for a Cloudwatch Resource
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#ListTagsForResource
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support
tagging.
- info:
name: Alarms
type: folder
items:
- info:
name: Aws Cloudwatch Create or Update a Cloudwatch Alarm
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#PutMetricAlarm
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection
model, or Metrics Insights query. When the alarm state changes, the alarm invokes the specified actions. An alarm can
watch only one metric at a time, but it can take actions based on other alarms. If you are using a composite alarm,
the alarm watches the states of other alarms.
- info:
name: Aws Cloudwatch Retrieve Information About Specified Alarms
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DescribeAlarms
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Retrieves 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 operation and return information about composite alarms, you must be
signed on with the cloudwatch:DescribeAlarms permission.
- info:
name: Aws Cloudwatch Retrieve Alarms for a Specified Metric
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DescribeAlarmsForMetric
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. This
operation retrieves only standard alarms that are based on the specified metric.
- info:
name: Aws Cloudwatch Retrieve the History for a Specified Alarm
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DescribeAlarmHistory
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Retrieves 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 either all metric alarms or all composite alarms are returned. CloudWatch retains
the history of an alarm even if you delete the alarm.
- info:
name: Aws Cloudwatch Delete Specified Alarms
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DeleteAlarms
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Deletes the specified alarms. You can delete up to 100 alarms in one operation. In the event of an error, no alarms
are deleted. To get information about your current alarms, use DescribeAlarms. If a specified alarm does not exist,
no error is returned.
- info:
name: Aws Cloudwatch Temporarily Set the State of an Alarm
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#SetAlarmState
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value,
the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon
SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.
- info:
name: Aws Cloudwatch Enable Actions for Specified Alarms
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#EnableAlarmActions
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Enables the actions for the specified alarms.
- info:
name: Aws Cloudwatch Disable Actions for Specified Alarms
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DisableAlarmActions
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute
when the alarm state changes.
- info:
name: Composite Alarms
type: folder
items:
- info:
name: Aws Cloudwatch Create or Update a Composite Alarm
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#PutCompositeAlarm
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Creates 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 of other alarms that you have created. The composite alarm goes into ALARM
state only if all conditions of the rule are met.
- info:
name: Dashboards
type: folder
items:
- info:
name: Aws Cloudwatch Create or Update a Cloudwatch Dashboard
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#PutDashboard
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Creates 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 specify here. There is no limit to the number of dashboards in your account.
- info:
name: Aws Cloudwatch Retrieve Details for a Specified Dashboard
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#GetDashboard
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Displays the details of the dashboard that you specify. To copy an existing dashboard, use GetDashboard, and then
use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create
the copy.
- info:
name: Aws Cloudwatch List the Dashboards in Your Account
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#ListDashboards
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with
names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. ListDashboards returns
up to 1000 results on one page.
- info:
name: Aws Cloudwatch Delete Specified Dashboards
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DeleteDashboards
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during
this call, no dashboards are deleted.
- info:
name: Anomaly Detection
type: folder
items:
- info:
name: Aws Cloudwatch Create an Anomaly Detection Model for a Metric
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#PutAnomalyDetector
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Creates 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 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.
- info:
name: Aws Cloudwatch List Anomaly Detection Models
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DescribeAnomalyDetectors
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Lists the anomaly detection models that you have created in your account. For each model, the response includes
configuration information for the model. If you filter the response, only the models matching the filter are returned.
- info:
name: Aws Cloudwatch Delete an Anomaly Detection Model
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#DeleteAnomalyDetector
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly
detection model, see Deleting an Anomaly Detection Model in the CloudWatch User Guide.
- info:
name: Metric Streams
type: folder
items:
- info:
name: Aws Cloudwatch Create or Update a Metric Stream
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#PutMetricStream
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to a Amazon Kinesis
Data Firehose delivery stream, or to Amazon S3 via a Kinesis Data Firehose delivery stream. The output includes metric
data in one of two formats, JSON or the OpenTelemetry 0.7.0 protobuf format.
- info:
name: Aws Cloudwatch List the Metric Streams in Your Account
type: http
http:
method: POST
url: https://monitoring.{region}.amazonaws.com/#ListMetricStreams
params:
- name: Action
value: ''
type: query
- name: Version
value: ''
type: query
description: The API version (2010-08-01)
body:
type: form-urlencoded
data: []
docs: Returns a list of metric streams in this account.
bundled: true
