Interface PipesAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PipesAsyncClient extends AwsClient
Service client for accessing Amazon EventBridge Pipes asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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.

  • Field Details

  • Method Details

    • createPipe

      default CompletableFuture<CreatePipeResponse> createPipe(CreatePipeRequest createPipeRequest)

      Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

      Parameters:
      createPipeRequest -
      Returns:
      A Java Future containing the result of the CreatePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPipe

      default CompletableFuture<CreatePipeResponse> createPipe(Consumer<CreatePipeRequest.Builder> createPipeRequest)

      Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.


      This is a convenience which creates an instance of the CreatePipeRequest.Builder avoiding the need to create one manually via CreatePipeRequest.builder()

      Parameters:
      createPipeRequest - A Consumer that will call methods on CreatePipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipe

      default CompletableFuture<DeletePipeResponse> deletePipe(DeletePipeRequest deletePipeRequest)

      Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

      Parameters:
      deletePipeRequest -
      Returns:
      A Java Future containing the result of the DeletePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePipe

      default CompletableFuture<DeletePipeResponse> deletePipe(Consumer<DeletePipeRequest.Builder> deletePipeRequest)

      Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.


      This is a convenience which creates an instance of the DeletePipeRequest.Builder avoiding the need to create one manually via DeletePipeRequest.builder()

      Parameters:
      deletePipeRequest - A Consumer that will call methods on DeletePipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipe

      default CompletableFuture<DescribePipeResponse> 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.

      Parameters:
      describePipeRequest -
      Returns:
      A Java Future containing the result of the DescribePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePipe

      default CompletableFuture<DescribePipeResponse> describePipe(Consumer<DescribePipeRequest.Builder> describePipeRequest)

      Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.


      This is a convenience which creates an instance of the DescribePipeRequest.Builder avoiding the need to create one manually via DescribePipeRequest.builder()

      Parameters:
      describePipeRequest - A Consumer that will call methods on DescribePipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipes

      default CompletableFuture<ListPipesResponse> 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.

      Parameters:
      listPipesRequest -
      Returns:
      A Java Future containing the result of the ListPipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipes

      default CompletableFuture<ListPipesResponse> listPipes(Consumer<ListPipesRequest.Builder> listPipesRequest)

      Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.


      This is a convenience which creates an instance of the ListPipesRequest.Builder avoiding the need to create one manually via ListPipesRequest.builder()

      Parameters:
      listPipesRequest - A Consumer that will call methods on ListPipesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPipes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipesPaginator

      default ListPipesPublisher listPipesPaginator(ListPipesRequest listPipesRequest)

      This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.pipes.paginators.ListPipesPublisher publisher = client.listPipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pipes.paginators.ListPipesPublisher publisher = client.listPipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pipes.model.ListPipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pipes.model.ListPipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation.

      Parameters:
      listPipesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPipesPaginator

      default ListPipesPublisher listPipesPaginator(Consumer<ListPipesRequest.Builder> listPipesRequest)

      This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.pipes.paginators.ListPipesPublisher publisher = client.listPipesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pipes.paginators.ListPipesPublisher publisher = client.listPipesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pipes.model.ListPipesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pipes.model.ListPipesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation.


      This is a convenience which creates an instance of the ListPipesRequest.Builder avoiding the need to create one manually via ListPipesRequest.builder()

      Parameters:
      listPipesRequest - A Consumer that will call methods on ListPipesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Displays the tags associated with a pipe.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Displays the tags associated with a pipe.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipe

      default CompletableFuture<StartPipeResponse> startPipe(StartPipeRequest startPipeRequest)

      Start an existing pipe.

      Parameters:
      startPipeRequest -
      Returns:
      A Java Future containing the result of the StartPipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startPipe

      default CompletableFuture<StartPipeResponse> startPipe(Consumer<StartPipeRequest.Builder> startPipeRequest)

      Start an existing pipe.


      This is a convenience which creates an instance of the StartPipeRequest.Builder avoiding the need to create one manually via StartPipeRequest.builder()

      Parameters:
      startPipeRequest - A Consumer that will call methods on StartPipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartPipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipe

      default CompletableFuture<StopPipeResponse> stopPipe(StopPipeRequest stopPipeRequest)

      Stop an existing pipe.

      Parameters:
      stopPipeRequest -
      Returns:
      A Java Future containing the result of the StopPipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopPipe

      default CompletableFuture<StopPipeResponse> stopPipe(Consumer<StopPipeRequest.Builder> stopPipeRequest)

      Stop an existing pipe.


      This is a convenience which creates an instance of the StopPipeRequest.Builder avoiding the need to create one manually via StopPipeRequest.builder()

      Parameters:
      stopPipeRequest - A Consumer that will call methods on StopPipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopPipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> 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.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified pipes.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes one or more tags from the specified pipes.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipe

      default CompletableFuture<UpdatePipeResponse> 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.

      Parameters:
      updatePipeRequest -
      Returns:
      A Java Future containing the result of the UpdatePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePipe

      default CompletableFuture<UpdatePipeResponse> updatePipe(Consumer<UpdatePipeRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdatePipeRequest.Builder avoiding the need to create one manually via UpdatePipeRequest.builder()

      Parameters:
      updatePipeRequest - A Consumer that will call methods on UpdatePipeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePipe operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PipesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default PipesServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static PipesAsyncClient create()
      Create a PipesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PipesAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PipesAsyncClient.