AWS.Codestarnotifications (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Creates a notification rule for a resource.

Deletes a notification rule for a resource.

Deletes a specified target for notifications.

Returns information about a specified notification rule.

Returns information about the event types available for configuring notifications.

Returns a list of the notification rules for an AWS account.

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

Returns a list of the notification rule targets for an AWS account.

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.

Associates a set of provided tags with a notification rule.

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.

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

Updates a notification rule for a resource.

Link to this section Functions

Link to this function

create_notification_rule(client, input, options \\ [])

View Source

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.

Link to this function

delete_notification_rule(client, input, options \\ [])

View Source

Deletes a notification rule for a resource.

Link to this function

delete_target(client, input, options \\ [])

View Source

Deletes a specified target for notifications.

Link to this function

describe_notification_rule(client, input, options \\ [])

View Source

Returns information about a specified notification rule.

Link to this function

list_event_types(client, input, options \\ [])

View Source

Returns information about the event types available for configuring notifications.

Link to this function

list_notification_rules(client, input, options \\ [])

View Source

Returns a list of the notification rules for an AWS account.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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

Link to this function

list_targets(client, input, options \\ [])

View Source

Returns a list of the notification rule targets for an AWS account.

Link to this function

subscribe(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Associates a set of provided tags with a notification rule.

Link to this function

unsubscribe(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

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

Link to this function

update_notification_rule(client, input, options \\ [])

View Source

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.