@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPipesClient extends AmazonWebServiceClient implements AmazonPipes
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
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.
|
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
public static AmazonPipesClientBuilder builder()
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.
createPipe
in interface AmazonPipes
createPipeRequest
- 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.public DeletePipeResult deletePipe(DeletePipeRequest request)
Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
deletePipe
in interface AmazonPipes
deletePipeRequest
- 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.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.
describePipe
in interface AmazonPipes
describePipeRequest
- 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.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.
listPipes
in interface AmazonPipes
listPipesRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Displays the tags associated with a pipe.
listTagsForResource
in interface AmazonPipes
listTagsForResourceRequest
- 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.public StartPipeResult startPipe(StartPipeRequest request)
Start an existing pipe.
startPipe
in interface AmazonPipes
startPipeRequest
- 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.public StopPipeResult stopPipe(StopPipeRequest request)
Stop an existing pipe.
stopPipe
in interface AmazonPipes
stopPipeRequest
- 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.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.
tagResource
in interface AmazonPipes
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags from the specified pipes.
untagResource
in interface AmazonPipes
untagResourceRequest
- 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.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.
updatePipe
in interface AmazonPipes
updatePipeRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonPipes
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonPipes
shutdown
in class AmazonWebServiceClient