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.
Crate Organization
The entry point for most customers will be Client
. Client
exposes one method for each API offered
by the service.
Some APIs require complex or nested arguments. These exist in model
.
Lastly, errors that can be returned by the service are contained within error
. Error
defines a meta
error encompassing all possible errors that can be returned by the service.
The other modules within this crate are not required for normal usage.
Modules
Client and fluent builders for calling the service.
Configuration for the service.
Errors that can occur when calling the service.
Input structures for operations.
Base Middleware Stack
Data structures used by operation inputs/outputs.
All operations that this crate can perform.
Output structures for operations.
Paginators for the service
Re-exported types from supporting crates.
Structs
App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for AWS CodeStar Notifications
Service config.
AWS SDK Credentials
API Endpoint
The region to send requests to.
Retry configuration for requests.
Enums
All possible error types for this service.
Statics
Crate version number.