CloudWatch Logs code examples for the SDK for JavaScript (v3)

Overview

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

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

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

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.

Run a large query

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

bash

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

bash

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

bash

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Run a large query

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

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

Additional resources

SPDX-License-Identifier: Apache-2.0