ContextQMD
Back to Aws Doc Sdk Examples

CloudWatch code examples for the SDK for Python

python/example_code/cloudwatch/README.md

latest3.6 KB
Original Source

CloudWatch code examples for the SDK for Python

Overview

Shows how to use the AWS SDK for Python (Boto3) to work with Amazon CloudWatch.

<!--custom.overview.start--> <!--custom.overview.end-->

CloudWatch provides a reliable, scalable, and flexible monitoring solution that you can start using within minutes.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • 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.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README 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-->

Single actions

Code excerpts that show you how to call individual service functions.

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Manage metrics and alarms

This example shows you how to do the following:

  • 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.
<!--custom.scenario_prereqs.cloudwatch_Usage_MetricsAlarms.start--> <!--custom.scenario_prereqs.cloudwatch_Usage_MetricsAlarms.end-->

Start the example by running the following at a command prompt:

python cloudwatch_basics.py
<!--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 in the python folder.

<!--custom.tests.start--> <!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0