canonical: https://jentic.com/apis/amazonaws.com/codestar-notifications

# AWS CodeStar Notifications

Jentic publishes the only available OpenAPI specification for AWS CodeStar Notifications, keeping it validated and agent-ready. CodeStar Notifications routes events from AWS Developer Tools (CodeCommit, CodeBuild, CodeDeploy, CodePipeline) to SNS topics and AWS Chatbot Slack channels via notification rules. The API covers notification rules, targets, event types, subscriptions, and tags, so an agent can wire up build- and deploy-event delivery to chat or downstream automation.

## For AI agents

Create and manage AWS CodeStar notification rules that deliver CodeCommit, CodeBuild, CodeDeploy, and CodePipeline events to SNS topics and Slack via AWS Chatbot. Backed by 13 endpoints across rules, targets, and event types.

## Scope

Does not handle event generation, message formatting, or chat platform onboarding (configure AWS Chatbot separately) - use for routing AWS Developer Tools events to SNS and Chatbot targets only.

## Capabilities

- Create notification rules that match Developer Tools events on a specific resource
- Subscribe and unsubscribe SNS topic and AWS Chatbot Slack targets to a notification rule
- List supported event types per service and resource type
- Update existing notification rules to change event filters or status
- Delete unused notification rules and orphaned targets
- Tag notification rules for ownership and cost allocation

## Use cases

### Slack Alerts for Pipeline Failures

Engineering teams that live in Slack want a message every time a production CodePipeline fails. The agent creates a notification rule with the pipeline ARN as Resource, the relevant pipeline-execution-failed EventTypeIds, and a Target that points to a Slack channel registered with AWS Chatbot. ListEventTypes returns the canonical event-type IDs to use, removing guesswork.

Example prompt: Create a notification rule named pipeline-fail-alerts on the prod pipeline ARN with EventTypeIds for codepipeline-pipeline-pipeline-execution-failed and target a Slack chat configuration

### Centralised Build Event Stream into SNS

When build, deploy, or repository events need to be processed by Lambda, EventBridge, or third-party tooling, an agent creates a notification rule with an SNS topic Target. Once events flow into SNS, downstream subscribers can transform or fan out the messages. Subscribe and Unsubscribe make it easy to add or remove SNS topics on existing rules without recreating them.

Example prompt: Subscribe SNS topic arn:aws:sns:..:dev-events to notification rule arn:aws:codestar-notifications:..:notificationrule/abc

### Inventory and Cleanup of Stale Notification Rules

When repositories or pipelines are decommissioned, their notification rules can be left orphaned, sending events about non-existent resources. ListNotificationRules with a Filter on RESOURCE returns every rule on a given ARN, and DeleteNotificationRule removes those that are no longer relevant. Tagging rules with an owner helps the agent decide which can be safely cleaned up.

Example prompt: List all notification rules tagged Team=billing-svc and delete any whose Resource ARN no longer exists

### AI Agent Integration via Jentic

Through Jentic, an AI agent uses CodeStar Notifications by searching for an intent like 'create a CodeStar notification rule', loading the CreateNotificationRule schema, and executing it with the resource ARN and event type IDs. Jentic signs the SigV4 request server-side using IAM credentials in your Jentic One instance.

Example prompt: Search Jentic for 'create a CodeStar notification rule', load the CreateNotificationRule schema, and execute it for the prod pipeline ARN with pipeline-failed event type

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /createNotificationRule | Create a notification rule |
| POST | /describeNotificationRule | Describe a notification rule |
| POST | /listNotificationRules | List notification rules with filters |
| POST | /updateNotificationRule | Update an existing notification rule |
| POST | /deleteNotificationRule | Delete a notification rule |
| POST | /subscribe | Subscribe a target to a notification rule |
| POST | /unsubscribe | Unsubscribe a target from a notification rule |
| POST | /listEventTypes | List supported event types |

## Key resources

- **Notification Rule** — Create, describe, list, update, and delete notification rules
- **Target** — Subscribe and unsubscribe SNS or AWS Chatbot Slack targets and delete unused targets
- **Event Type** — List supported Developer Tools event types per service and resource
- **Tag** — Tag notification rules and list tags by ARN

## Why Jentic

- **Setup:** Wiring AWS CodeStar Notifications by hand means signing every request with AWS Signature v4 HMAC and targeting the right regional host like codestar-notifications.{region}.amazonaws.com before you can wire a rule to an SNS or Chatbot target. Through Jentic you install once, import AWS CodeStar Notifications from the API Directory, store the AWS access key and secret once, and your agent calls it.
- **Permission scoping:** CodeStar Notifications names the notification rule and its resource in the request body, not the URL path, so scoping is by operation. You limit the agent to the operations it needs, such as CreateNotificationRule or Subscribe, so DeleteNotificationRule or Unsubscribe are not included unless you add them.
- **Credential handling:** Your AWS access key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time when the request is signed. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a CodeStar notification rule' or 'subscribe a channel to pipeline failures', and Jentic returns the matching operation with its input schema, so the agent calls CreateNotificationRule or Subscribe directly without browsing AWS docs.

## Related APIs

- **AWS CodePipeline** — CodePipeline emits the execution and stage events that notification rules subscribe to
- **AWS CodeCommit** — CodeCommit emits pull request, commit, and approval events to notification rules
- **AWS CodeDeploy** — CodeDeploy emits deployment lifecycle events that notification rules surface to chat

## FAQ

### Why is there no official OpenAPI spec for AWS CodeStar Notifications?

AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AWS CodeStar Notifications via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the AWS CodeStar Notifications API use?

CodeStar Notifications uses AWS Signature Version 4 (HMAC) signed requests with an IAM access key and secret. Through Jentic, IAM credentials live encrypted in your Jentic One instance and the SigV4 signature is computed server-side, so the agent context never holds the raw secret.

### Can I send Developer Tools events to Slack with this API?

Yes. Configure an AWS Chatbot Slack channel in the AWS console, then call CreateNotificationRule with a Targets entry containing TargetType=AWSChatbotSlack and the chat configuration ARN as TargetAddress. Specify EventTypeIds from ListEventTypes for the events you want to deliver.

### How do I find the supported event type IDs for a CodeBuild project?

Call ListEventTypes with a Filter where Name=SERVICE_NAME and Value=codebuild. The response contains EventTypeId values such as codebuild-project-build-state-failed and codebuild-project-build-state-succeeded that you pass to CreateNotificationRule.

### What are the rate limits for the AWS CodeStar Notifications API?

AWS enforces per-account, per-region throttling on CodeStar Notifications; throttled requests return ThrottlingException. The AWS SDKs that Jentic wraps implement exponential backoff automatically.

### How do I wire up CodePipeline failure alerts through Jentic with an AI agent?

Run pip install jentic, then have the agent search for 'create a CodeStar notification rule', load the CreateNotificationRule schema, and execute it with the pipeline Resource ARN, the pipeline-execution-failed EventTypeIds, and a Target pointing to your SNS or AWS Chatbot Slack channel.

### Can I limit what my agent is allowed to do with the AWS CodeStar Notifications API?

Yes. Because CodeStar Notifications names the notification rule and its resource in the request body rather than the URL path, Jentic One scopes access by operation, and since Jentic One is self-hosted your own rules decide which operations the agent may call. You can allow it to run only what it needs, such as CreateNotificationRule and Subscribe, while leaving out DeleteNotificationRule and Unsubscribe. The AWS access key and secret stay in your instance and are injected only when a permitted request is signed, so the agent never handles the raw credential.
