AWS CodeStar Notifications
This CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the CodeStar Notifications API. You…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This CodeStar Notifications API Reference provides descriptions and usage examples of the
operations and data types for the CodeStar Notifications API. You can use the 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 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 CodeStar Notifications, see the
Amazon Web Services Developer Tools Console User Guide .
Endpoints 13
- POSTCreate notification rule
/createNotificationRuleCreates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as Amazon Q Developer in chat… - POSTDelete notification rule
/deleteNotificationRuleDeletes a notification rule for a resource. - POSTDelete target
/deleteTargetDeletes a specified target for notifications. - POSTDescribe notification rule
/describeNotificationRuleReturns information about a specified notification rule. - POSTList event types
/listEventTypesReturns information about the event types available for configuring notifications. - POSTList notification rules
/listNotificationRulesReturns a list of the notification rules for an Amazon Web Services account. - POSTList tags for resource
/listTagsForResourceReturns a list of the tags associated with a notification rule. - POSTList targets
/listTargetsReturns a list of the notification rule targets for an Amazon Web Services account. - POSTSubscribe
/subscribeCreates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so… - POSTTag resource
/tagResourceAssociates a set of provided tags with a notification rule. - POSTUnsubscribe
/unsubscribeRemoves an association between a notification rule and an Amazon Q Developer in chat applications topic so that subscribers to that topic stop receiving… - POSTUntag resource
/untagResource/:Arn?tagKeys=Removes the association between one or more provided tags and a notification rule. - POSTUpdate notification rule
/updateNotificationRuleUpdates 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…
API details
- Base URL
https://codestar-notifications.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 13 operations on 13 pathsPOST 13
- Description format
- AWS Smithy model, API version
2019-10-15 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS CodeStar Notifications in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CodeStar Notifications collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create notification rule” (POST /createNotificationRule), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS CodeStar Notifications?
This CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the CodeStar Notifications API. You… It is listed under Communication and has 13 endpoints.
Who publishes the AWS CodeStar Notifications?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS CodeStar Notifications?
Requests go to https://codestar-notifications.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS CodeStar Notifications?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS CodeStar Notifications have?
13 operations on 13 paths (13 POST).
Is forking the AWS CodeStar Notifications free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.