Amazon Web Services, Inc.

Amazon EventBridge Pipes

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven…

Developer tools#openapi

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 Pipes connects event sources to targets. Pipes reduces the need
for specialized knowledge and integration code when developing event driven architectures.
This helps ensures consistency across your company’s applications. With Pipes, the target
can be any available EventBridge target. To set up a pipe, you select the event
source, add optional event filtering, define optional enrichment, and select the target for
the event data.

Endpoints 10

Pipe

  • GETDescribe pipe/v1/pipes/:NameGet the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
  • PUTUpdate pipe/v1/pipes/:NameUpdate an existing pipe. When you call UpdatePipe , EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The…
  • POSTCreate pipe/v1/pipes/:NameCreate a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
  • DELETEDelete pipe/v1/pipes/:NameDelete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
  • GETList pipes/v1/pipes?NamePrefix=string&DesiredState=string&CurrentState=string&SourcePrefix=string&TargetPrefix=string&NextToken=string&Limit=0Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
  • POSTStart pipe/v1/pipes/:Name/startStart an existing pipe.
  • POSTStop pipe/v1/pipes/:Name/stopStop an existing pipe.
  • GETList tags for resource/tags/:resourceArnDisplays the tags associated with a pipe.
  • POSTTag resource/tags/:resourceArnAssigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope…
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes one or more tags from the specified pipes.

API details

Base URL
https://pipes.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
10 operations on 5 pathsPOST 4GET 3DELETE 2PUT 1
Main resources
Pipe 7
Description format
AWS Smithy model, API version 2015-10-07

How to test the Amazon EventBridge Pipes 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 EventBridge Pipes 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 “Describe pipe” (GET /v1/pipes/:Name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon EventBridge Pipes?

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven… It is listed under Developer tools and has 10 endpoints.

Who publishes the Amazon EventBridge Pipes?

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 EventBridge Pipes?

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

How do I authenticate with the Amazon EventBridge Pipes?

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

How many endpoints does the Amazon EventBridge Pipes have?

10 operations on 5 paths (4 POST, 3 GET, 2 DELETE, 1 PUT). The largest groups are Pipe.

Is forking the Amazon EventBridge Pipes 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.