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 (SNS topic) 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 link in the CodeStarNotifications User Guide.
A client for the AWS CodeStar Notifications API.
Returns information about an event that has triggered a notification rule.
Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
Information about a filter to apply to the list of returned targets. You can filter by target type, address, or status. For example, to filter results to notification rules that have active Amazon SNS topics as targets, you could specify a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.
Information about a specified notification rule.
Information about the SNS topics associated with a notification rule.
Information about the targets specified for a notification rule.
Errors returned by CreateNotificationRule
Errors returned by DeleteNotificationRule
Errors returned by DeleteTarget
Errors returned by DescribeNotificationRule
Errors returned by ListEventTypes
Errors returned by ListNotificationRules
Errors returned by ListTagsForResource
Errors returned by ListTargets
Errors returned by Subscribe
Errors returned by TagResource
Errors returned by Unsubscribe
Errors returned by UntagResource
Errors returned by UpdateNotificationRule
Trait representing the capabilities of the AWS CodeStar Notifications API. AWS CodeStar Notifications clients implement this trait.