@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPipesAsyncClient extends AmazonPipesClient implements AmazonPipesAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createPipe, deletePipe, describePipe, getCachedResponseMetadata, listPipes, listTagsForResource, startPipe, stopPipe, tagResource, untagResource, updatePipe
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createPipe, deletePipe, describePipe, getCachedResponseMetadata, listPipes, listTagsForResource, startPipe, stopPipe, tagResource, untagResource, updatePipe
public static AmazonPipesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreatePipeResult> createPipeAsync(CreatePipeRequest request)
AmazonPipesAsync
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
createPipeAsync
in interface AmazonPipesAsync
public Future<CreatePipeResult> createPipeAsync(CreatePipeRequest request, AsyncHandler<CreatePipeRequest,CreatePipeResult> asyncHandler)
AmazonPipesAsync
Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.
createPipeAsync
in interface AmazonPipesAsync
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.public Future<DeletePipeResult> deletePipeAsync(DeletePipeRequest request)
AmazonPipesAsync
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipeAsync
in interface AmazonPipesAsync
public Future<DeletePipeResult> deletePipeAsync(DeletePipeRequest request, AsyncHandler<DeletePipeRequest,DeletePipeResult> asyncHandler)
AmazonPipesAsync
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipeAsync
in interface AmazonPipesAsync
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.public Future<DescribePipeResult> describePipeAsync(DescribePipeRequest request)
AmazonPipesAsync
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
describePipeAsync
in interface AmazonPipesAsync
public Future<DescribePipeResult> describePipeAsync(DescribePipeRequest request, AsyncHandler<DescribePipeRequest,DescribePipeResult> asyncHandler)
AmazonPipesAsync
Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
describePipeAsync
in interface AmazonPipesAsync
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.public Future<ListPipesResult> listPipesAsync(ListPipesRequest request)
AmazonPipesAsync
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
listPipesAsync
in interface AmazonPipesAsync
public Future<ListPipesResult> listPipesAsync(ListPipesRequest request, AsyncHandler<ListPipesRequest,ListPipesResult> asyncHandler)
AmazonPipesAsync
Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
listPipesAsync
in interface AmazonPipesAsync
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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonPipesAsync
Displays the tags associated with a pipe.
listTagsForResourceAsync
in interface AmazonPipesAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonPipesAsync
Displays the tags associated with a pipe.
listTagsForResourceAsync
in interface AmazonPipesAsync
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.public Future<StartPipeResult> startPipeAsync(StartPipeRequest request)
AmazonPipesAsync
Start an existing pipe.
startPipeAsync
in interface AmazonPipesAsync
public Future<StartPipeResult> startPipeAsync(StartPipeRequest request, AsyncHandler<StartPipeRequest,StartPipeResult> asyncHandler)
AmazonPipesAsync
Start an existing pipe.
startPipeAsync
in interface AmazonPipesAsync
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.public Future<StopPipeResult> stopPipeAsync(StopPipeRequest request)
AmazonPipesAsync
Stop an existing pipe.
stopPipeAsync
in interface AmazonPipesAsync
public Future<StopPipeResult> stopPipeAsync(StopPipeRequest request, AsyncHandler<StopPipeRequest,StopPipeResult> asyncHandler)
AmazonPipesAsync
Stop an existing pipe.
stopPipeAsync
in interface AmazonPipesAsync
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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonPipesAsync
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.
tagResourceAsync
in interface AmazonPipesAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonPipesAsync
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.
tagResourceAsync
in interface AmazonPipesAsync
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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonPipesAsync
Removes one or more tags from the specified pipes.
untagResourceAsync
in interface AmazonPipesAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonPipesAsync
Removes one or more tags from the specified pipes.
untagResourceAsync
in interface AmazonPipesAsync
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.public Future<UpdatePipeResult> updatePipeAsync(UpdatePipeRequest request)
AmazonPipesAsync
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.
updatePipeAsync
in interface AmazonPipesAsync
public Future<UpdatePipeResult> updatePipeAsync(UpdatePipeRequest request, AsyncHandler<UpdatePipeRequest,UpdatePipeResult> asyncHandler)
AmazonPipesAsync
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.
updatePipeAsync
in interface AmazonPipesAsync
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.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonPipes
shutdown
in class AmazonPipesClient