software.amazon.awssdk.services.eventbridge.EventBridgeClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.eventbridge;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.eventbridge.model.ActivateEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.ActivateEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.CancelReplayRequest;
import software.amazon.awssdk.services.eventbridge.model.CancelReplayResponse;
import software.amazon.awssdk.services.eventbridge.model.ConcurrentModificationException;
import software.amazon.awssdk.services.eventbridge.model.CreateApiDestinationRequest;
import software.amazon.awssdk.services.eventbridge.model.CreateApiDestinationResponse;
import software.amazon.awssdk.services.eventbridge.model.CreateArchiveRequest;
import software.amazon.awssdk.services.eventbridge.model.CreateArchiveResponse;
import software.amazon.awssdk.services.eventbridge.model.CreateConnectionRequest;
import software.amazon.awssdk.services.eventbridge.model.CreateConnectionResponse;
import software.amazon.awssdk.services.eventbridge.model.CreateEventBusRequest;
import software.amazon.awssdk.services.eventbridge.model.CreateEventBusResponse;
import software.amazon.awssdk.services.eventbridge.model.CreatePartnerEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.CreatePartnerEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.DeactivateEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.DeactivateEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.DeauthorizeConnectionRequest;
import software.amazon.awssdk.services.eventbridge.model.DeauthorizeConnectionResponse;
import software.amazon.awssdk.services.eventbridge.model.DeleteApiDestinationRequest;
import software.amazon.awssdk.services.eventbridge.model.DeleteApiDestinationResponse;
import software.amazon.awssdk.services.eventbridge.model.DeleteArchiveRequest;
import software.amazon.awssdk.services.eventbridge.model.DeleteArchiveResponse;
import software.amazon.awssdk.services.eventbridge.model.DeleteConnectionRequest;
import software.amazon.awssdk.services.eventbridge.model.DeleteConnectionResponse;
import software.amazon.awssdk.services.eventbridge.model.DeleteEventBusRequest;
import software.amazon.awssdk.services.eventbridge.model.DeleteEventBusResponse;
import software.amazon.awssdk.services.eventbridge.model.DeletePartnerEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.DeletePartnerEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.DeleteRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.DeleteRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeApiDestinationRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeApiDestinationResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeArchiveRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeArchiveResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeConnectionRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeConnectionResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeEventBusRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeEventBusResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribePartnerEventSourceRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribePartnerEventSourceResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeReplayRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeReplayResponse;
import software.amazon.awssdk.services.eventbridge.model.DescribeRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.DescribeRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.DisableRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.DisableRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.EnableRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.EnableRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.EventBridgeException;
import software.amazon.awssdk.services.eventbridge.model.IllegalStatusException;
import software.amazon.awssdk.services.eventbridge.model.InternalException;
import software.amazon.awssdk.services.eventbridge.model.InvalidEventPatternException;
import software.amazon.awssdk.services.eventbridge.model.InvalidStateException;
import software.amazon.awssdk.services.eventbridge.model.LimitExceededException;
import software.amazon.awssdk.services.eventbridge.model.ListApiDestinationsRequest;
import software.amazon.awssdk.services.eventbridge.model.ListApiDestinationsResponse;
import software.amazon.awssdk.services.eventbridge.model.ListArchivesRequest;
import software.amazon.awssdk.services.eventbridge.model.ListArchivesResponse;
import software.amazon.awssdk.services.eventbridge.model.ListConnectionsRequest;
import software.amazon.awssdk.services.eventbridge.model.ListConnectionsResponse;
import software.amazon.awssdk.services.eventbridge.model.ListEventBusesRequest;
import software.amazon.awssdk.services.eventbridge.model.ListEventBusesResponse;
import software.amazon.awssdk.services.eventbridge.model.ListEventSourcesRequest;
import software.amazon.awssdk.services.eventbridge.model.ListEventSourcesResponse;
import software.amazon.awssdk.services.eventbridge.model.ListPartnerEventSourceAccountsRequest;
import software.amazon.awssdk.services.eventbridge.model.ListPartnerEventSourceAccountsResponse;
import software.amazon.awssdk.services.eventbridge.model.ListPartnerEventSourcesRequest;
import software.amazon.awssdk.services.eventbridge.model.ListPartnerEventSourcesResponse;
import software.amazon.awssdk.services.eventbridge.model.ListReplaysRequest;
import software.amazon.awssdk.services.eventbridge.model.ListReplaysResponse;
import software.amazon.awssdk.services.eventbridge.model.ListRuleNamesByTargetRequest;
import software.amazon.awssdk.services.eventbridge.model.ListRuleNamesByTargetResponse;
import software.amazon.awssdk.services.eventbridge.model.ListRulesRequest;
import software.amazon.awssdk.services.eventbridge.model.ListRulesResponse;
import software.amazon.awssdk.services.eventbridge.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.eventbridge.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.eventbridge.model.ListTargetsByRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.ListTargetsByRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.ManagedRuleException;
import software.amazon.awssdk.services.eventbridge.model.OperationDisabledException;
import software.amazon.awssdk.services.eventbridge.model.PolicyLengthExceededException;
import software.amazon.awssdk.services.eventbridge.model.PutEventsRequest;
import software.amazon.awssdk.services.eventbridge.model.PutEventsResponse;
import software.amazon.awssdk.services.eventbridge.model.PutPartnerEventsRequest;
import software.amazon.awssdk.services.eventbridge.model.PutPartnerEventsResponse;
import software.amazon.awssdk.services.eventbridge.model.PutPermissionRequest;
import software.amazon.awssdk.services.eventbridge.model.PutPermissionResponse;
import software.amazon.awssdk.services.eventbridge.model.PutRuleRequest;
import software.amazon.awssdk.services.eventbridge.model.PutRuleResponse;
import software.amazon.awssdk.services.eventbridge.model.PutTargetsRequest;
import software.amazon.awssdk.services.eventbridge.model.PutTargetsResponse;
import software.amazon.awssdk.services.eventbridge.model.RemovePermissionRequest;
import software.amazon.awssdk.services.eventbridge.model.RemovePermissionResponse;
import software.amazon.awssdk.services.eventbridge.model.RemoveTargetsRequest;
import software.amazon.awssdk.services.eventbridge.model.RemoveTargetsResponse;
import software.amazon.awssdk.services.eventbridge.model.ResourceAlreadyExistsException;
import software.amazon.awssdk.services.eventbridge.model.ResourceNotFoundException;
import software.amazon.awssdk.services.eventbridge.model.StartReplayRequest;
import software.amazon.awssdk.services.eventbridge.model.StartReplayResponse;
import software.amazon.awssdk.services.eventbridge.model.TagResourceRequest;
import software.amazon.awssdk.services.eventbridge.model.TagResourceResponse;
import software.amazon.awssdk.services.eventbridge.model.TestEventPatternRequest;
import software.amazon.awssdk.services.eventbridge.model.TestEventPatternResponse;
import software.amazon.awssdk.services.eventbridge.model.UntagResourceRequest;
import software.amazon.awssdk.services.eventbridge.model.UntagResourceResponse;
import software.amazon.awssdk.services.eventbridge.model.UpdateApiDestinationRequest;
import software.amazon.awssdk.services.eventbridge.model.UpdateApiDestinationResponse;
import software.amazon.awssdk.services.eventbridge.model.UpdateArchiveRequest;
import software.amazon.awssdk.services.eventbridge.model.UpdateArchiveResponse;
import software.amazon.awssdk.services.eventbridge.model.UpdateConnectionRequest;
import software.amazon.awssdk.services.eventbridge.model.UpdateConnectionResponse;
/**
* Service client for accessing Amazon EventBridge. This can be created using the static {@link #builder()} method.
*
*
* Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state,
* they automatically send events into an event stream. You can create rules that match selected events in the stream
* and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For
* example, you can configure rules to:
*
*
* -
*
* Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance
* enters the running state.
*
*
* -
*
* Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential
* security or availability risks.
*
*
* -
*
* Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
*
*
*
*
* For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface EventBridgeClient extends SdkClient {
String SERVICE_NAME = "events";
/**
* Create a {@link EventBridgeClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static EventBridgeClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link EventBridgeClient}.
*/
static EventBridgeClientBuilder builder() {
return new DefaultEventBridgeClientBuilder();
}
/**
*
* Activates a partner event source that has been deactivated. Once activated, your matching event bus will start
* receiving events from the event source.
*
*
* @param activateEventSourceRequest
* @return Result of the ActivateEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ActivateEventSource
* @see AWS API Documentation
*/
default ActivateEventSourceResponse activateEventSource(ActivateEventSourceRequest activateEventSourceRequest)
throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Activates a partner event source that has been deactivated. Once activated, your matching event bus will start
* receiving events from the event source.
*
*
*
* This is a convenience which creates an instance of the {@link ActivateEventSourceRequest.Builder} avoiding the
* need to create one manually via {@link ActivateEventSourceRequest#builder()}
*
*
* @param activateEventSourceRequest
* A {@link Consumer} that will call methods on {@link ActivateEventSourceRequest.Builder} to create a
* request.
* @return Result of the ActivateEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ActivateEventSource
* @see AWS API Documentation
*/
default ActivateEventSourceResponse activateEventSource(
Consumer activateEventSourceRequest) throws ResourceNotFoundException,
ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
return activateEventSource(ActivateEventSourceRequest.builder().applyMutation(activateEventSourceRequest).build());
}
/**
*
* Cancels the specified replay.
*
*
* @param cancelReplayRequest
* @return Result of the CancelReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws IllegalStatusException
* An error occurred because a replay can be canceled only when the state is Running or Starting.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CancelReplay
* @see AWS API
* Documentation
*/
default CancelReplayResponse cancelReplay(CancelReplayRequest cancelReplayRequest) throws ResourceNotFoundException,
ConcurrentModificationException, IllegalStatusException, InternalException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Cancels the specified replay.
*
*
*
* This is a convenience which creates an instance of the {@link CancelReplayRequest.Builder} avoiding the need to
* create one manually via {@link CancelReplayRequest#builder()}
*
*
* @param cancelReplayRequest
* A {@link Consumer} that will call methods on {@link CancelReplayRequest.Builder} to create a request.
* @return Result of the CancelReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws IllegalStatusException
* An error occurred because a replay can be canceled only when the state is Running or Starting.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CancelReplay
* @see AWS API
* Documentation
*/
default CancelReplayResponse cancelReplay(Consumer cancelReplayRequest)
throws ResourceNotFoundException, ConcurrentModificationException, IllegalStatusException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return cancelReplay(CancelReplayRequest.builder().applyMutation(cancelReplayRequest).build());
}
/**
*
* Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
*
*
* @param createApiDestinationRequest
* @return Result of the CreateApiDestination operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateApiDestination
* @see AWS API Documentation
*/
default CreateApiDestinationResponse createApiDestination(CreateApiDestinationRequest createApiDestinationRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
*
*
*
* This is a convenience which creates an instance of the {@link CreateApiDestinationRequest.Builder} avoiding the
* need to create one manually via {@link CreateApiDestinationRequest#builder()}
*
*
* @param createApiDestinationRequest
* A {@link Consumer} that will call methods on {@link CreateApiDestinationRequest.Builder} to create a
* request.
* @return Result of the CreateApiDestination operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateApiDestination
* @see AWS API Documentation
*/
default CreateApiDestinationResponse createApiDestination(
Consumer createApiDestinationRequest) throws ResourceAlreadyExistsException,
ResourceNotFoundException, LimitExceededException, InternalException, AwsServiceException, SdkClientException,
EventBridgeException {
return createApiDestination(CreateApiDestinationRequest.builder().applyMutation(createApiDestinationRequest).build());
}
/**
*
* Creates an archive of events with the specified settings. When you create an archive, incoming events might not
* immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do
* not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed
* events. Replayed events are not sent to an archive.
*
*
* @param createArchiveRequest
* @return Result of the CreateArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateArchive
* @see AWS API
* Documentation
*/
default CreateArchiveResponse createArchive(CreateArchiveRequest createArchiveRequest)
throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException,
LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Creates an archive of events with the specified settings. When you create an archive, incoming events might not
* immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do
* not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed
* events. Replayed events are not sent to an archive.
*
*
*
* This is a convenience which creates an instance of the {@link CreateArchiveRequest.Builder} avoiding the need to
* create one manually via {@link CreateArchiveRequest#builder()}
*
*
* @param createArchiveRequest
* A {@link Consumer} that will call methods on {@link CreateArchiveRequest.Builder} to create a request.
* @return Result of the CreateArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateArchive
* @see AWS API
* Documentation
*/
default CreateArchiveResponse createArchive(Consumer createArchiveRequest)
throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException,
LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException {
return createArchive(CreateArchiveRequest.builder().applyMutation(createArchiveRequest).build());
}
/**
*
* Creates a connection. A connection defines the authorization type and credentials to use for authorization with
* an API destination HTTP endpoint.
*
*
* @param createConnectionRequest
* @return Result of the CreateConnection operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateConnection
* @see AWS
* API Documentation
*/
default CreateConnectionResponse createConnection(CreateConnectionRequest createConnectionRequest)
throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a connection. A connection defines the authorization type and credentials to use for authorization with
* an API destination HTTP endpoint.
*
*
*
* This is a convenience which creates an instance of the {@link CreateConnectionRequest.Builder} avoiding the need
* to create one manually via {@link CreateConnectionRequest#builder()}
*
*
* @param createConnectionRequest
* A {@link Consumer} that will call methods on {@link CreateConnectionRequest.Builder} to create a request.
* @return Result of the CreateConnection operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateConnection
* @see AWS
* API Documentation
*/
default CreateConnectionResponse createConnection(Consumer createConnectionRequest)
throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
return createConnection(CreateConnectionRequest.builder().applyMutation(createConnectionRequest).build());
}
/**
*
* Creates a new event bus within your account. This can be a custom event bus which you can use to receive events
* from your custom applications and services, or it can be a partner event bus which can be matched to a partner
* event source.
*
*
* @param createEventBusRequest
* @return Result of the CreateEventBus operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateEventBus
* @see AWS API
* Documentation
*/
default CreateEventBusResponse createEventBus(CreateEventBusRequest createEventBusRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException,
ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new event bus within your account. This can be a custom event bus which you can use to receive events
* from your custom applications and services, or it can be a partner event bus which can be matched to a partner
* event source.
*
*
*
* This is a convenience which creates an instance of the {@link CreateEventBusRequest.Builder} avoiding the need to
* create one manually via {@link CreateEventBusRequest#builder()}
*
*
* @param createEventBusRequest
* A {@link Consumer} that will call methods on {@link CreateEventBusRequest.Builder} to create a request.
* @return Result of the CreateEventBus operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreateEventBus
* @see AWS API
* Documentation
*/
default CreateEventBusResponse createEventBus(Consumer createEventBusRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException,
ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException,
SdkClientException, EventBridgeException {
return createEventBus(CreateEventBusRequest.builder().applyMutation(createEventBusRequest).build());
}
/**
*
* Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
*
*
* Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS
* account. A SaaS partner must create one partner event source for each AWS account that wants to receive those
* event types.
*
*
* A partner event source creates events based on resources within the SaaS partner's service or application.
*
*
* An AWS account that creates a partner event bus that matches the partner event source can use that event bus to
* receive events from the partner, and then process them using AWS Events rules and targets.
*
*
* Partner event source names follow this format:
*
*
* partner_name/event_namespace/event_name
*
*
* partner_name is determined during partner registration and identifies the partner to AWS customers.
* event_namespace is determined by the partner and is a way for the partner to categorize their events.
* event_name is determined by the partner, and should uniquely identify an event-generating resource within
* the partner system. The combination of event_namespace and event_name should help AWS customers
* decide whether to create an event bus to receive these events.
*
*
* @param createPartnerEventSourceRequest
* @return Result of the CreatePartnerEventSource operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreatePartnerEventSource
* @see AWS API Documentation
*/
default CreatePartnerEventSourceResponse createPartnerEventSource(
CreatePartnerEventSourceRequest createPartnerEventSourceRequest) throws ResourceAlreadyExistsException,
InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
*
*
* Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS
* account. A SaaS partner must create one partner event source for each AWS account that wants to receive those
* event types.
*
*
* A partner event source creates events based on resources within the SaaS partner's service or application.
*
*
* An AWS account that creates a partner event bus that matches the partner event source can use that event bus to
* receive events from the partner, and then process them using AWS Events rules and targets.
*
*
* Partner event source names follow this format:
*
*
* partner_name/event_namespace/event_name
*
*
* partner_name is determined during partner registration and identifies the partner to AWS customers.
* event_namespace is determined by the partner and is a way for the partner to categorize their events.
* event_name is determined by the partner, and should uniquely identify an event-generating resource within
* the partner system. The combination of event_namespace and event_name should help AWS customers
* decide whether to create an event bus to receive these events.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePartnerEventSourceRequest.Builder} avoiding
* the need to create one manually via {@link CreatePartnerEventSourceRequest#builder()}
*
*
* @param createPartnerEventSourceRequest
* A {@link Consumer} that will call methods on {@link CreatePartnerEventSourceRequest.Builder} to create a
* request.
* @return Result of the CreatePartnerEventSource operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.CreatePartnerEventSource
* @see AWS API Documentation
*/
default CreatePartnerEventSourceResponse createPartnerEventSource(
Consumer createPartnerEventSourceRequest)
throws ResourceAlreadyExistsException, InternalException, ConcurrentModificationException, LimitExceededException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return createPartnerEventSource(CreatePartnerEventSourceRequest.builder().applyMutation(createPartnerEventSourceRequest)
.build());
}
/**
*
* You can use this operation to temporarily stop receiving events from the specified partner event source. The
* matching event bus is not deleted.
*
*
* When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state
* for more than two weeks, it is deleted.
*
*
* To activate a deactivated partner event source, use ActivateEventSource.
*
*
* @param deactivateEventSourceRequest
* @return Result of the DeactivateEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeactivateEventSource
* @see AWS API Documentation
*/
default DeactivateEventSourceResponse deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest)
throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* You can use this operation to temporarily stop receiving events from the specified partner event source. The
* matching event bus is not deleted.
*
*
* When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state
* for more than two weeks, it is deleted.
*
*
* To activate a deactivated partner event source, use ActivateEventSource.
*
*
*
* This is a convenience which creates an instance of the {@link DeactivateEventSourceRequest.Builder} avoiding the
* need to create one manually via {@link DeactivateEventSourceRequest#builder()}
*
*
* @param deactivateEventSourceRequest
* A {@link Consumer} that will call methods on {@link DeactivateEventSourceRequest.Builder} to create a
* request.
* @return Result of the DeactivateEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InvalidStateException
* The specified state is not a valid state for an event source.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeactivateEventSource
* @see AWS API Documentation
*/
default DeactivateEventSourceResponse deactivateEventSource(
Consumer deactivateEventSourceRequest) throws ResourceNotFoundException,
ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
return deactivateEventSource(DeactivateEventSourceRequest.builder().applyMutation(deactivateEventSourceRequest).build());
}
/**
*
* Removes all authorization parameters from the connection. This lets you remove the secret from the connection so
* you can reuse it without having to create a new connection.
*
*
* @param deauthorizeConnectionRequest
* @return Result of the DeauthorizeConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeauthorizeConnection
* @see AWS API Documentation
*/
default DeauthorizeConnectionResponse deauthorizeConnection(DeauthorizeConnectionRequest deauthorizeConnectionRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Removes all authorization parameters from the connection. This lets you remove the secret from the connection so
* you can reuse it without having to create a new connection.
*
*
*
* This is a convenience which creates an instance of the {@link DeauthorizeConnectionRequest.Builder} avoiding the
* need to create one manually via {@link DeauthorizeConnectionRequest#builder()}
*
*
* @param deauthorizeConnectionRequest
* A {@link Consumer} that will call methods on {@link DeauthorizeConnectionRequest.Builder} to create a
* request.
* @return Result of the DeauthorizeConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeauthorizeConnection
* @see AWS API Documentation
*/
default DeauthorizeConnectionResponse deauthorizeConnection(
Consumer deauthorizeConnectionRequest) throws ConcurrentModificationException,
ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return deauthorizeConnection(DeauthorizeConnectionRequest.builder().applyMutation(deauthorizeConnectionRequest).build());
}
/**
*
* Deletes the specified API destination.
*
*
* @param deleteApiDestinationRequest
* @return Result of the DeleteApiDestination operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteApiDestination
* @see AWS API Documentation
*/
default DeleteApiDestinationResponse deleteApiDestination(DeleteApiDestinationRequest deleteApiDestinationRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified API destination.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteApiDestinationRequest.Builder} avoiding the
* need to create one manually via {@link DeleteApiDestinationRequest#builder()}
*
*
* @param deleteApiDestinationRequest
* A {@link Consumer} that will call methods on {@link DeleteApiDestinationRequest.Builder} to create a
* request.
* @return Result of the DeleteApiDestination operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteApiDestination
* @see AWS API Documentation
*/
default DeleteApiDestinationResponse deleteApiDestination(
Consumer deleteApiDestinationRequest) throws ConcurrentModificationException,
ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return deleteApiDestination(DeleteApiDestinationRequest.builder().applyMutation(deleteApiDestinationRequest).build());
}
/**
*
* Deletes the specified archive.
*
*
* @param deleteArchiveRequest
* @return Result of the DeleteArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteArchive
* @see AWS API
* Documentation
*/
default DeleteArchiveResponse deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified archive.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteArchiveRequest.Builder} avoiding the need to
* create one manually via {@link DeleteArchiveRequest#builder()}
*
*
* @param deleteArchiveRequest
* A {@link Consumer} that will call methods on {@link DeleteArchiveRequest.Builder} to create a request.
* @return Result of the DeleteArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteArchive
* @see AWS API
* Documentation
*/
default DeleteArchiveResponse deleteArchive(Consumer deleteArchiveRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
return deleteArchive(DeleteArchiveRequest.builder().applyMutation(deleteArchiveRequest).build());
}
/**
*
* Deletes a connection.
*
*
* @param deleteConnectionRequest
* @return Result of the DeleteConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteConnection
* @see AWS
* API Documentation
*/
default DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a connection.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteConnectionRequest.Builder} avoiding the need
* to create one manually via {@link DeleteConnectionRequest#builder()}
*
*
* @param deleteConnectionRequest
* A {@link Consumer} that will call methods on {@link DeleteConnectionRequest.Builder} to create a request.
* @return Result of the DeleteConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteConnection
* @see AWS
* API Documentation
*/
default DeleteConnectionResponse deleteConnection(Consumer deleteConnectionRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
return deleteConnection(DeleteConnectionRequest.builder().applyMutation(deleteConnectionRequest).build());
}
/**
*
* Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be
* deleted. You can't delete your account's default event bus.
*
*
* @param deleteEventBusRequest
* @return Result of the DeleteEventBus operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteEventBus
* @see AWS API
* Documentation
*/
default DeleteEventBusResponse deleteEventBus(DeleteEventBusRequest deleteEventBusRequest) throws InternalException,
ConcurrentModificationException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be
* deleted. You can't delete your account's default event bus.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEventBusRequest.Builder} avoiding the need to
* create one manually via {@link DeleteEventBusRequest#builder()}
*
*
* @param deleteEventBusRequest
* A {@link Consumer} that will call methods on {@link DeleteEventBusRequest.Builder} to create a request.
* @return Result of the DeleteEventBus operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteEventBus
* @see AWS API
* Documentation
*/
default DeleteEventBusResponse deleteEventBus(Consumer deleteEventBusRequest)
throws InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException,
EventBridgeException {
return deleteEventBus(DeleteEventBusRequest.builder().applyMutation(deleteEventBusRequest).build());
}
/**
*
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS
* customers.
*
*
* When you delete an event source, the status of the corresponding partner event bus in the AWS customer account
* becomes DELETED.
*
*
*
* @param deletePartnerEventSourceRequest
* @return Result of the DeletePartnerEventSource operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeletePartnerEventSource
* @see AWS API Documentation
*/
default DeletePartnerEventSourceResponse deletePartnerEventSource(
DeletePartnerEventSourceRequest deletePartnerEventSourceRequest) throws InternalException,
ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS
* customers.
*
*
* When you delete an event source, the status of the corresponding partner event bus in the AWS customer account
* becomes DELETED.
*
*
*
*
* This is a convenience which creates an instance of the {@link DeletePartnerEventSourceRequest.Builder} avoiding
* the need to create one manually via {@link DeletePartnerEventSourceRequest#builder()}
*
*
* @param deletePartnerEventSourceRequest
* A {@link Consumer} that will call methods on {@link DeletePartnerEventSourceRequest.Builder} to create a
* request.
* @return Result of the DeletePartnerEventSource operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeletePartnerEventSource
* @see AWS API Documentation
*/
default DeletePartnerEventSourceResponse deletePartnerEventSource(
Consumer deletePartnerEventSourceRequest) throws InternalException,
ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException,
EventBridgeException {
return deletePartnerEventSource(DeletePartnerEventSourceRequest.builder().applyMutation(deletePartnerEventSourceRequest)
.build());
}
/**
*
* Deletes the specified rule.
*
*
* Before you can delete the rule, you must remove all targets, using RemoveTargets.
*
*
* When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time
* for changes to take effect.
*
*
* Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
* those other AWS services to support functionality in those services. You can delete these rules using the
* Force option, but you should do so only if you are sure the other service is not still using that
* rule.
*
*
* @param deleteRuleRequest
* @return Result of the DeleteRule operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteRule
* @see AWS API
* Documentation
*/
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws ConcurrentModificationException,
ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified rule.
*
*
* Before you can delete the rule, you must remove all targets, using RemoveTargets.
*
*
* When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time
* for changes to take effect.
*
*
* Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
* those other AWS services to support functionality in those services. You can delete these rules using the
* Force option, but you should do so only if you are sure the other service is not still using that
* rule.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRuleRequest.Builder} avoiding the need to
* create one manually via {@link DeleteRuleRequest#builder()}
*
*
* @param deleteRuleRequest
* A {@link Consumer} that will call methods on {@link DeleteRuleRequest.Builder} to create a request.
* @return Result of the DeleteRule operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DeleteRule
* @see AWS API
* Documentation
*/
default DeleteRuleResponse deleteRule(Consumer deleteRuleRequest)
throws ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException,
AwsServiceException, SdkClientException, EventBridgeException {
return deleteRule(DeleteRuleRequest.builder().applyMutation(deleteRuleRequest).build());
}
/**
*
* Retrieves details about an API destination.
*
*
* @param describeApiDestinationRequest
* @return Result of the DescribeApiDestination operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeApiDestination
* @see AWS API Documentation
*/
default DescribeApiDestinationResponse describeApiDestination(DescribeApiDestinationRequest describeApiDestinationRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves details about an API destination.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeApiDestinationRequest.Builder} avoiding the
* need to create one manually via {@link DescribeApiDestinationRequest#builder()}
*
*
* @param describeApiDestinationRequest
* A {@link Consumer} that will call methods on {@link DescribeApiDestinationRequest.Builder} to create a
* request.
* @return Result of the DescribeApiDestination operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeApiDestination
* @see AWS API Documentation
*/
default DescribeApiDestinationResponse describeApiDestination(
Consumer describeApiDestinationRequest) throws ResourceNotFoundException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return describeApiDestination(DescribeApiDestinationRequest.builder().applyMutation(describeApiDestinationRequest)
.build());
}
/**
*
* Retrieves details about an archive.
*
*
* @param describeArchiveRequest
* @return Result of the DescribeArchive operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeArchive
* @see AWS
* API Documentation
*/
default DescribeArchiveResponse describeArchive(DescribeArchiveRequest describeArchiveRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves details about an archive.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeArchiveRequest.Builder} avoiding the need
* to create one manually via {@link DescribeArchiveRequest#builder()}
*
*
* @param describeArchiveRequest
* A {@link Consumer} that will call methods on {@link DescribeArchiveRequest.Builder} to create a request.
* @return Result of the DescribeArchive operation returned by the service.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeArchive
* @see AWS
* API Documentation
*/
default DescribeArchiveResponse describeArchive(Consumer describeArchiveRequest)
throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
return describeArchive(DescribeArchiveRequest.builder().applyMutation(describeArchiveRequest).build());
}
/**
*
* Retrieves details about a connection.
*
*
* @param describeConnectionRequest
* @return Result of the DescribeConnection operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeConnection
* @see AWS
* API Documentation
*/
default DescribeConnectionResponse describeConnection(DescribeConnectionRequest describeConnectionRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves details about a connection.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConnectionRequest.Builder} avoiding the
* need to create one manually via {@link DescribeConnectionRequest#builder()}
*
*
* @param describeConnectionRequest
* A {@link Consumer} that will call methods on {@link DescribeConnectionRequest.Builder} to create a
* request.
* @return Result of the DescribeConnection operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeConnection
* @see AWS
* API Documentation
*/
default DescribeConnectionResponse describeConnection(Consumer describeConnectionRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return describeConnection(DescribeConnectionRequest.builder().applyMutation(describeConnectionRequest).build());
}
/**
*
* Displays details about an event bus in your account. This can include the external AWS accounts that are
* permitted to write events to your default event bus, and the associated policy. For custom event buses and
* partner event buses, it displays the name, ARN, policy, state, and creation time.
*
*
* To enable your account to receive events from other accounts on its default event bus, use PutPermission.
*
*
* For more information about partner event buses, see CreateEventBus.
*
*
* @param describeEventBusRequest
* @return Result of the DescribeEventBus operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeEventBus
* @see AWS
* API Documentation
*/
default DescribeEventBusResponse describeEventBus(DescribeEventBusRequest describeEventBusRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Displays details about an event bus in your account. This can include the external AWS accounts that are
* permitted to write events to your default event bus, and the associated policy. For custom event buses and
* partner event buses, it displays the name, ARN, policy, state, and creation time.
*
*
* To enable your account to receive events from other accounts on its default event bus, use PutPermission.
*
*
* For more information about partner event buses, see CreateEventBus.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEventBusRequest.Builder} avoiding the need
* to create one manually via {@link DescribeEventBusRequest#builder()}
*
*
* @param describeEventBusRequest
* A {@link Consumer} that will call methods on {@link DescribeEventBusRequest.Builder} to create a request.
* @return Result of the DescribeEventBus operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeEventBus
* @see AWS
* API Documentation
*/
default DescribeEventBusResponse describeEventBus(Consumer describeEventBusRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return describeEventBus(DescribeEventBusRequest.builder().applyMutation(describeEventBusRequest).build());
}
/**
*
* This operation lists details about a partner event source that is shared with your account.
*
*
* @param describeEventSourceRequest
* @return Result of the DescribeEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeEventSource
* @see AWS API Documentation
*/
default DescribeEventSourceResponse describeEventSource(DescribeEventSourceRequest describeEventSourceRequest)
throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* This operation lists details about a partner event source that is shared with your account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeEventSourceRequest.Builder} avoiding the
* need to create one manually via {@link DescribeEventSourceRequest#builder()}
*
*
* @param describeEventSourceRequest
* A {@link Consumer} that will call methods on {@link DescribeEventSourceRequest.Builder} to create a
* request.
* @return Result of the DescribeEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeEventSource
* @see AWS API Documentation
*/
default DescribeEventSourceResponse describeEventSource(
Consumer describeEventSourceRequest) throws ResourceNotFoundException,
InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return describeEventSource(DescribeEventSourceRequest.builder().applyMutation(describeEventSourceRequest).build());
}
/**
*
* An SaaS partner can use this operation to list details about a partner event source that they have created. AWS
* customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details
* about a partner event source that is shared with them.
*
*
* @param describePartnerEventSourceRequest
* @return Result of the DescribePartnerEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribePartnerEventSource
* @see AWS API Documentation
*/
default DescribePartnerEventSourceResponse describePartnerEventSource(
DescribePartnerEventSourceRequest describePartnerEventSourceRequest) throws ResourceNotFoundException,
InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* An SaaS partner can use this operation to list details about a partner event source that they have created. AWS
* customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details
* about a partner event source that is shared with them.
*
*
*
* This is a convenience which creates an instance of the {@link DescribePartnerEventSourceRequest.Builder} avoiding
* the need to create one manually via {@link DescribePartnerEventSourceRequest#builder()}
*
*
* @param describePartnerEventSourceRequest
* A {@link Consumer} that will call methods on {@link DescribePartnerEventSourceRequest.Builder} to create a
* request.
* @return Result of the DescribePartnerEventSource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribePartnerEventSource
* @see AWS API Documentation
*/
default DescribePartnerEventSourceResponse describePartnerEventSource(
Consumer describePartnerEventSourceRequest)
throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException,
SdkClientException, EventBridgeException {
return describePartnerEventSource(DescribePartnerEventSourceRequest.builder()
.applyMutation(describePartnerEventSourceRequest).build());
}
/**
*
* Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay.
* A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If
* you use StartReplay and specify an EventStartTime and an EventEndTime that
* covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then
* the events from the second minute are replayed. You can use DescribeReplay to determine the progress
* of a replay. The value returned for EventLastReplayedTime indicates the time within the specified
* time range associated with the last event replayed.
*
*
* @param describeReplayRequest
* @return Result of the DescribeReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeReplay
* @see AWS API
* Documentation
*/
default DescribeReplayResponse describeReplay(DescribeReplayRequest describeReplayRequest) throws ResourceNotFoundException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay.
* A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If
* you use StartReplay and specify an EventStartTime and an EventEndTime that
* covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then
* the events from the second minute are replayed. You can use DescribeReplay to determine the progress
* of a replay. The value returned for EventLastReplayedTime indicates the time within the specified
* time range associated with the last event replayed.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReplayRequest.Builder} avoiding the need to
* create one manually via {@link DescribeReplayRequest#builder()}
*
*
* @param describeReplayRequest
* A {@link Consumer} that will call methods on {@link DescribeReplayRequest.Builder} to create a request.
* @return Result of the DescribeReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeReplay
* @see AWS API
* Documentation
*/
default DescribeReplayResponse describeReplay(Consumer describeReplayRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return describeReplay(DescribeReplayRequest.builder().applyMutation(describeReplayRequest).build());
}
/**
*
* Describes the specified rule.
*
*
* DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use
* ListTargetsByRule.
*
*
* @param describeRuleRequest
* @return Result of the DescribeRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeRule
* @see AWS API
* Documentation
*/
default DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest) throws ResourceNotFoundException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Describes the specified rule.
*
*
* DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use
* ListTargetsByRule.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRuleRequest.Builder} avoiding the need to
* create one manually via {@link DescribeRuleRequest#builder()}
*
*
* @param describeRuleRequest
* A {@link Consumer} that will call methods on {@link DescribeRuleRequest.Builder} to create a request.
* @return Result of the DescribeRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DescribeRule
* @see AWS API
* Documentation
*/
default DescribeRuleResponse describeRule(Consumer describeRuleRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return describeRule(DescribeRuleRequest.builder().applyMutation(describeRuleRequest).build());
}
/**
*
* Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule
* expression.
*
*
* When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of
* time for changes to take effect.
*
*
* @param disableRuleRequest
* @return Result of the DisableRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DisableRule
* @see AWS API
* Documentation
*/
default DisableRuleResponse disableRule(DisableRuleRequest disableRuleRequest) throws ResourceNotFoundException,
ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule
* expression.
*
*
* When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of
* time for changes to take effect.
*
*
*
* This is a convenience which creates an instance of the {@link DisableRuleRequest.Builder} avoiding the need to
* create one manually via {@link DisableRuleRequest#builder()}
*
*
* @param disableRuleRequest
* A {@link Consumer} that will call methods on {@link DisableRuleRequest.Builder} to create a request.
* @return Result of the DisableRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.DisableRule
* @see AWS API
* Documentation
*/
default DisableRuleResponse disableRule(Consumer disableRuleRequest)
throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return disableRule(DisableRuleRequest.builder().applyMutation(disableRuleRequest).build());
}
/**
*
* Enables the specified rule. If the rule does not exist, the operation fails.
*
*
* When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a
* short period of time for changes to take effect.
*
*
* @param enableRuleRequest
* @return Result of the EnableRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.EnableRule
* @see AWS API
* Documentation
*/
default EnableRuleResponse enableRule(EnableRuleRequest enableRuleRequest) throws ResourceNotFoundException,
ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Enables the specified rule. If the rule does not exist, the operation fails.
*
*
* When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a
* short period of time for changes to take effect.
*
*
*
* This is a convenience which creates an instance of the {@link EnableRuleRequest.Builder} avoiding the need to
* create one manually via {@link EnableRuleRequest#builder()}
*
*
* @param enableRuleRequest
* A {@link Consumer} that will call methods on {@link EnableRuleRequest.Builder} to create a request.
* @return Result of the EnableRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.EnableRule
* @see AWS API
* Documentation
*/
default EnableRuleResponse enableRule(Consumer enableRuleRequest)
throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return enableRule(EnableRuleRequest.builder().applyMutation(enableRuleRequest).build());
}
/**
*
* Retrieves a list of API destination in the account in the current Region.
*
*
* @param listApiDestinationsRequest
* @return Result of the ListApiDestinations operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListApiDestinations
* @see AWS API Documentation
*/
default ListApiDestinationsResponse listApiDestinations(ListApiDestinationsRequest listApiDestinationsRequest)
throws InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of API destination in the account in the current Region.
*
*
*
* This is a convenience which creates an instance of the {@link ListApiDestinationsRequest.Builder} avoiding the
* need to create one manually via {@link ListApiDestinationsRequest#builder()}
*
*
* @param listApiDestinationsRequest
* A {@link Consumer} that will call methods on {@link ListApiDestinationsRequest.Builder} to create a
* request.
* @return Result of the ListApiDestinations operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListApiDestinations
* @see AWS API Documentation
*/
default ListApiDestinationsResponse listApiDestinations(
Consumer listApiDestinationsRequest) throws InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return listApiDestinations(ListApiDestinationsRequest.builder().applyMutation(listApiDestinationsRequest).build());
}
/**
*
* Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive
* names. Filter parameters are exclusive.
*
*
* @param listArchivesRequest
* @return Result of the ListArchives operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListArchives
* @see AWS API
* Documentation
*/
default ListArchivesResponse listArchives(ListArchivesRequest listArchivesRequest) throws ResourceNotFoundException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive
* names. Filter parameters are exclusive.
*
*
*
* This is a convenience which creates an instance of the {@link ListArchivesRequest.Builder} avoiding the need to
* create one manually via {@link ListArchivesRequest#builder()}
*
*
* @param listArchivesRequest
* A {@link Consumer} that will call methods on {@link ListArchivesRequest.Builder} to create a request.
* @return Result of the ListArchives operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListArchives
* @see AWS API
* Documentation
*/
default ListArchivesResponse listArchives(Consumer listArchivesRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return listArchives(ListArchivesRequest.builder().applyMutation(listArchivesRequest).build());
}
/**
*
* Retrieves a list of connections from the account.
*
*
* @param listConnectionsRequest
* @return Result of the ListConnections operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListConnections
* @see AWS
* API Documentation
*/
default ListConnectionsResponse listConnections(ListConnectionsRequest listConnectionsRequest) throws InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of connections from the account.
*
*
*
* This is a convenience which creates an instance of the {@link ListConnectionsRequest.Builder} avoiding the need
* to create one manually via {@link ListConnectionsRequest#builder()}
*
*
* @param listConnectionsRequest
* A {@link Consumer} that will call methods on {@link ListConnectionsRequest.Builder} to create a request.
* @return Result of the ListConnections operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListConnections
* @see AWS
* API Documentation
*/
default ListConnectionsResponse listConnections(Consumer listConnectionsRequest)
throws InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return listConnections(ListConnectionsRequest.builder().applyMutation(listConnectionsRequest).build());
}
/**
*
* Lists all the event buses in your account, including the default event bus, custom event buses, and partner event
* buses.
*
*
* @param listEventBusesRequest
* @return Result of the ListEventBuses operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListEventBuses
* @see AWS API
* Documentation
*/
default ListEventBusesResponse listEventBuses(ListEventBusesRequest listEventBusesRequest) throws InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists all the event buses in your account, including the default event bus, custom event buses, and partner event
* buses.
*
*
*
* This is a convenience which creates an instance of the {@link ListEventBusesRequest.Builder} avoiding the need to
* create one manually via {@link ListEventBusesRequest#builder()}
*
*
* @param listEventBusesRequest
* A {@link Consumer} that will call methods on {@link ListEventBusesRequest.Builder} to create a request.
* @return Result of the ListEventBuses operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListEventBuses
* @see AWS API
* Documentation
*/
default ListEventBusesResponse listEventBuses(Consumer listEventBusesRequest)
throws InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return listEventBuses(ListEventBusesRequest.builder().applyMutation(listEventBusesRequest).build());
}
/**
*
* You can use this to see all the partner event sources that have been shared with your AWS account. For more
* information about partner event sources, see CreateEventBus.
*
*
* @param listEventSourcesRequest
* @return Result of the ListEventSources operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListEventSources
* @see AWS
* API Documentation
*/
default ListEventSourcesResponse listEventSources(ListEventSourcesRequest listEventSourcesRequest) throws InternalException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* You can use this to see all the partner event sources that have been shared with your AWS account. For more
* information about partner event sources, see CreateEventBus.
*
*
*
* This is a convenience which creates an instance of the {@link ListEventSourcesRequest.Builder} avoiding the need
* to create one manually via {@link ListEventSourcesRequest#builder()}
*
*
* @param listEventSourcesRequest
* A {@link Consumer} that will call methods on {@link ListEventSourcesRequest.Builder} to create a request.
* @return Result of the ListEventSources operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListEventSources
* @see AWS
* API Documentation
*/
default ListEventSourcesResponse listEventSources(Consumer listEventSourcesRequest)
throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return listEventSources(ListEventSourcesRequest.builder().applyMutation(listEventSourcesRequest).build());
}
/**
*
* An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name
* is associated with. This operation is not used by AWS customers.
*
*
* @param listPartnerEventSourceAccountsRequest
* @return Result of the ListPartnerEventSourceAccounts operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListPartnerEventSourceAccounts
* @see AWS API Documentation
*/
default ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(
ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest) throws ResourceNotFoundException,
InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name
* is associated with. This operation is not used by AWS customers.
*
*
*
* This is a convenience which creates an instance of the {@link ListPartnerEventSourceAccountsRequest.Builder}
* avoiding the need to create one manually via {@link ListPartnerEventSourceAccountsRequest#builder()}
*
*
* @param listPartnerEventSourceAccountsRequest
* A {@link Consumer} that will call methods on {@link ListPartnerEventSourceAccountsRequest.Builder} to
* create a request.
* @return Result of the ListPartnerEventSourceAccounts operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListPartnerEventSourceAccounts
* @see AWS API Documentation
*/
default ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(
Consumer listPartnerEventSourceAccountsRequest)
throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException,
SdkClientException, EventBridgeException {
return listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest.builder()
.applyMutation(listPartnerEventSourceAccountsRequest).build());
}
/**
*
* An SaaS partner can use this operation to list all the partner event source names that they have created. This
* operation is not used by AWS customers.
*
*
* @param listPartnerEventSourcesRequest
* @return Result of the ListPartnerEventSources operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListPartnerEventSources
* @see AWS API Documentation
*/
default ListPartnerEventSourcesResponse listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest)
throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* An SaaS partner can use this operation to list all the partner event source names that they have created. This
* operation is not used by AWS customers.
*
*
*
* This is a convenience which creates an instance of the {@link ListPartnerEventSourcesRequest.Builder} avoiding
* the need to create one manually via {@link ListPartnerEventSourcesRequest#builder()}
*
*
* @param listPartnerEventSourcesRequest
* A {@link Consumer} that will call methods on {@link ListPartnerEventSourcesRequest.Builder} to create a
* request.
* @return Result of the ListPartnerEventSources operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListPartnerEventSources
* @see AWS API Documentation
*/
default ListPartnerEventSourcesResponse listPartnerEventSources(
Consumer listPartnerEventSourcesRequest) throws InternalException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return listPartnerEventSources(ListPartnerEventSourcesRequest.builder().applyMutation(listPartnerEventSourcesRequest)
.build());
}
/**
*
* Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names.
* Filter parameters are exclusive.
*
*
* @param listReplaysRequest
* @return Result of the ListReplays operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListReplays
* @see AWS API
* Documentation
*/
default ListReplaysResponse listReplays(ListReplaysRequest listReplaysRequest) throws InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names.
* Filter parameters are exclusive.
*
*
*
* This is a convenience which creates an instance of the {@link ListReplaysRequest.Builder} avoiding the need to
* create one manually via {@link ListReplaysRequest#builder()}
*
*
* @param listReplaysRequest
* A {@link Consumer} that will call methods on {@link ListReplaysRequest.Builder} to create a request.
* @return Result of the ListReplays operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListReplays
* @see AWS API
* Documentation
*/
default ListReplaysResponse listReplays(Consumer listReplaysRequest) throws InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return listReplays(ListReplaysRequest.builder().applyMutation(listReplaysRequest).build());
}
/**
*
* Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a
* specific target in your account.
*
*
* @param listRuleNamesByTargetRequest
* @return Result of the ListRuleNamesByTarget operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListRuleNamesByTarget
* @see AWS API Documentation
*/
default ListRuleNamesByTargetResponse listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a
* specific target in your account.
*
*
*
* This is a convenience which creates an instance of the {@link ListRuleNamesByTargetRequest.Builder} avoiding the
* need to create one manually via {@link ListRuleNamesByTargetRequest#builder()}
*
*
* @param listRuleNamesByTargetRequest
* A {@link Consumer} that will call methods on {@link ListRuleNamesByTargetRequest.Builder} to create a
* request.
* @return Result of the ListRuleNamesByTarget operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListRuleNamesByTarget
* @see AWS API Documentation
*/
default ListRuleNamesByTargetResponse listRuleNamesByTarget(
Consumer listRuleNamesByTargetRequest) throws InternalException,
ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException {
return listRuleNamesByTarget(ListRuleNamesByTargetRequest.builder().applyMutation(listRuleNamesByTargetRequest).build());
}
/**
*
* Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to
* the rule names.
*
*
* ListRules does not list the targets of a rule. To see the targets associated with a rule, use
* ListTargetsByRule.
*
*
* @param listRulesRequest
* @return Result of the ListRules operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListRules
* @see AWS API
* Documentation
*/
default ListRulesResponse listRules(ListRulesRequest listRulesRequest) throws InternalException, ResourceNotFoundException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to
* the rule names.
*
*
* ListRules does not list the targets of a rule. To see the targets associated with a rule, use
* ListTargetsByRule.
*
*
*
* This is a convenience which creates an instance of the {@link ListRulesRequest.Builder} avoiding the need to
* create one manually via {@link ListRulesRequest#builder()}
*
*
* @param listRulesRequest
* A {@link Consumer} that will call methods on {@link ListRulesRequest.Builder} to create a request.
* @return Result of the ListRules operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListRules
* @see AWS API
* Documentation
*/
default ListRulesResponse listRules(Consumer listRulesRequest) throws InternalException,
ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException {
return listRules(ListRulesRequest.builder().applyMutation(listRulesRequest).build());
}
/**
*
* Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws ResourceNotFoundException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Lists the targets assigned to the specified rule.
*
*
* @param listTargetsByRuleRequest
* @return Result of the ListTargetsByRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListTargetsByRule
* @see AWS
* API Documentation
*/
default ListTargetsByRuleResponse listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the targets assigned to the specified rule.
*
*
*
* This is a convenience which creates an instance of the {@link ListTargetsByRuleRequest.Builder} avoiding the need
* to create one manually via {@link ListTargetsByRuleRequest#builder()}
*
*
* @param listTargetsByRuleRequest
* A {@link Consumer} that will call methods on {@link ListTargetsByRuleRequest.Builder} to create a request.
* @return Result of the ListTargetsByRule operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.ListTargetsByRule
* @see AWS
* API Documentation
*/
default ListTargetsByRuleResponse listTargetsByRule(Consumer listTargetsByRuleRequest)
throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return listTargetsByRule(ListTargetsByRuleRequest.builder().applyMutation(listTargetsByRuleRequest).build());
}
/**
*
* Sends custom events to Amazon EventBridge so that they can be matched to rules.
*
*
* @param putEventsRequest
* @return Result of the PutEvents operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutEvents
* @see AWS API
* Documentation
*/
default PutEventsResponse putEvents(PutEventsRequest putEventsRequest) throws InternalException, AwsServiceException,
SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Sends custom events to Amazon EventBridge so that they can be matched to rules.
*
*
*
* This is a convenience which creates an instance of the {@link PutEventsRequest.Builder} avoiding the need to
* create one manually via {@link PutEventsRequest#builder()}
*
*
* @param putEventsRequest
* A {@link Consumer} that will call methods on {@link PutEventsRequest.Builder} to create a request.
* @return Result of the PutEvents operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutEvents
* @see AWS API
* Documentation
*/
default PutEventsResponse putEvents(Consumer putEventsRequest) throws InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return putEvents(PutEventsRequest.builder().applyMutation(putEventsRequest).build());
}
/**
*
* This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this
* operation.
*
*
* @param putPartnerEventsRequest
* @return Result of the PutPartnerEvents operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutPartnerEvents
* @see AWS
* API Documentation
*/
default PutPartnerEventsResponse putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest) throws InternalException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link PutPartnerEventsRequest.Builder} avoiding the need
* to create one manually via {@link PutPartnerEventsRequest#builder()}
*
*
* @param putPartnerEventsRequest
* A {@link Consumer} that will call methods on {@link PutPartnerEventsRequest.Builder} to create a request.
* @return Result of the PutPartnerEvents operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutPartnerEvents
* @see AWS
* API Documentation
*/
default PutPartnerEventsResponse putPartnerEvents(Consumer putPartnerEventsRequest)
throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return putPartnerEvents(PutPartnerEventsRequest.builder().applyMutation(putPartnerEventsRequest).build());
}
/**
*
* Running PutPermission permits the specified AWS account or AWS organization to put events to the
* specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these
* events arriving to an event bus in your account.
*
*
* For another account to send events to your account, that external account must have an EventBridge rule with your
* account's event bus as a target.
*
*
* To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of
* these accounts. Or, if all the accounts are members of the same AWS organization, you can run
* PutPermission once specifying Principal as "*" and specifying the AWS organization ID
* in Condition, to grant permissions to all accounts in that organization.
*
*
* If you grant permissions using an organization, then accounts in that organization must specify a
* RoleArn with proper permissions when they use PutTarget to add your account's event bus
* as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
*
*
* The permission policy on the default event bus cannot exceed 10 KB in size.
*
*
* @param putPermissionRequest
* @return Result of the PutPermission operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws PolicyLengthExceededException
* The event bus policy is too long. For more information, see the limits.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutPermission
* @see AWS API
* Documentation
*/
default PutPermissionResponse putPermission(PutPermissionRequest putPermissionRequest) throws ResourceNotFoundException,
PolicyLengthExceededException, InternalException, ConcurrentModificationException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Running PutPermission permits the specified AWS account or AWS organization to put events to the
* specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these
* events arriving to an event bus in your account.
*
*
* For another account to send events to your account, that external account must have an EventBridge rule with your
* account's event bus as a target.
*
*
* To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of
* these accounts. Or, if all the accounts are members of the same AWS organization, you can run
* PutPermission once specifying Principal as "*" and specifying the AWS organization ID
* in Condition, to grant permissions to all accounts in that organization.
*
*
* If you grant permissions using an organization, then accounts in that organization must specify a
* RoleArn with proper permissions when they use PutTarget to add your account's event bus
* as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
*
*
* The permission policy on the default event bus cannot exceed 10 KB in size.
*
*
*
* This is a convenience which creates an instance of the {@link PutPermissionRequest.Builder} avoiding the need to
* create one manually via {@link PutPermissionRequest#builder()}
*
*
* @param putPermissionRequest
* A {@link Consumer} that will call methods on {@link PutPermissionRequest.Builder} to create a request.
* @return Result of the PutPermission operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws PolicyLengthExceededException
* The event bus policy is too long. For more information, see the limits.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutPermission
* @see AWS API
* Documentation
*/
default PutPermissionResponse putPermission(Consumer putPermissionRequest)
throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException,
OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException {
return putPermission(PutPermissionRequest.builder().applyMutation(putPermissionRequest).build());
}
/**
*
* Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can
* disable a rule using DisableRule.
*
*
* A single rule watches for events from a single event bus. Events generated by AWS services go to your account's
* default event bus. Events generated by SaaS partner services or applications go to the matching partner event
* bus. If you have custom applications or services, you can specify whether their events go to your default event
* bus or a custom event bus that you have created. For more information, see CreateEventBus.
*
*
* If you are updating an existing rule, the rule is replaced with what you specify in this PutRule
* command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead,
* they are replaced with null values.
*
*
* When you create or update a rule, incoming events might not immediately start matching to new or updated rules.
* Allow a short period of time for changes to take effect.
*
*
* A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a
* matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can
* have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as
* on a schedule.
*
*
* When you initially create a rule, you can optionally assign one or more tags to the rule. 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 rules with certain tag values. To use the PutRule operation and
* assign tags, you must have both the events:PutRule and events:TagResource permissions.
*
*
* If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To
* update the tags of an existing rule, use TagResource and UntagResource.
*
*
* Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge
* uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event
* patterns so that they match the ARN syntax in the event you want to match.
*
*
* In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For
* example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the
* desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again,
* creating an infinite loop.
*
*
* To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your
* rule could fire only if ACLs are found to be in a bad state, instead of after any change.
*
*
* An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which
* alerts you when charges exceed your specified limit. For more information, see Managing Your
* Costs with Budgets.
*
*
* @param putRuleRequest
* @return Result of the PutRule operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutRule
* @see AWS API
* Documentation
*/
default PutRuleResponse putRule(PutRuleRequest putRuleRequest) throws InvalidEventPatternException, LimitExceededException,
ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can
* disable a rule using DisableRule.
*
*
* A single rule watches for events from a single event bus. Events generated by AWS services go to your account's
* default event bus. Events generated by SaaS partner services or applications go to the matching partner event
* bus. If you have custom applications or services, you can specify whether their events go to your default event
* bus or a custom event bus that you have created. For more information, see CreateEventBus.
*
*
* If you are updating an existing rule, the rule is replaced with what you specify in this PutRule
* command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead,
* they are replaced with null values.
*
*
* When you create or update a rule, incoming events might not immediately start matching to new or updated rules.
* Allow a short period of time for changes to take effect.
*
*
* A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a
* matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can
* have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as
* on a schedule.
*
*
* When you initially create a rule, you can optionally assign one or more tags to the rule. 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 rules with certain tag values. To use the PutRule operation and
* assign tags, you must have both the events:PutRule and events:TagResource permissions.
*
*
* If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To
* update the tags of an existing rule, use TagResource and UntagResource.
*
*
* Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge
* uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event
* patterns so that they match the ARN syntax in the event you want to match.
*
*
* In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For
* example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the
* desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again,
* creating an infinite loop.
*
*
* To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your
* rule could fire only if ACLs are found to be in a bad state, instead of after any change.
*
*
* An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which
* alerts you when charges exceed your specified limit. For more information, see Managing Your
* Costs with Budgets.
*
*
*
* This is a convenience which creates an instance of the {@link PutRuleRequest.Builder} avoiding the need to create
* one manually via {@link PutRuleRequest#builder()}
*
*
* @param putRuleRequest
* A {@link Consumer} that will call methods on {@link PutRuleRequest.Builder} to create a request.
* @return Result of the PutRule operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutRule
* @see AWS API
* Documentation
*/
default PutRuleResponse putRule(Consumer putRuleRequest) throws InvalidEventPatternException,
LimitExceededException, ConcurrentModificationException, ManagedRuleException, InternalException,
ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException {
return putRule(PutRuleRequest.builder().applyMutation(putRuleRequest).build());
}
/**
*
* Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
* rule.
*
*
* Targets are the resources that are invoked when a rule is triggered.
*
*
* You can configure the following as targets for Events:
*
*
* -
*
* EC2 instances
*
*
* -
*
* SSM Run Command
*
*
* -
*
* SSM Automation
*
*
* -
*
* AWS Lambda functions
*
*
* -
*
* Data streams in Amazon Kinesis Data Streams
*
*
* -
*
* Data delivery streams in Amazon Kinesis Data Firehose
*
*
* -
*
* Amazon ECS tasks
*
*
* -
*
* AWS Step Functions state machines
*
*
* -
*
* AWS Batch jobs
*
*
* -
*
* AWS CodeBuild projects
*
*
* -
*
* Pipelines in AWS CodePipeline
*
*
* -
*
* Amazon Inspector assessment templates
*
*
* -
*
* Amazon SNS topics
*
*
* -
*
* Amazon SQS queues, including FIFO queues
*
*
* -
*
* The default event bus of another AWS account
*
*
* -
*
* Amazon API Gateway REST APIs
*
*
* -
*
* Redshift Clusters to invoke Data API ExecuteStatement on
*
*
* -
*
* Custom/SaaS HTTPS APIs via EventBridge API Destinations
*
*
*
*
* Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are
* EC2 CreateSnapshot API call, EC2 RebootInstances API call,
* EC2 StopInstances API call, and EC2 TerminateInstances API call.
*
*
* For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis
* data stream, you can optionally specify which shard the event goes to by using the KinesisParameters
* argument. To invoke a command on multiple EC2 instances with one rule, you can use the
* RunCommandParameters field.
*
*
* To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the
* appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
* For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge
* relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more
* information, see Authentication and Access Control in the Amazon EventBridge User Guide.
*
*
* If another AWS account is in the same region and has granted you permission (using PutPermission),
* you can send events to that account. Set that account's event bus as a target of the rules in your account. To
* send the matched events to the other account, specify that account's event bus as the Arn value when
* you run PutTargets. If your account sends events to another account, your account is charged for
* each sent event. Each event sent to another account is charged as a custom event. The account receiving the event
* is not charged. For more information, see Amazon
* EventBridge (CloudWatch Events) Pricing.
*
*
*
* Input, InputPath, and InputTransformer are not available with
* PutTarget if the target is an event bus of a different AWS account.
*
*
*
* If you are setting the event bus of another account as the target, and that account granted permission to your
* account through an organization instead of directly by the account ID, then you must specify a
* RoleArn with proper permissions in the Target structure. For more information, see
* Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
*
*
* For more information about enabling cross-account events, see PutPermission.
*
*
* Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a
* target. When a rule is triggered due to a matched event:
*
*
* -
*
* If none of the following arguments are specified for a target, then the entire event is passed to the target in
* JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event
* is passed to the target).
*
*
* -
*
* If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
*
*
* -
*
* If InputPath is specified in the form of JSONPath (for example, $.detail), then only the
* part of the event specified in the path is passed to the target (for example, only the detail part of the event
* is passed).
*
*
* -
*
* If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and
* used as values in a template that you specify as the input to the target.
*
*
*
*
* When you specify InputPath or InputTransformer, you must use JSON dot notation, not
* bracket notation.
*
*
* When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be
* immediately invoked. Allow a short period of time for changes to take effect.
*
*
* This action can partially fail if too many requests are made at the same time. If that happens,
* FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
* the ID of the failed target and the error code.
*
*
* @param putTargetsRequest
* @return Result of the PutTargets operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutTargets
* @see AWS API
* Documentation
*/
default PutTargetsResponse putTargets(PutTargetsRequest putTargetsRequest) throws ResourceNotFoundException,
ConcurrentModificationException, LimitExceededException, ManagedRuleException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
* rule.
*
*
* Targets are the resources that are invoked when a rule is triggered.
*
*
* You can configure the following as targets for Events:
*
*
* -
*
* EC2 instances
*
*
* -
*
* SSM Run Command
*
*
* -
*
* SSM Automation
*
*
* -
*
* AWS Lambda functions
*
*
* -
*
* Data streams in Amazon Kinesis Data Streams
*
*
* -
*
* Data delivery streams in Amazon Kinesis Data Firehose
*
*
* -
*
* Amazon ECS tasks
*
*
* -
*
* AWS Step Functions state machines
*
*
* -
*
* AWS Batch jobs
*
*
* -
*
* AWS CodeBuild projects
*
*
* -
*
* Pipelines in AWS CodePipeline
*
*
* -
*
* Amazon Inspector assessment templates
*
*
* -
*
* Amazon SNS topics
*
*
* -
*
* Amazon SQS queues, including FIFO queues
*
*
* -
*
* The default event bus of another AWS account
*
*
* -
*
* Amazon API Gateway REST APIs
*
*
* -
*
* Redshift Clusters to invoke Data API ExecuteStatement on
*
*
* -
*
* Custom/SaaS HTTPS APIs via EventBridge API Destinations
*
*
*
*
* Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are
* EC2 CreateSnapshot API call, EC2 RebootInstances API call,
* EC2 StopInstances API call, and EC2 TerminateInstances API call.
*
*
* For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis
* data stream, you can optionally specify which shard the event goes to by using the KinesisParameters
* argument. To invoke a command on multiple EC2 instances with one rule, you can use the
* RunCommandParameters field.
*
*
* To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the
* appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
* For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge
* relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more
* information, see Authentication and Access Control in the Amazon EventBridge User Guide.
*
*
* If another AWS account is in the same region and has granted you permission (using PutPermission),
* you can send events to that account. Set that account's event bus as a target of the rules in your account. To
* send the matched events to the other account, specify that account's event bus as the Arn value when
* you run PutTargets. If your account sends events to another account, your account is charged for
* each sent event. Each event sent to another account is charged as a custom event. The account receiving the event
* is not charged. For more information, see Amazon
* EventBridge (CloudWatch Events) Pricing.
*
*
*
* Input, InputPath, and InputTransformer are not available with
* PutTarget if the target is an event bus of a different AWS account.
*
*
*
* If you are setting the event bus of another account as the target, and that account granted permission to your
* account through an organization instead of directly by the account ID, then you must specify a
* RoleArn with proper permissions in the Target structure. For more information, see
* Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
*
*
* For more information about enabling cross-account events, see PutPermission.
*
*
* Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a
* target. When a rule is triggered due to a matched event:
*
*
* -
*
* If none of the following arguments are specified for a target, then the entire event is passed to the target in
* JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event
* is passed to the target).
*
*
* -
*
* If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
*
*
* -
*
* If InputPath is specified in the form of JSONPath (for example, $.detail), then only the
* part of the event specified in the path is passed to the target (for example, only the detail part of the event
* is passed).
*
*
* -
*
* If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and
* used as values in a template that you specify as the input to the target.
*
*
*
*
* When you specify InputPath or InputTransformer, you must use JSON dot notation, not
* bracket notation.
*
*
* When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be
* immediately invoked. Allow a short period of time for changes to take effect.
*
*
* This action can partially fail if too many requests are made at the same time. If that happens,
* FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
* the ID of the failed target and the error code.
*
*
*
* This is a convenience which creates an instance of the {@link PutTargetsRequest.Builder} avoiding the need to
* create one manually via {@link PutTargetsRequest#builder()}
*
*
* @param putTargetsRequest
* A {@link Consumer} that will call methods on {@link PutTargetsRequest.Builder} to create a request.
* @return Result of the PutTargets operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.PutTargets
* @see AWS API
* Documentation
*/
default PutTargetsResponse putTargets(Consumer putTargetsRequest)
throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, ManagedRuleException,
InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return putTargets(PutTargetsRequest.builder().applyMutation(putTargetsRequest).build());
}
/**
*
* Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the
* account to revoke by the StatementId value that you associated with the account when you granted it
* permission with PutPermission. You can find the StatementId by using
* DescribeEventBus.
*
*
* @param removePermissionRequest
* @return Result of the RemovePermission operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.RemovePermission
* @see AWS
* API Documentation
*/
default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest)
throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the
* account to revoke by the StatementId value that you associated with the account when you granted it
* permission with PutPermission. You can find the StatementId by using
* DescribeEventBus.
*
*
*
* This is a convenience which creates an instance of the {@link RemovePermissionRequest.Builder} avoiding the need
* to create one manually via {@link RemovePermissionRequest#builder()}
*
*
* @param removePermissionRequest
* A {@link Consumer} that will call methods on {@link RemovePermissionRequest.Builder} to create a request.
* @return Result of the RemovePermission operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws OperationDisabledException
* The operation you are attempting is not available in this region.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.RemovePermission
* @see AWS
* API Documentation
*/
default RemovePermissionResponse removePermission(Consumer removePermissionRequest)
throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException,
AwsServiceException, SdkClientException, EventBridgeException {
return removePermission(RemovePermissionRequest.builder().applyMutation(removePermissionRequest).build());
}
/**
*
* Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be
* invoked.
*
*
* When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow
* a short period of time for changes to take effect.
*
*
* This action can partially fail if too many requests are made at the same time. If that happens,
* FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
* the ID of the failed target and the error code.
*
*
* @param removeTargetsRequest
* @return Result of the RemoveTargets operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.RemoveTargets
* @see AWS API
* Documentation
*/
default RemoveTargetsResponse removeTargets(RemoveTargetsRequest removeTargetsRequest) throws ResourceNotFoundException,
ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be
* invoked.
*
*
* When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow
* a short period of time for changes to take effect.
*
*
* This action can partially fail if too many requests are made at the same time. If that happens,
* FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
* the ID of the failed target and the error code.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveTargetsRequest.Builder} avoiding the need to
* create one manually via {@link RemoveTargetsRequest#builder()}
*
*
* @param removeTargetsRequest
* A {@link Consumer} that will call methods on {@link RemoveTargetsRequest.Builder} to create a request.
* @return Result of the RemoveTargets operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.RemoveTargets
* @see AWS API
* Documentation
*/
default RemoveTargetsResponse removeTargets(Consumer removeTargetsRequest)
throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
return removeTargets(RemoveTargetsRequest.builder().applyMutation(removeTargetsRequest).build());
}
/**
*
* Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to
* the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute
* intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute
* time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the
* second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The
* value returned for EventLastReplayedTime indicates the time within the specified time range
* associated with the last event replayed.
*
*
* @param startReplayRequest
* @return Result of the StartReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.StartReplay
* @see AWS API
* Documentation
*/
default StartReplayResponse startReplay(StartReplayRequest startReplayRequest) throws ResourceNotFoundException,
ResourceAlreadyExistsException, InvalidEventPatternException, LimitExceededException, InternalException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to
* the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute
* intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute
* time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the
* second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The
* value returned for EventLastReplayedTime indicates the time within the specified time range
* associated with the last event replayed.
*
*
*
* This is a convenience which creates an instance of the {@link StartReplayRequest.Builder} avoiding the need to
* create one manually via {@link StartReplayRequest#builder()}
*
*
* @param startReplayRequest
* A {@link Consumer} that will call methods on {@link StartReplayRequest.Builder} to create a request.
* @return Result of the StartReplay operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ResourceAlreadyExistsException
* The resource you are trying to create already exists.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.StartReplay
* @see AWS API
* Documentation
*/
default StartReplayResponse startReplay(Consumer startReplayRequest)
throws ResourceNotFoundException, ResourceAlreadyExistsException, InvalidEventPatternException,
LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return startReplay(StartReplayRequest.builder().applyMutation(startReplayRequest).build());
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified EventBridge resource. 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. In EventBridge, rules and event buses can be tagged.
*
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
*
*
* You can use the TagResource action with a resource that already has tags. If you specify a new tag
* key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
* already associated with the resource, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException,
ConcurrentModificationException, InternalException, ManagedRuleException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Assigns one or more tags (key-value pairs) to the specified EventBridge resource. 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. In EventBridge, rules and event buses can be tagged.
*
*
* Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
*
*
* You can use the TagResource action with a resource that already has tags. If you specify a new tag
* key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
* already associated with the resource, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a resource.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws ResourceNotFoundException, ConcurrentModificationException, InternalException, ManagedRuleException,
AwsServiceException, SdkClientException, EventBridgeException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Tests whether the specified event pattern matches the provided event.
*
*
* Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge
* uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event
* patterns so that they match the ARN syntax in the event you want to match.
*
*
* @param testEventPatternRequest
* @return Result of the TestEventPattern operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.TestEventPattern
* @see AWS
* API Documentation
*/
default TestEventPatternResponse testEventPattern(TestEventPatternRequest testEventPatternRequest)
throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Tests whether the specified event pattern matches the provided event.
*
*
* Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge
* uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event
* patterns so that they match the ARN syntax in the event you want to match.
*
*
*
* This is a convenience which creates an instance of the {@link TestEventPatternRequest.Builder} avoiding the need
* to create one manually via {@link TestEventPatternRequest#builder()}
*
*
* @param testEventPatternRequest
* A {@link Consumer} that will call methods on {@link TestEventPatternRequest.Builder} to create a request.
* @return Result of the TestEventPattern operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.TestEventPattern
* @see AWS
* API Documentation
*/
default TestEventPatternResponse testEventPattern(Consumer testEventPatternRequest)
throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, EventBridgeException {
return testEventPattern(TestEventPatternRequest.builder().applyMutation(testEventPatternRequest).build());
}
/**
*
* Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules
* and event buses can be tagged.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
InternalException, ConcurrentModificationException, ManagedRuleException, AwsServiceException, SdkClientException,
EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules
* and event buses can be tagged.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ManagedRuleException
* This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
* see this error in response to DeleteRule or RemoveTargets, you can use the
* Force parameter in those calls to delete the rule or remove targets from the rule. You
* cannot modify these managed rules by using DisableRule, EnableRule,
* PutTargets, PutRule, TagResource, or UntagResource.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, InternalException, ConcurrentModificationException, ManagedRuleException,
AwsServiceException, SdkClientException, EventBridgeException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates an API destination.
*
*
* @param updateApiDestinationRequest
* @return Result of the UpdateApiDestination operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateApiDestination
* @see AWS API Documentation
*/
default UpdateApiDestinationResponse updateApiDestination(UpdateApiDestinationRequest updateApiDestinationRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Updates an API destination.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateApiDestinationRequest.Builder} avoiding the
* need to create one manually via {@link UpdateApiDestinationRequest#builder()}
*
*
* @param updateApiDestinationRequest
* A {@link Consumer} that will call methods on {@link UpdateApiDestinationRequest.Builder} to create a
* request.
* @return Result of the UpdateApiDestination operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateApiDestination
* @see AWS API Documentation
*/
default UpdateApiDestinationResponse updateApiDestination(
Consumer updateApiDestinationRequest) throws ConcurrentModificationException,
ResourceNotFoundException, InternalException, LimitExceededException, AwsServiceException, SdkClientException,
EventBridgeException {
return updateApiDestination(UpdateApiDestinationRequest.builder().applyMutation(updateApiDestinationRequest).build());
}
/**
*
* Updates the specified archive.
*
*
* @param updateArchiveRequest
* @return Result of the UpdateArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateArchive
* @see AWS API
* Documentation
*/
default UpdateArchiveResponse updateArchive(UpdateArchiveRequest updateArchiveRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException,
InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified archive.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateArchiveRequest.Builder} avoiding the need to
* create one manually via {@link UpdateArchiveRequest#builder()}
*
*
* @param updateArchiveRequest
* A {@link Consumer} that will call methods on {@link UpdateArchiveRequest.Builder} to create a request.
* @return Result of the UpdateArchive operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateArchive
* @see AWS API
* Documentation
*/
default UpdateArchiveResponse updateArchive(Consumer updateArchiveRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException,
InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException {
return updateArchive(UpdateArchiveRequest.builder().applyMutation(updateArchiveRequest).build());
}
/**
*
* Updates settings for a connection.
*
*
* @param updateConnectionRequest
* @return Result of the UpdateConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateConnection
* @see AWS
* API Documentation
*/
default UpdateConnectionResponse updateConnection(UpdateConnectionRequest updateConnectionRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException,
AwsServiceException, SdkClientException, EventBridgeException {
throw new UnsupportedOperationException();
}
/**
*
* Updates settings for a connection.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateConnectionRequest.Builder} avoiding the need
* to create one manually via {@link UpdateConnectionRequest#builder()}
*
*
* @param updateConnectionRequest
* A {@link Consumer} that will call methods on {@link UpdateConnectionRequest.Builder} to create a request.
* @return Result of the UpdateConnection operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule, target, archive, or replay.
* @throws ResourceNotFoundException
* An entity that you specified does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @throws LimitExceededException
* The request failed because it attempted to create resource beyond the allowed service quota.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws EventBridgeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample EventBridgeClient.UpdateConnection
* @see AWS
* API Documentation
*/
default UpdateConnectionResponse updateConnection(Consumer updateConnectionRequest)
throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException,
AwsServiceException, SdkClientException, EventBridgeException {
return updateConnection(UpdateConnectionRequest.builder().applyMutation(updateConnectionRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("events");
}
}