CodestarNotificationsClient

Suggest an Edit

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 .

Installation

NPM
npm install @aws-sdk/client-codestar-notifications
Yarn
yarn add @aws-sdk/client-codestar-notifications
pnpm
pnpm add @aws-sdk/client-codestar-notifications

CodestarNotificationsClient Operations

Command
Summary
CreateNotificationRuleCommand

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.

DeleteNotificationRuleCommand

Deletes a notification rule for a resource.

DeleteTargetCommand

Deletes a specified target for notifications.

DescribeNotificationRuleCommand

Returns information about a specified notification rule.

ListEventTypesCommand

Returns information about the event types available for configuring notifications.

ListNotificationRulesCommand

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

ListTagsForResourceCommand

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

ListTargetsCommand

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

SubscribeCommand

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.

TagResourceCommand

Associates a set of provided tags with a notification rule.

UnsubscribeCommand

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.

UntagResourceCommand

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

UpdateNotificationRuleCommand

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.

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

CodestarNotificationsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: CodestarNotificationsClientConfig