Package software.amazon.awssdk.services.pipes

Interface PipesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PipesClient
extends AwsClient

Service client for accessing Amazon EventBridge Pipes. This can be created using the static builder() method.

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 Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static PipesClientBuilder	builder()	Create a builder that can be used to configure and create a PipesClient.
static PipesClient	create()	Create a PipesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreatePipeResponse	createPipe(Consumer<CreatePipeRequest.Builder> createPipeRequest)	Create a pipe.
default CreatePipeResponse	createPipe(CreatePipeRequest createPipeRequest)	Create a pipe.
default DeletePipeResponse	deletePipe(Consumer<DeletePipeRequest.Builder> deletePipeRequest)	Delete an existing pipe.
default DeletePipeResponse	deletePipe(DeletePipeRequest deletePipeRequest)	Delete an existing pipe.
default DescribePipeResponse	describePipe(Consumer<DescribePipeRequest.Builder> describePipeRequest)	Get the information about an existing pipe.
default DescribePipeResponse	describePipe(DescribePipeRequest describePipeRequest)	Get the information about an existing pipe.
default ListPipesResponse	listPipes(Consumer<ListPipesRequest.Builder> listPipesRequest)	Get the pipes associated with this account.
default ListPipesResponse	listPipes(ListPipesRequest listPipesRequest)	Get the pipes associated with this account.
default ListPipesIterable	listPipesPaginator(Consumer<ListPipesRequest.Builder> listPipesRequest)	This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation.
default ListPipesIterable	listPipesPaginator(ListPipesRequest listPipesRequest)	This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Displays the tags associated with a pipe.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Displays the tags associated with a pipe.
default PipesServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartPipeResponse	startPipe(Consumer<StartPipeRequest.Builder> startPipeRequest)	Start an existing pipe.
default StartPipeResponse	startPipe(StartPipeRequest startPipeRequest)	Start an existing pipe.
default StopPipeResponse	stopPipe(Consumer<StopPipeRequest.Builder> stopPipeRequest)	Stop an existing pipe.
default StopPipeResponse	stopPipe(StopPipeRequest stopPipeRequest)	Stop an existing pipe.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified pipe.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified pipe.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from the specified pipes.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from the specified pipes.
default UpdatePipeResponse	updatePipe(Consumer<UpdatePipeRequest.Builder> updatePipeRequest)	Update an existing pipe.
default UpdatePipeResponse	updatePipe(UpdatePipeRequest updatePipeRequest)	Update an existing pipe.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createPipe

default CreatePipeResponse createPipe(CreatePipeRequest createPipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PipesException

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

Parameters:

createPipeRequest -

Returns:

Result of the CreatePipe operation returned by the service.

See Also:

• AWS API Documentation

createPipe

default CreatePipeResponse createPipe(Consumer<CreatePipeRequest.Builder> createPipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the CreatePipe operation returned by the service.

See Also:

• AWS API Documentation

deletePipe

default DeletePipeResponse deletePipe(DeletePipeRequest deletePipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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

Parameters:

deletePipeRequest -

Returns:

Result of the DeletePipe operation returned by the service.

See Also:

• AWS API Documentation

deletePipe

default DeletePipeResponse deletePipe(Consumer<DeletePipeRequest.Builder> deletePipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the DeletePipe operation returned by the service.

See Also:

• AWS API Documentation

describePipe

default DescribePipeResponse describePipe(DescribePipeRequest describePipeRequest)
                                   throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the DescribePipe operation returned by the service.

See Also:

• AWS API Documentation

describePipe

default DescribePipeResponse describePipe(Consumer<DescribePipeRequest.Builder> describePipeRequest)
                                   throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the DescribePipe operation returned by the service.

See Also:

• AWS API Documentation

listPipes

default ListPipesResponse listPipes(ListPipesRequest listPipesRequest)
                             throws InternalException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the ListPipes operation returned by the service.

See Also:

• AWS API Documentation

listPipes

default ListPipesResponse listPipes(Consumer<ListPipesRequest.Builder> listPipesRequest)
                             throws InternalException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the ListPipes operation returned by the service.

See Also:

• AWS API Documentation

listPipesPaginator

default ListPipesIterable listPipesPaginator(ListPipesRequest listPipesRequest)
                                      throws InternalException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PipesException

This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
     for (software.amazon.awssdk.services.pipes.model.ListPipesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listPipesPaginator

default ListPipesIterable listPipesPaginator(Consumer<ListPipesRequest.Builder> listPipesRequest)
                                      throws InternalException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
PipesException

This is a variant of listPipes(software.amazon.awssdk.services.pipes.model.ListPipesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
     for (software.amazon.awssdk.services.pipes.model.ListPipesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pipes.paginators.ListPipesIterable responses = client.listPipesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

Displays the tags associated with a pipe.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startPipe

default StartPipeResponse startPipe(StartPipeRequest startPipeRequest)
                             throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

Start an existing pipe.

Parameters:

startPipeRequest -

Returns:

Result of the StartPipe operation returned by the service.

See Also:

• AWS API Documentation

startPipe

default StartPipeResponse startPipe(Consumer<StartPipeRequest.Builder> startPipeRequest)
                             throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the StartPipe operation returned by the service.

See Also:

• AWS API Documentation

stopPipe

default StopPipeResponse stopPipe(StopPipeRequest stopPipeRequest)
                           throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

Stop an existing pipe.

Parameters:

stopPipeRequest -

Returns:

Result of the StopPipe operation returned by the service.

See Also:

• AWS API Documentation

stopPipe

default StopPipeResponse stopPipe(Consumer<StopPipeRequest.Builder> stopPipeRequest)
                           throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the StopPipe operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

Removes one or more tags from the specified pipes.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalException,
ValidationException,
NotFoundException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updatePipe

default UpdatePipeResponse updatePipe(UpdatePipeRequest updatePipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the UpdatePipe operation returned by the service.

See Also:

• AWS API Documentation

updatePipe

default UpdatePipeResponse updatePipe(Consumer<UpdatePipeRequest.Builder> updatePipeRequest)
                               throws InternalException,
ValidationException,
ThrottlingException,
NotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
PipesException

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:

Result of the UpdatePipe operation returned by the service.

See Also:

• AWS API Documentation

create

static PipesClient create()

Create a PipesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PipesClientBuilder builder()

Create a builder that can be used to configure and create a PipesClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

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