AWS.CodeStarNotifications — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.CodeStarNotifications show all

Identifier:

codestarnotifications

API Version:

2019-10-15

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using CodeStarNotifications

var codestarnotifications = new AWS.CodeStarNotifications();
codestarnotifications.deleteTarget(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeStarNotifications object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codestarnotifications = new AWS.CodeStarNotifications({apiVersion: '2019-10-15'});

You can also set the API version globally in AWS.config.apiVersions using the codestarnotifications service identifier:

AWS.config.apiVersions = {
  codestarnotifications: '2019-10-15',
  // other service API versions
};

var codestarnotifications = new AWS.CodeStarNotifications();

Constructor Summarycollapse

• new AWS.CodeStarNotifications(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• createNotificationRule(params = {}, callback) ⇒ AWS.Request
  Creates a notification rule for a resource.
• deleteNotificationRule(params = {}, callback) ⇒ AWS.Request
  Deletes a notification rule for a resource.
  .
• deleteTarget(params = {}, callback) ⇒ AWS.Request
  Deletes a specified target for notifications.
  .
• describeNotificationRule(params = {}, callback) ⇒ AWS.Request
  Returns information about a specified notification rule.
  .
• listEventTypes(params = {}, callback) ⇒ AWS.Request
  Returns information about the event types available for configuring notifications.
  .
• listNotificationRules(params = {}, callback) ⇒ AWS.Request
  Returns a list of the notification rules for an Amazon Web Services account.
  .
• listTagsForResource(params = {}, callback) ⇒ AWS.Request
  Returns a list of the tags associated with a notification rule.
  .
• listTargets(params = {}, callback) ⇒ AWS.Request
  Returns a list of the notification rule targets for an Amazon Web Services account.
  .
• subscribe(params = {}, callback) ⇒ AWS.Request
  Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.
  .
• tagResource(params = {}, callback) ⇒ AWS.Request
  Associates a set of provided tags with a notification rule.
  .
• unsubscribe(params = {}, callback) ⇒ AWS.Request
  Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.
  .
• untagResource(params = {}, callback) ⇒ AWS.Request
  Removes the association between one or more provided tags and a notification rule.
  .
• updateNotificationRule(params = {}, callback) ⇒ AWS.Request
  Updates a notification rule for a resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeStarNotifications(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createNotificationRule(params = {}, callback) ⇒ AWS.Request

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Chatbot topics or Chatbot clients configured for Slack) where you want to receive them.

deleteNotificationRule(params = {}, callback) ⇒ AWS.Request

Deletes a notification rule for a resource.

deleteTarget(params = {}, callback) ⇒ AWS.Request

Deletes a specified target for notifications.

describeNotificationRule(params = {}, callback) ⇒ AWS.Request

Returns information about a specified notification rule.

listEventTypes(params = {}, callback) ⇒ AWS.Request

Returns information about the event types available for configuring notifications.

listNotificationRules(params = {}, callback) ⇒ AWS.Request

Returns a list of the notification rules for an Amazon Web Services account.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of the tags associated with a notification rule.

listTargets(params = {}, callback) ⇒ AWS.Request

Returns a list of the notification rule targets for an Amazon Web Services account.

subscribe(params = {}, callback) ⇒ AWS.Request

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates a set of provided tags with a notification rule.

unsubscribe(params = {}, callback) ⇒ AWS.Request

Removes an association between a notification rule and an Chatbot topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes the association between one or more provided tags and a notification rule.

updateNotificationRule(params = {}, callback) ⇒ AWS.Request

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.