2023-03-31 05:36:53 -07:00
# CloudWatch code examples for the SDK for Python
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
## Overview
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
Shows how to use the AWS SDK for Python (Boto3) to work with Amazon CloudWatch.
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.overview.start-->
<!--custom.overview.end-->
2024-01-05 10:05:03 -05:00
_ CloudWatch provides a reliable, scalable, and flexible monitoring solution that you can start using within minutes. _
2023-03-31 05:36:53 -07:00
## ⚠ Important
2024-01-05 10:05:03 -05:00
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing ](https://aws.amazon.com/pricing/ ) and [Free Tier ](https://aws.amazon.com/free/ ).
2023-03-31 05:36:53 -07:00
* Running the tests might result in charges to your AWS account.
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege ](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege ).
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services ](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services ).
<!--custom.important.start-->
<!--custom.important.end-->
2020-11-30 17:17:07 -08:00
2021-07-28 17:38:03 -07:00
## Code examples
2023-04-13 11:38:14 -07:00
### Prerequisites
For prerequisites, see the [README ](../../README.md#Prerequisites ) in the `python` folder.
Install the packages required by these examples by running the following in a virtual environment:
```
python -m pip install -r requirements.txt
```
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
2023-03-31 05:36:53 -07:00
### Single actions
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
Code excerpts that show you how to call individual service functions.
2020-11-30 17:17:07 -08:00
2024-04-30 12:22:08 -07:00
- [DeleteAlarms ](cloudwatch_basics.py#L264 )
- [DescribeAlarmsForMetric ](cloudwatch_basics.py#L216 )
- [DisableAlarmActions ](cloudwatch_basics.py#L232 )
- [EnableAlarmActions ](cloudwatch_basics.py#L232 )
- [GetMetricStatistics ](cloudwatch_basics.py#L123 )
- [ListMetrics ](cloudwatch_basics.py#L37 )
- [PutMetricAlarm ](cloudwatch_basics.py#L158 )
- [PutMetricData ](cloudwatch_basics.py#L64 )
2023-03-31 05:36:53 -07:00
### Scenarios
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.
2020-11-30 17:17:07 -08:00
2024-01-05 10:05:03 -05:00
- [Manage metrics and alarms ](cloudwatch_basics.py )
<!--custom.examples.start-->
<!--custom.examples.end-->
2023-03-31 05:36:53 -07:00
## Run the examples
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
### Instructions
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.instructions.start-->
<!--custom.instructions.end-->
2020-11-30 17:17:07 -08:00
2023-04-13 11:38:14 -07:00
2023-03-31 05:36:53 -07:00
#### Manage metrics and alarms
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
This example shows you how to do the following:
2020-11-30 17:17:07 -08:00
2024-01-05 10:05:03 -05:00
- Create an alarm to watch a CloudWatch metric.
- Put data into a metric and trigger the alarm.
- Get data from the alarm.
- Delete the alarm.
2020-11-30 17:17:07 -08:00
2023-04-13 11:38:14 -07:00
<!--custom.scenario_prereqs.cloudwatch_Usage_MetricsAlarms.start-->
<!--custom.scenario_prereqs.cloudwatch_Usage_MetricsAlarms.end-->
2023-03-31 05:36:53 -07:00
Start the example by running the following at a command prompt:
```
python cloudwatch_basics.py
2020-11-30 17:17:07 -08:00
```
2023-10-13 14:57:41 -05:00
2023-03-31 05:36:53 -07:00
<!--custom.scenarios.cloudwatch_Usage_MetricsAlarms.start-->
<!--custom.scenarios.cloudwatch_Usage_MetricsAlarms.end-->
### Tests
⚠ Running tests might result in charges to your AWS account.
To find instructions for running these tests, see the [README ](../../README.md#Tests )
in the `python` folder.
2020-11-30 17:17:07 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.tests.start-->
<!--custom.tests.end-->
## Additional resources
2024-01-05 10:05:03 -05:00
- [CloudWatch User Guide ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html )
- [CloudWatch API Reference ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/Welcome.html )
- [SDK for Python CloudWatch reference ](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudwatch.html )
2023-03-31 05:36:53 -07:00
<!--custom.resources.start-->
<!--custom.resources.end-->
2020-11-30 17:17:07 -08:00
---
2023-03-31 05:36:53 -07:00
2020-11-30 17:17:07 -08:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2023-03-31 05:36:53 -07:00
SPDX-License-Identifier: Apache-2.0