Expand 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 (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.
If you’re using the service, you’re probably looking for CodeStarNotificationsClient and CodeStarNotifications.
Structs§
- Code
Star Notifications Client - A client for the AWS CodeStar Notifications API.
- Create
Notification Rule Request - Create
Notification Rule Result - Delete
Notification Rule Request - Delete
Notification Rule Result - Delete
Target Request - Delete
Target Result - Describe
Notification Rule Request - Describe
Notification Rule Result - Event
Type Summary Returns information about an event that has triggered a notification rule.
- List
Event Types Filter Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
- List
Event Types Request - List
Event Types Result - List
Notification Rules Filter Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
- List
Notification Rules Request - List
Notification Rules Result - List
Tags ForResource Request - List
Tags ForResource Result - List
Targets Filter 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.
- List
Targets Request - List
Targets Result - Notification
Rule Summary Information about a specified notification rule.
- Subscribe
Request - Subscribe
Result - TagResource
Request - TagResource
Result - Target
Information about the SNS topics associated with a notification rule.
- Target
Summary Information about the targets specified for a notification rule.
- Unsubscribe
Request - Unsubscribe
Result - Untag
Resource Request - Untag
Resource Result - Update
Notification Rule Request - Update
Notification Rule Result
Enums§
- Create
Notification Rule Error - Errors returned by CreateNotificationRule
- Delete
Notification Rule Error - Errors returned by DeleteNotificationRule
- Delete
Target Error - Errors returned by DeleteTarget
- Describe
Notification Rule Error - Errors returned by DescribeNotificationRule
- List
Event Types Error - Errors returned by ListEventTypes
- List
Notification Rules Error - Errors returned by ListNotificationRules
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Targets Error - Errors returned by ListTargets
- Subscribe
Error - Errors returned by Subscribe
- TagResource
Error - Errors returned by TagResource
- Unsubscribe
Error - Errors returned by Unsubscribe
- Untag
Resource Error - Errors returned by UntagResource
- Update
Notification Rule Error - Errors returned by UpdateNotificationRule
Traits§
- Code
Star Notifications - Trait representing the capabilities of the AWS CodeStar Notifications API. AWS CodeStar Notifications clients implement this trait.