Amazon Web Services, Inc.

Amazon CloudWatch Events

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send…

Developer tools#openapi#cloud

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

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your
resources change state, they automatically send events to an event stream. You can create
rules that match selected events in the stream and route them to targets to take action. You
can also use rules to take action on a predetermined schedule. For example, you can configure
rules to:

Automatically invoke an Lambda function to update DNS entries when an event
notifies you that Amazon EC2 instance enters the running state.

Direct specific API records from CloudTrail to an Amazon Kinesis data stream for
detailed analysis of potential security or availability risks.

Periodically invoke a built-in target to create a snapshot of an Amazon EBS
volume.

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User
Guide .

Endpoints 51

  • POSTActivate event source/#X-Amz-Target=AWSEvents.ActivateEventSourceActivates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
  • POSTCancel replay/#X-Amz-Target=AWSEvents.CancelReplayCancels the specified replay.
  • POSTCreate api destination/#X-Amz-Target=AWSEvents.CreateApiDestinationCreates an API destination, which is an HTTP invocation endpoint configured as a target for events.
  • POSTCreate archive/#X-Amz-Target=AWSEvents.CreateArchiveCreates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive.…
  • POSTCreate connection/#X-Amz-Target=AWSEvents.CreateConnectionCreates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
  • POSTCreate event bus/#X-Amz-Target=AWSEvents.CreateEventBusCreates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or…
  • POSTCreate partner event source/#X-Amz-Target=AWSEvents.CreatePartnerEventSourceCalled by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used…
  • POSTDeactivate event source/#X-Amz-Target=AWSEvents.DeactivateEventSourceYou can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you…
  • POSTDeauthorize connection/#X-Amz-Target=AWSEvents.DeauthorizeConnectionRemoves all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a…
  • POSTDelete api destination/#X-Amz-Target=AWSEvents.DeleteApiDestinationDeletes the specified API destination.
  • POSTDelete archive/#X-Amz-Target=AWSEvents.DeleteArchiveDeletes the specified archive.
  • POSTDelete connection/#X-Amz-Target=AWSEvents.DeleteConnectionDeletes a connection.
  • POSTDelete event bus/#X-Amz-Target=AWSEvents.DeleteEventBusDeletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's…
  • POSTDelete partner event source/#X-Amz-Target=AWSEvents.DeletePartnerEventSourceThis operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an…
  • POSTDelete rule/#X-Amz-Target=AWSEvents.DeleteRuleDeletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets . When you delete a rule, incoming events might…
  • POSTDescribe api destination/#X-Amz-Target=AWSEvents.DescribeApiDestinationRetrieves details about an API destination.
  • POSTDescribe archive/#X-Amz-Target=AWSEvents.DescribeArchiveRetrieves details about an archive.
  • POSTDescribe connection/#X-Amz-Target=AWSEvents.DescribeConnectionRetrieves details about a connection.
  • POSTDescribe event bus/#X-Amz-Target=AWSEvents.DescribeEventBusDisplays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your…
  • POSTDescribe event source/#X-Amz-Target=AWSEvents.DescribeEventSourceThis operation lists details about a partner event source that is shared with your account.
  • POSTDescribe partner event source/#X-Amz-Target=AWSEvents.DescribePartnerEventSourceAn SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this…
  • POSTDescribe replay/#X-Amz-Target=AWSEvents.DescribeReplayRetrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in…
  • POSTDescribe rule/#X-Amz-Target=AWSEvents.DescribeRuleDescribes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule .
  • POSTDisable rule/#X-Amz-Target=AWSEvents.DisableRuleDisables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming…
  • POSTEnable rule/#X-Amz-Target=AWSEvents.EnableRuleEnables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a…
  • POSTList api destinations/#X-Amz-Target=AWSEvents.ListApiDestinationsRetrieves a list of API destination in the account in the current Region.
  • POSTList archives/#X-Amz-Target=AWSEvents.ListArchivesLists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.
  • POSTList connections/#X-Amz-Target=AWSEvents.ListConnectionsRetrieves a list of connections from the account.
  • POSTList event buses/#X-Amz-Target=AWSEvents.ListEventBusesLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
  • POSTList event sources/#X-Amz-Target=AWSEvents.ListEventSourcesYou can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event…
  • POSTList partner event source accounts/#X-Amz-Target=AWSEvents.ListPartnerEventSourceAccountsAn SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This…
  • POSTList partner event sources/#X-Amz-Target=AWSEvents.ListPartnerEventSourcesAn SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services…
  • POSTList replays/#X-Amz-Target=AWSEvents.ListReplaysLists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.
  • POSTList rule names by target/#X-Amz-Target=AWSEvents.ListRuleNamesByTargetLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
  • POSTList rules/#X-Amz-Target=AWSEvents.ListRulesLists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the…
  • POSTList tags for resource/#X-Amz-Target=AWSEvents.ListTagsForResourceDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
  • POSTList targets by rule/#X-Amz-Target=AWSEvents.ListTargetsByRuleLists the targets assigned to the specified rule.
  • POSTPut events/#X-Amz-Target=AWSEvents.PutEventsSends custom events to Amazon EventBridge so that they can be matched to rules.
  • POSTPut partner events/#X-Amz-Target=AWSEvents.PutPartnerEventsThis is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
  • POSTPut permission/#X-Amz-Target=AWSEvents.PutPermissionRunning PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus . Amazon…
  • POSTPut rule/#X-Amz-Target=AWSEvents.PutRuleCreates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule . A single rule…
  • POSTPut targets/#X-Amz-Target=AWSEvents.PutTargetsAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are…
  • POSTRemove permission/#X-Amz-Target=AWSEvents.RemovePermissionRevokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the…
  • POSTRemove targets/#X-Amz-Target=AWSEvents.RemoveTargetsRemoves the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the…
  • POSTStart replay/#X-Amz-Target=AWSEvents.StartReplayStarts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to…
  • POSTTag resource/#X-Amz-Target=AWSEvents.TagResourceAssigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use…
  • POSTTest event pattern/#X-Amz-Target=AWSEvents.TestEventPatternTests whether the specified event pattern matches the provided event. Most services in Amazon Web Services treat : or / as the same character in Amazon…
  • POSTUntag resource/#X-Amz-Target=AWSEvents.UntagResourceRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
  • POSTUpdate api destination/#X-Amz-Target=AWSEvents.UpdateApiDestinationUpdates an API destination.
  • POSTUpdate archive/#X-Amz-Target=AWSEvents.UpdateArchiveUpdates the specified archive.
  • POSTUpdate connection/#X-Amz-Target=AWSEvents.UpdateConnectionUpdates settings for a connection.

API details

Base URL
https://events.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
51 operations on 51 pathsPOST 51
Description format
AWS Smithy model, API version 2015-10-07

How to test the Amazon CloudWatch Events in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CloudWatch Events collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Activate event source” (POST /#X-Amz-Target=AWSEvents.ActivateEventSource), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudWatch Events?

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send… It is listed under Developer tools and has 51 endpoints.

Who publishes the Amazon CloudWatch Events?

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 Amazon CloudWatch Events?

Requests go to https://events.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon CloudWatch Events?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon CloudWatch Events have?

51 operations on 51 paths (51 POST).

Is forking the Amazon CloudWatch Events free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.