forked from awsdocs/aws-doc-sdk-examples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
JavaScript (v3): Chore - Update READMES (awsdocs#5408)
- Loading branch information
Showing
76 changed files
with
746 additions
and
420 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ | |
| '__pycache__', | ||
| 'cdk.out', | ||
| 'node_modules', | ||
| 'Pods', | ||
| 'dist', | ||
| 'target', | ||
| 'venv', | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,91 @@ | ||
| # CloudWatch Events code examples for the SDK for JavaScript in Node.js | ||
| <!--Generated by WRITEME on 2023-09-25 14:15:58.223814 (UTC)--> | ||
| # CloudWatch Events code examples for the SDK for JavaScript (v3) | ||
|
|
||
| ## Overview | ||
|
|
||
| The code examples in this directory demonstrate how to work with Amazon CloudWatch Events | ||
| using the AWS SDK for JavaScript (v3). | ||
| Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon CloudWatch Events. | ||
|
|
||
| Amazon CloudWatch Events delivers a near real-time stream of system events that describe | ||
| changes in Amazon Web Services (AWS) resources. | ||
| <!--custom.overview.start--> | ||
| <!--custom.overview.end--> | ||
|
|
||
| ## ⚠️ Important | ||
| *CloudWatch Events send system events from AWS resources to AWS Lambda functions, Amazon Simple Notification Service topics, streams in Amazon Kinesis, and other target types.* | ||
|
|
||
| - Running this code might result in charges to your AWS account. | ||
| - 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). | ||
| ## ⚠ Important | ||
|
|
||
| * Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/?aws-products-pricing.sort-by=item.additionalFields.productNameLowercase&aws-products-pricing.sort-order=asc&awsf.Free%20Tier%20Type=*all&awsf.tech-category=*all) and [Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all). | ||
| * 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 `javascriptv3` folder. | ||
|
|
||
|
|
||
| <!--custom.prerequisites.start--> | ||
| <!--custom.prerequisites.end--> | ||
|
|
||
| ### Single actions | ||
|
|
||
| Code excerpts that show you how to call individual service functions. | ||
|
|
||
| - [Add an AWS Lambda function target](actions/put-targets.js)(PutTargets) | ||
| - [Create a scheduled rule](actions/put-rule.js)(PutRule) | ||
| - [Send events](actions/put-events.js)(PutEvents) | ||
| * [Adding a target](actions/put-targets.js#L6) (`PutTargets`) | ||
| * [Create a scheduled rule](actions/put-rule.js#L6) (`PutRule`) | ||
| * [Send events](actions/put-events.js#L6) (`PutEvents`) | ||
|
|
||
| ## 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](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sdk-examples-javascript-syntax.html). | ||
|
|
||
| ### Prerequisites | ||
| **Run a single action** | ||
|
|
||
| - [Set up AWS SDK for JavaScript](../README.rst) | ||
| - Run `npm i` to install dependencies. | ||
| ```bash | ||
| node ./actions/<fileName> | ||
| ``` | ||
|
|
||
| ## Instructions | ||
| **Run a scenario** | ||
| Most scenarios can be run with the following command: | ||
| ```bash | ||
| node ./scenarios/<fileName> | ||
| ``` | ||
|
|
||
| **Run a single action** | ||
| <!--custom.instructions.start--> | ||
| <!--custom.instructions.end--> | ||
|
|
||
|
|
||
|
|
||
| ### Tests | ||
|
|
||
| 1. Run `node ./actions/<fileName>`. | ||
| OR | ||
| 1. Import `./actions/fileName` into another module. | ||
| ⚠ Running tests might result in charges to your AWS account. | ||
|
|
||
| ## Tests | ||
|
|
||
| ⚠️ Running the tests might result in charges to your AWS account. | ||
| To find instructions for running these tests, see the [README](../../README.md#Tests) | ||
| in the `javascriptv3` folder. | ||
|
|
||
| ### Integration tests | ||
|
|
||
| 1. Run `npm i`. | ||
| 1. Run `npm run integration-test`. | ||
|
|
||
| <!--custom.tests.start--> | ||
| <!--custom.tests.end--> | ||
|
|
||
| ## Additional resources | ||
|
|
||
| - [Amazon CloudWatch Events User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html) | ||
| - [Amazon CloudWatch Logs API Reference](https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html) | ||
| - [CloudWatch Events Client - AWS SDK for JavaScript (v3)](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-events/index.html) | ||
| * [CloudWatch Events User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html) | ||
| * [CloudWatch Events API Reference](https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html) | ||
| * [SDK for JavaScript (v3) CloudWatch Events reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-events) | ||
|
|
||
| <!--custom.resources.start--> | ||
| <!--custom.resources.end--> | ||
|
|
||
| --- | ||
|
|
||
| Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
|
|
||
| Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0 | ||
| SPDX-License-Identifier: Apache-2.0 |
Oops, something went wrong.