com.amazonaws.services.pipes

Class AmazonPipesClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pipes.AmazonPipesClient

All Implemented Interfaces:

AmazonPipes

Direct Known Subclasses:

AmazonPipesAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonPipesClient
extends AmazonWebServiceClient
implements AmazonPipes

Client for accessing Amazon EventBridge Pipes. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.pipes.AmazonPipes

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonPipesClientBuilder	builder()
CreatePipeResult	createPipe(CreatePipeRequest request) Create a pipe.
DeletePipeResult	deletePipe(DeletePipeRequest request) Delete an existing pipe.
DescribePipeResult	describePipe(DescribePipeRequest request) 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 request) Get the pipes associated with this account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Start an existing pipe.
StopPipeResult	stopPipe(StopPipeRequest request) Stop an existing pipe.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags (key-value pairs) to the specified pipe.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from the specified pipes.
UpdatePipeResult	updatePipe(UpdatePipeRequest request) Update an existing pipe.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonPipesClientBuilder builder()

createPipe

public CreatePipeResult createPipe(CreatePipeRequest request)

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

Specified by:

createPipe in interface AmazonPipes

Parameters:

createPipeRequest -

Returns:

Result of the CreatePipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deletePipe

public DeletePipeResult deletePipe(DeletePipeRequest request)

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

Specified by:

deletePipe in interface AmazonPipes

Parameters:

deletePipeRequest -

Returns:

Result of the DeletePipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describePipe

public DescribePipeResult describePipe(DescribePipeRequest request)

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

Specified by:

describePipe in interface AmazonPipes

Parameters:

describePipeRequest -

Returns:

Result of the DescribePipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPipes

public ListPipesResult listPipes(ListPipesRequest request)

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

Specified by:

listPipes in interface AmazonPipes

Parameters:

listPipesRequest -

Returns:

Result of the ListPipes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Displays the tags associated with a pipe.

Specified by:

listTagsForResource in interface AmazonPipes

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startPipe

public StartPipeResult startPipe(StartPipeRequest request)

Start an existing pipe.

Specified by:

startPipe in interface AmazonPipes

Parameters:

startPipeRequest -

Returns:

Result of the StartPipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopPipe

public StopPipeResult stopPipe(StopPipeRequest request)

Stop an existing pipe.

Specified by:

stopPipe in interface AmazonPipes

Parameters:

stopPipeRequest -

Returns:

Result of the StopPipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonPipes

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from the specified pipes.

Specified by:

untagResource in interface AmazonPipes

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updatePipe

public UpdatePipeResult updatePipe(UpdatePipeRequest request)

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.

Specified by:

updatePipe in interface AmazonPipes

Parameters:

updatePipeRequest -

Returns:

Result of the UpdatePipe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonPipes

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonPipes

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonPipes

Overrides:

shutdown in class AmazonWebServiceClient