@aws-sdk/client-cloudwatch-events

Description

AWS SDK for JavaScript CloudWatchEvents Client for Node.js, Browser and React Native.

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
resources change state, they automatically send events to an event stream. You can create
rules that match selected events in the stream and route them to targets to take action. You
can also use rules to take action on a predetermined schedule. For example, you can configure
rules to:

• 
  

  Automatically invoke an Lambda function to update DNS entries when an event
  notifies you that Amazon EC2 instance enters the running state.

  
  


• 
  

  Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
  detailed analysis of potential security or availability risks.

  
  


• 
  

  Periodically invoke a built-in target to create a snapshot of an Amazon EBS
  volume.

  
  

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User
Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-cloudwatch-events
using your favorite package manager:
- npm install @aws-sdk/client-cloudwatch-events
- yarn add @aws-sdk/client-cloudwatch-events
- pnpm add @aws-sdk/client-cloudwatch-events

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CloudWatchEventsClient and
the commands you need, for example ListReplaysCommand:

``js
// ES5 example
const { CloudWatchEventsClient, ListReplaysCommand } = require("@aws-sdk/client-cloudwatch-events");
`

`ts
// ES6+ example
import { CloudWatchEventsClient, ListReplaysCommand } from "@aws-sdk/client-cloudwatch-events";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new CloudWatchEventsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListReplaysCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-cloudwatch-events";
const client = new AWS.CloudWatchEvents({ region: "REGION" });

// async/await.
try {
const data = await client.listReplays(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listReplays(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listReplays(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-cloudwatch-events` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

ActivateEventSource

Command API Reference / Input / Output

CancelReplay

Command API Reference / Input / Output

CreateApiDestination

Command API Reference / Input / Output

CreateArchive

Command API Reference / Input / Output

CreateConnection

Command API Reference / Input / Output

CreateEventBus

Command API Reference / Input / Output

CreatePartnerEventSource

Command API Reference / Input / Output

DeactivateEventSource

Command API Reference / Input / Output

DeauthorizeConnection

Command API Reference / Input / Output

DeleteApiDestination

Command API Reference / Input / Output

DeleteArchive

Command API Reference / Input / Output

DeleteConnection

Command API Reference / Input / Output

DeleteEventBus

Command API Reference / Input / Output

DeletePartnerEventSource

Command API Reference / Input / Output

DeleteRule

Command API Reference / Input / Output

DescribeApiDestination

Command API Reference / Input / Output

DescribeArchive

Command API Reference / Input / Output

DescribeConnection

Command API Reference / Input / Output

DescribeEventBus

Command API Reference / Input / Output

DescribeEventSource

Command API Reference / Input / Output

DescribePartnerEventSource

Command API Reference / Input / Output

DescribeReplay

Command API Reference / Input / Output

DescribeRule

Command API Reference / Input / Output

DisableRule

Command API Reference / Input / Output

EnableRule

Command API Reference / Input / Output

ListApiDestinations

Command API Reference / Input / Output

ListArchives

Command API Reference / Input / Output

ListConnections

Command API Reference / Input / Output

ListEventBuses

Command API Reference / Input / Output

ListEventSources

Command API Reference / Input / Output

ListPartnerEventSourceAccounts

Command API Reference / Input / Output

ListPartnerEventSources

Command API Reference / Input / Output

ListReplays

Command API Reference / Input / Output

ListRuleNamesByTarget

Command API Reference / Input / Output

ListRules

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTargetsByRule

Command API Reference / Input / Output

PutEvents

Command API Reference / Input / Output

PutPartnerEvents

Command API Reference / Input / Output

PutPermission

Command API Reference / Input / Output

PutRule

Command API Reference / Input / Output

PutTargets

Command API Reference / Input / Output

RemovePermission

Command API Reference / Input / Output

RemoveTargets

Command API Reference / Input / Output

StartReplay

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TestEventPattern

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApiDestination

Command API Reference / Input / Output

UpdateArchive

Command API Reference / Input / Output

UpdateConnection

Command API Reference / Input / Output