# CloudWatch Logs code examples for the SDK for Python

## Overview

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

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

_CloudWatch Logs monitor, store, and access your log files from Amazon Elastic Compute Cloud instances, AWS CloudTrail, or other sources._

## ⚠ Important

* 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/).
* 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-->

## Code examples

### 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-->

### Single actions

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

- [GetQueryResults](scenarios/large-query/cloudwatch_query.py#L204)
- [StartQuery](scenarios/large-query/cloudwatch_query.py#L130)

### Scenarios

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

- [Run a large query](scenarios/large-query/exec.py)
- [Use scheduled events to invoke a Lambda function](../../example_code/lambda)


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

## Run the examples

### Instructions


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



#### Run a large query

This example shows you how to use CloudWatch Logs to query more than 10,000 records.


<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.start-->
<!--custom.scenario_prereqs.cloudwatch-logs_Scenario_BigQuery.end-->

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

```
python scenarios/large-query/exec.py
```


<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.start-->
<!--custom.scenarios.cloudwatch-logs_Scenario_BigQuery.end-->

#### Use scheduled events to invoke a Lambda function

This example shows you how to create an AWS Lambda function invoked by an Amazon EventBridge scheduled event.


<!--custom.scenario_prereqs.cross_LambdaScheduledEvents.start-->
<!--custom.scenario_prereqs.cross_LambdaScheduledEvents.end-->


<!--custom.scenarios.cross_LambdaScheduledEvents.start-->
<!--custom.scenarios.cross_LambdaScheduledEvents.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.



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

## Additional resources

- [CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html)
- [CloudWatch Logs API Reference](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/Welcome.html)
- [SDK for Python CloudWatch Logs reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudwatch-logs.html)

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

---

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

SPDX-License-Identifier: Apache-2.0