Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@aws-sdk/client-codestar-notifications
Advanced tools
AWS SDK for JavaScript Codestar Notifications Client for Node.js, Browser and React Native
AWS SDK for JavaScript CodestarNotifications Client for Node.js, Browser and React Native.
This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API to work with the following objects:
Notification rules, by calling the following:
CreateNotificationRule, which creates a notification rule for a resource in your account.
DeleteNotificationRule, which deletes a notification rule.
DescribeNotificationRule, which provides information about a notification rule.
ListNotificationRules, which lists the notification rules associated with your account.
UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.
Subscribe, which subscribes a target to a notification rule.
Unsubscribe, which removes a target from a notification rule.
Targets, by calling the following:
DeleteTarget, which removes a notification rule target from a notification rule.
ListTargets, which lists the targets associated with a notification rule.
Events, by calling the following:
ListEventTypes, which lists the event types you can include in a notification rule.
Tags, by calling the following:
ListTagsForResource, which lists the tags already associated with a notification rule in your account.
TagResource, which associates a tag you provide with a notification rule in your account.
UntagResource, which removes a tag from a notification rule in your account.
For information about how to use AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide.
To install the this package, simply type add or install @aws-sdk/client-codestar-notifications using your favorite package manager:
npm install @aws-sdk/client-codestar-notifications
yarn add @aws-sdk/client-codestar-notifications
pnpm add @aws-sdk/client-codestar-notifications
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CodestarNotificationsClient
and
the commands you need, for example ListTargetsCommand
:
// ES5 example
const { CodestarNotificationsClient, ListTargetsCommand } = require("@aws-sdk/client-codestar-notifications");
// ES6+ example
import { CodestarNotificationsClient, ListTargetsCommand } from "@aws-sdk/client-codestar-notifications";
To send a request, you:
send
operation on client with command object as input.destroy()
to close open connections.// a client can be shared by different commands.
const client = new CodestarNotificationsClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListTargetsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// 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.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
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
import * as AWS from "@aws-sdk/client-codestar-notifications";
const client = new AWS.CodestarNotifications({ region: "REGION" });
// async/await.
try {
const data = await client.listTargets(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTargets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTargets(params, (err, data) => {
// process err and data.
});
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 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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js
.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-codestar-notifications
package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Codestar Notifications Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-codestar-notifications receives a total of 2,692 weekly downloads. As such, @aws-sdk/client-codestar-notifications popularity was classified as popular.
We found that @aws-sdk/client-codestar-notifications demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.