View Source AWS.Pipes (aws-elixir v1.0.4)
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.
Link to this section Summary
Functions
Create a pipe.
Delete an existing pipe.
Get the information about an existing pipe.
Get the pipes associated with this account.
Displays the tags associated with a pipe.
Start an existing pipe.
Stop an existing pipe.
Assigns one or more tags (key-value pairs) to the specified pipe.
Removes one or more tags from the specified pipes.
Update an existing pipe.
Link to this section Functions
Create a pipe.
Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
Delete an existing pipe.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Get the information about an existing pipe.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
list_pipes(client, current_state \\ nil, desired_state \\ nil, limit \\ nil, name_prefix \\ nil, next_token \\ nil, source_prefix \\ nil, target_prefix \\ nil, options \\ [])
View SourceGet the pipes associated with this account.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
Displays the tags associated with a pipe.
Start an existing pipe.
Stop an existing pipe.
Assigns 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 user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource
action with a pipe that already has tags. If
you specify a new tag key, this tag is appended to the list of tags associated
with the
pipe. If you specify a tag key that is already associated with the pipe, the new
tag value
that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a pipe.
Removes one or more tags from the specified pipes.
Update an existing pipe.
When you call UpdatePipe
, EventBridge only the
updates fields you have specified in the request; the rest remain unchanged. The
exception
to this is if you modify any Amazon Web Services-service specific fields in the
SourceParameters
, EnrichmentParameters
, or
TargetParameters
objects. For example,
DynamoDBStreamParameters
or EventBridgeEventBusParameters
.
EventBridge updates the fields in these objects atomically as one and overrides
existing
values. This is by design, and means that if you don't specify an optional field
in one of
these Parameters
objects, EventBridge sets that field to its system-default
value during the update.
For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.