AWS SDK for JavaScript Notifications Client for Node.js, Browser and React Native
npm install @aws-sdk/client-notificationsAWS SDK for JavaScript Notifications Client for Node.js, Browser and React Native.
The User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notifications API actions.
User Notification control plane APIs are currently available in US East (Virginia) - us-east-1.
GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.
The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).
For information about descriptions, API request parameters, and the JSON response for email contact related API actions, see the User Notifications Contacts API Reference Guide.
npm install @aws-sdk/client-notificationsyarn add @aws-sdk/client-notificationspnpm add @aws-sdk/client-notificationsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the NotificationsClient and
the commands you need, for example ListChannelsCommand:
``js`
// ES5 example
const { NotificationsClient, ListChannelsCommand } = require("@aws-sdk/client-notifications");
`ts`
// ES6+ example
import { NotificationsClient, ListChannelsCommand } from "@aws-sdk/client-notifications";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new NotificationsClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListChannelsCommand(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-notifications";
const client = new AWS.Notifications({ region: "REGION" });
// async/await.
try {
const data = await client.listChannels(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listChannels(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listChannels(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).
`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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-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.
AssociateChannel
Command API Reference / Input / Output
AssociateManagedNotificationAccountContact
Command API Reference / Input / Output
AssociateManagedNotificationAdditionalChannel
Command API Reference / Input / Output
AssociateOrganizationalUnit
Command API Reference / Input / Output
CreateEventRule
Command API Reference / Input / Output
CreateNotificationConfiguration
Command API Reference / Input / Output
DeleteEventRule
Command API Reference / Input / Output
DeleteNotificationConfiguration
Command API Reference / Input / Output
DeregisterNotificationHub
Command API Reference / Input / Output
DisableNotificationsAccessForOrganization
Command API Reference / Input / Output
DisassociateChannel
Command API Reference / Input / Output
DisassociateManagedNotificationAccountContact
Command API Reference / Input / Output
DisassociateManagedNotificationAdditionalChannel
Command API Reference / Input / Output
DisassociateOrganizationalUnit
Command API Reference / Input / Output
EnableNotificationsAccessForOrganization
Command API Reference / Input / Output
GetEventRule
Command API Reference / Input / Output
GetManagedNotificationChildEvent
Command API Reference / Input / Output
GetManagedNotificationConfiguration
Command API Reference / Input / Output
GetManagedNotificationEvent
Command API Reference / Input / Output
GetNotificationConfiguration
Command API Reference / Input / Output
GetNotificationEvent
Command API Reference / Input / Output
GetNotificationsAccessForOrganization
Command API Reference / Input / Output
ListChannels
Command API Reference / Input / Output
ListEventRules
Command API Reference / Input / Output
ListManagedNotificationChannelAssociations
Command API Reference / Input / Output
ListManagedNotificationChildEvents
Command API Reference / Input / Output
ListManagedNotificationConfigurations
Command API Reference / Input / Output
ListManagedNotificationEvents
Command API Reference / Input / Output
ListMemberAccounts
Command API Reference / Input / Output
ListNotificationConfigurations
Command API Reference / Input / Output
ListNotificationEvents
Command API Reference / Input / Output
ListNotificationHubs
Command API Reference / Input / Output
ListOrganizationalUnits
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
RegisterNotificationHub
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateEventRule
Command API Reference / Input / Output
UpdateNotificationConfiguration