CodeStarNotifications class

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:

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.

Constructors

CodeStarNotifications({@required String region, AwsClientCredentials credentials, Client client, String endpointUrl})

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createNotificationRule({DetailType detailType, List<String> eventTypeIds, String name, String resource, List<Target> targets, String clientRequestToken, NotificationRuleStatus status, Map<String, String> tags}) Future<CreateNotificationRuleResult>
Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them. [...]
deleteNotificationRule({String arn}) Future<DeleteNotificationRuleResult>
Deletes a notification rule for a resource. [...]
deleteTarget({String targetAddress, bool forceUnsubscribeAll}) Future<void>
Deletes a specified target for notifications. [...]
describeNotificationRule({String arn}) Future<DescribeNotificationRuleResult>
Returns information about a specified notification rule. [...]
listEventTypes({List<ListEventTypesFilter> filters, int maxResults, String nextToken}) Future<ListEventTypesResult>
Returns information about the event types available for configuring notifications. [...]
listNotificationRules({List<ListNotificationRulesFilter> filters, int maxResults, String nextToken}) Future<ListNotificationRulesResult>
Returns a list of the notification rules for an AWS account. [...]
listTagsForResource({String arn}) Future<ListTagsForResourceResult>
Returns a list of the tags associated with a notification rule. [...]
listTargets({List<ListTargetsFilter> filters, int maxResults, String nextToken}) Future<ListTargetsResult>
Returns a list of the notification rule targets for an AWS account. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
subscribe({String arn, Target target, String clientRequestToken}) Future<SubscribeResult>
Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered. [...]
tagResource({String arn, Map<String, String> tags}) Future<TagResourceResult>
Associates a set of provided tags with a notification rule. [...]
toString() String
A string representation of this object. [...]
inherited
unsubscribe({String arn, String targetAddress}) Future<UnsubscribeResult>
Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered. [...]
untagResource({String arn, List<String> tagKeys}) Future<void>
Removes the association between one or more provided tags and a notification rule. [...]
updateNotificationRule({String arn, DetailType detailType, List<String> eventTypeIds, String name, NotificationRuleStatus status, List<Target> targets}) Future<void>
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. [...]

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited