@aws-sdk/client-eventbridge-browser

Description

Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into 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 AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state
Direct specific API records from AWS 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 the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-eventbridge-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(EventBridgeClient) and the commands you need, for example ActivateEventSourceCommand:

//JavaScript
const {
  EventBridgeClient
} = require("@aws-sdk/client-eventbridge-browser/EventBridgeClient");
const {
  ActivateEventSourceCommand
} = require("@aws-sdk/client-eventbridge-browser/commands/ActivateEventSourceCommand");

//TypeScript
import { EventBridgeClient } from "@aws-sdk/client-eventbridge-browser/EventBridgeClient";
import { ActivateEventSourceCommand } from "@aws-sdk/client-eventbridge-browser/commands/ActivateEventSourceCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
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.

const eventBridge = new EventBridgeClient({region: 'region'});
//clients can be shared by different commands
const params = {
  Name: /**a string value*/,
};
const activateEventSourceCommand = new ActivateEventSourceCommand(params);
eventBridge.send(activateEventSourceCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await eventBridge.send(activateEventSourceCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
eventBridge.send(activateEventSourceCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-eventbridge-browser/EventBridge";
const eventBridge = new AWS.EventBridge({ region: "region" });
eventBridge.activateEventSource(params, (err, data) => {
  //do something
});

Troubleshooting

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

try {
  const data = await eventBridge.send(activateEventSourceCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-eventbridge-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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