@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPipes
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonPipes
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreatePipeResult |
createPipe(CreatePipeRequest createPipeRequest)
Create a pipe.
|
DeletePipeResult |
deletePipe(DeletePipeRequest deletePipeRequest)
Delete an existing pipe.
|
DescribePipeResult |
describePipe(DescribePipeRequest describePipeRequest)
Get the information about an existing pipe.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListPipesResult |
listPipes(ListPipesRequest listPipesRequest)
Get the pipes associated with this account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a pipe.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartPipeResult |
startPipe(StartPipeRequest startPipeRequest)
Start an existing pipe.
|
StopPipeResult |
stopPipe(StopPipeRequest stopPipeRequest)
Stop an existing pipe.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified pipe.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified pipes.
|
UpdatePipeResult |
updatePipe(UpdatePipeRequest updatePipeRequest)
Update an existing pipe.
|
static final String ENDPOINT_PREFIX
CreatePipeResult createPipe(CreatePipeRequest createPipeRequest)
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
createPipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ConflictException
- An action you attempted resulted in an exception.ServiceQuotaExceededException
- A quota has been exceeded.DeletePipeResult deletePipe(DeletePipeRequest deletePipeRequest)
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ConflictException
- An action you attempted resulted in an exception.DescribePipeResult describePipe(DescribePipeRequest describePipeRequest)
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
describePipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ListPipesResult listPipes(ListPipesRequest listPipesRequest)
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
listPipesRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a pipe.
listTagsForResourceRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.NotFoundException
- An entity that you specified does not exist.StartPipeResult startPipe(StartPipeRequest startPipeRequest)
Start an existing pipe.
startPipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ConflictException
- An action you attempted resulted in an exception.StopPipeResult stopPipe(StopPipeRequest stopPipeRequest)
Stop an existing pipe.
stopPipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ConflictException
- An action you attempted resulted in an exception.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.NotFoundException
- An entity that you specified does not exist.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified pipes.
untagResourceRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.NotFoundException
- An entity that you specified does not exist.UpdatePipeResult updatePipe(UpdatePipeRequest updatePipeRequest)
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.
updatePipeRequest
- InternalException
- This exception occurs due to unexpected causes.ValidationException
- Indicates that an error has occurred while performing a validate operation.ThrottlingException
- An action was throttled.NotFoundException
- An entity that you specified does not exist.ConflictException
- An action you attempted resulted in an exception.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.