@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPipesAsync extends AmazonPipes
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonPipesAsync
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.
ENDPOINT_PREFIX
createPipe, deletePipe, describePipe, getCachedResponseMetadata, listPipes, listTagsForResource, shutdown, startPipe, stopPipe, tagResource, untagResource, updatePipe
Future<CreatePipeResult> createPipeAsync(CreatePipeRequest createPipeRequest)
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
createPipeRequest
- Future<CreatePipeResult> createPipeAsync(CreatePipeRequest createPipeRequest, AsyncHandler<CreatePipeRequest,CreatePipeResult> asyncHandler)
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
createPipeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePipeResult> deletePipeAsync(DeletePipeRequest deletePipeRequest)
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipeRequest
- Future<DeletePipeResult> deletePipeAsync(DeletePipeRequest deletePipeRequest, AsyncHandler<DeletePipeRequest,DeletePipeResult> asyncHandler)
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePipeResult> describePipeAsync(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
- Future<DescribePipeResult> describePipeAsync(DescribePipeRequest describePipeRequest, AsyncHandler<DescribePipeRequest,DescribePipeResult> asyncHandler)
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
describePipeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPipesResult> listPipesAsync(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
- Future<ListPipesResult> listPipesAsync(ListPipesRequest listPipesRequest, AsyncHandler<ListPipesRequest,ListPipesResult> asyncHandler)
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
listPipesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a pipe.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Displays the tags associated with a pipe.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartPipeResult> startPipeAsync(StartPipeRequest startPipeRequest)
Start an existing pipe.
startPipeRequest
- Future<StartPipeResult> startPipeAsync(StartPipeRequest startPipeRequest, AsyncHandler<StartPipeRequest,StartPipeResult> asyncHandler)
Start an existing pipe.
startPipeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopPipeResult> stopPipeAsync(StopPipeRequest stopPipeRequest)
Stop an existing pipe.
stopPipeRequest
- Future<StopPipeResult> stopPipeAsync(StopPipeRequest stopPipeRequest, AsyncHandler<StopPipeRequest,StopPipeResult> asyncHandler)
Stop an existing pipe.
stopPipeRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(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
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified pipes.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from the specified pipes.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePipeResult> updatePipeAsync(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
- Future<UpdatePipeResult> updatePipeAsync(UpdatePipeRequest updatePipeRequest, AsyncHandler<UpdatePipeRequest,UpdatePipeResult> asyncHandler)
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
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.