Package software.amazon.awssdk.services.cloudwatchevents

Interface CloudWatchEventsAsyncClient

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

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to 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 Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

  • Direct specific API records from 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.

  • Field Details

  • Method Details

    • activateEventSource

      default CompletableFuture<ActivateEventSourceResponse> activateEventSource(ActivateEventSourceRequest activateEventSourceRequest)

      Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

      Parameters:
      activateEventSourceRequest -
      Returns:
      A Java Future containing the result of the ActivateEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateEventSource

      default CompletableFuture<ActivateEventSourceResponse> activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest)

      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 ActivateEventSourceRequest.Builder avoiding the need to create one manually via ActivateEventSourceRequest.builder()

      Parameters:
      activateEventSourceRequest - A Consumer that will call methods on ActivateEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ActivateEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelReplay

      default CompletableFuture<CancelReplayResponse> cancelReplay(CancelReplayRequest cancelReplayRequest)

      Cancels the specified replay.

      Parameters:
      cancelReplayRequest -
      Returns:
      A Java Future containing the result of the CancelReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • IllegalStatusException An error occurred because a replay can be canceled only when the state is Running or Starting.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelReplay

      default CompletableFuture<CancelReplayResponse> cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest)

      Cancels the specified replay.


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

      Parameters:
      cancelReplayRequest - A Consumer that will call methods on CancelReplayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • IllegalStatusException An error occurred because a replay can be canceled only when the state is Running or Starting.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApiDestination

      default CompletableFuture<CreateApiDestinationResponse> createApiDestination(CreateApiDestinationRequest createApiDestinationRequest)

      Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

      Parameters:
      createApiDestinationRequest -
      Returns:
      A Java Future containing the result of the CreateApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createApiDestination

      default CompletableFuture<CreateApiDestinationResponse> createApiDestination(Consumer<CreateApiDestinationRequest.Builder> createApiDestinationRequest)

      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 CreateApiDestinationRequest.Builder avoiding the need to create one manually via CreateApiDestinationRequest.builder()

      Parameters:
      createApiDestinationRequest - A Consumer that will call methods on CreateApiDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createArchive

      default CompletableFuture<CreateArchiveResponse> createArchive(CreateArchiveRequest createArchiveRequest)

      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.

      Parameters:
      createArchiveRequest -
      Returns:
      A Java Future containing the result of the CreateArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InvalidEventPatternException The event pattern is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createArchive

      default CompletableFuture<CreateArchiveResponse> createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest)

      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 CreateArchiveRequest.Builder avoiding the need to create one manually via CreateArchiveRequest.builder()

      Parameters:
      createArchiveRequest - A Consumer that will call methods on CreateArchiveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InvalidEventPatternException The event pattern is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnection

      default CompletableFuture<CreateConnectionResponse> createConnection(CreateConnectionRequest createConnectionRequest)

      Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

      Parameters:
      createConnectionRequest -
      Returns:
      A Java Future containing the result of the CreateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnection

      default CompletableFuture<CreateConnectionResponse> createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest)

      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 CreateConnectionRequest.Builder avoiding the need to create one manually via CreateConnectionRequest.builder()

      Parameters:
      createConnectionRequest - A Consumer that will call methods on CreateConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEventBus

      default CompletableFuture<CreateEventBusResponse> createEventBus(CreateEventBusRequest createEventBusRequest)

      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.

      Parameters:
      createEventBusRequest -
      Returns:
      A Java Future containing the result of the CreateEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEventBus

      default CompletableFuture<CreateEventBusResponse> createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest)

      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 CreateEventBusRequest.Builder avoiding the need to create one manually via CreateEventBusRequest.builder()

      Parameters:
      createEventBusRequest - A Consumer that will call methods on CreateEventBusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPartnerEventSource

      default CompletableFuture<CreatePartnerEventSourceResponse> createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest)

      Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.

      Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services customers decide whether to create an event bus to receive these events.

      Parameters:
      createPartnerEventSourceRequest -
      Returns:
      A Java Future containing the result of the CreatePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPartnerEventSource

      default CompletableFuture<CreatePartnerEventSourceResponse> createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest)

      Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.

      Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services customers decide whether to create an event bus to receive these events.


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

      Parameters:
      createPartnerEventSourceRequest - A Consumer that will call methods on CreatePartnerEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateEventSource

      default CompletableFuture<DeactivateEventSourceResponse> deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest)

      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.

      Parameters:
      deactivateEventSourceRequest -
      Returns:
      A Java Future containing the result of the DeactivateEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateEventSource

      default CompletableFuture<DeactivateEventSourceResponse> deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest)

      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 DeactivateEventSourceRequest.Builder avoiding the need to create one manually via DeactivateEventSourceRequest.builder()

      Parameters:
      deactivateEventSourceRequest - A Consumer that will call methods on DeactivateEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeactivateEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InvalidStateException The specified state is not a valid state for an event source.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deauthorizeConnection

      default CompletableFuture<DeauthorizeConnectionResponse> deauthorizeConnection(DeauthorizeConnectionRequest deauthorizeConnectionRequest)

      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.

      Parameters:
      deauthorizeConnectionRequest -
      Returns:
      A Java Future containing the result of the DeauthorizeConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deauthorizeConnection

      default CompletableFuture<DeauthorizeConnectionResponse> deauthorizeConnection(Consumer<DeauthorizeConnectionRequest.Builder> deauthorizeConnectionRequest)

      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 DeauthorizeConnectionRequest.Builder avoiding the need to create one manually via DeauthorizeConnectionRequest.builder()

      Parameters:
      deauthorizeConnectionRequest - A Consumer that will call methods on DeauthorizeConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeauthorizeConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApiDestination

      default CompletableFuture<DeleteApiDestinationResponse> deleteApiDestination(DeleteApiDestinationRequest deleteApiDestinationRequest)

      Deletes the specified API destination.

      Parameters:
      deleteApiDestinationRequest -
      Returns:
      A Java Future containing the result of the DeleteApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteApiDestination

      default CompletableFuture<DeleteApiDestinationResponse> deleteApiDestination(Consumer<DeleteApiDestinationRequest.Builder> deleteApiDestinationRequest)

      Deletes the specified API destination.


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

      Parameters:
      deleteApiDestinationRequest - A Consumer that will call methods on DeleteApiDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteArchive

      default CompletableFuture<DeleteArchiveResponse> deleteArchive(DeleteArchiveRequest deleteArchiveRequest)

      Deletes the specified archive.

      Parameters:
      deleteArchiveRequest -
      Returns:
      A Java Future containing the result of the DeleteArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteArchive

      default CompletableFuture<DeleteArchiveResponse> deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest)

      Deletes the specified archive.


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

      Parameters:
      deleteArchiveRequest - A Consumer that will call methods on DeleteArchiveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnection

      default CompletableFuture<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

      Deletes a connection.

      Parameters:
      deleteConnectionRequest -
      Returns:
      A Java Future containing the result of the DeleteConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnection

      default CompletableFuture<DeleteConnectionResponse> deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)

      Deletes a connection.


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

      Parameters:
      deleteConnectionRequest - A Consumer that will call methods on DeleteConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventBus

      default CompletableFuture<DeleteEventBusResponse> deleteEventBus(DeleteEventBusRequest deleteEventBusRequest)

      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.

      Parameters:
      deleteEventBusRequest -
      Returns:
      A Java Future containing the result of the DeleteEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEventBus

      default CompletableFuture<DeleteEventBusResponse> deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest)

      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 DeleteEventBusRequest.Builder avoiding the need to create one manually via DeleteEventBusRequest.builder()

      Parameters:
      deleteEventBusRequest - A Consumer that will call methods on DeleteEventBusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePartnerEventSource

      default CompletableFuture<DeletePartnerEventSourceResponse> deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest)

      This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.

      When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

      Parameters:
      deletePartnerEventSourceRequest -
      Returns:
      A Java Future containing the result of the DeletePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePartnerEventSource

      default CompletableFuture<DeletePartnerEventSourceResponse> deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest)

      This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.

      When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.


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

      Parameters:
      deletePartnerEventSourceRequest - A Consumer that will call methods on DeletePartnerEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRule

      default CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest deleteRuleRequest)

      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.

      If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

      Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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.

      Parameters:
      deleteRuleRequest -
      Returns:
      A Java Future containing the result of the DeleteRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRule

      default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)

      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.

      If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

      Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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 DeleteRuleRequest.Builder avoiding the need to create one manually via DeleteRuleRequest.builder()

      Parameters:
      deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApiDestination

      default CompletableFuture<DescribeApiDestinationResponse> describeApiDestination(DescribeApiDestinationRequest describeApiDestinationRequest)

      Retrieves details about an API destination.

      Parameters:
      describeApiDestinationRequest -
      Returns:
      A Java Future containing the result of the DescribeApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeApiDestination

      default CompletableFuture<DescribeApiDestinationResponse> describeApiDestination(Consumer<DescribeApiDestinationRequest.Builder> describeApiDestinationRequest)

      Retrieves details about an API destination.


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

      Parameters:
      describeApiDestinationRequest - A Consumer that will call methods on DescribeApiDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeArchive

      default CompletableFuture<DescribeArchiveResponse> describeArchive(DescribeArchiveRequest describeArchiveRequest)

      Retrieves details about an archive.

      Parameters:
      describeArchiveRequest -
      Returns:
      A Java Future containing the result of the DescribeArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeArchive

      default CompletableFuture<DescribeArchiveResponse> describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest)

      Retrieves details about an archive.


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

      Parameters:
      describeArchiveRequest - A Consumer that will call methods on DescribeArchiveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnection

      default CompletableFuture<DescribeConnectionResponse> describeConnection(DescribeConnectionRequest describeConnectionRequest)

      Retrieves details about a connection.

      Parameters:
      describeConnectionRequest -
      Returns:
      A Java Future containing the result of the DescribeConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnection

      default CompletableFuture<DescribeConnectionResponse> describeConnection(Consumer<DescribeConnectionRequest.Builder> describeConnectionRequest)

      Retrieves details about a connection.


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

      Parameters:
      describeConnectionRequest - A Consumer that will call methods on DescribeConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventBus

      default CompletableFuture<DescribeEventBusResponse> describeEventBus(DescribeEventBusRequest describeEventBusRequest)

      Displays details about an event bus in your account. This can include the external Amazon Web Services 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.

      Parameters:
      describeEventBusRequest -
      Returns:
      A Java Future containing the result of the DescribeEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventBus

      default CompletableFuture<DescribeEventBusResponse> describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)

      Displays details about an event bus in your account. This can include the external Amazon Web Services 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 DescribeEventBusRequest.Builder avoiding the need to create one manually via DescribeEventBusRequest.builder()

      Parameters:
      describeEventBusRequest - A Consumer that will call methods on DescribeEventBusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventBus

      default CompletableFuture<DescribeEventBusResponse> describeEventBus()

      Displays details about an event bus in your account. This can include the external Amazon Web Services 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.

      Returns:
      A Java Future containing the result of the DescribeEventBus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventSource

      default CompletableFuture<DescribeEventSourceResponse> describeEventSource(DescribeEventSourceRequest describeEventSourceRequest)

      This operation lists details about a partner event source that is shared with your account.

      Parameters:
      describeEventSourceRequest -
      Returns:
      A Java Future containing the result of the DescribeEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEventSource

      default CompletableFuture<DescribeEventSourceResponse> describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest)

      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 DescribeEventSourceRequest.Builder avoiding the need to create one manually via DescribeEventSourceRequest.builder()

      Parameters:
      describeEventSourceRequest - A Consumer that will call methods on DescribeEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePartnerEventSource

      default CompletableFuture<DescribePartnerEventSourceResponse> describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest)

      An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.

      Parameters:
      describePartnerEventSourceRequest -
      Returns:
      A Java Future containing the result of the DescribePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePartnerEventSource

      default CompletableFuture<DescribePartnerEventSourceResponse> describePartnerEventSource(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest)

      An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services 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 DescribePartnerEventSourceRequest.Builder avoiding the need to create one manually via DescribePartnerEventSourceRequest.builder()

      Parameters:
      describePartnerEventSourceRequest - A Consumer that will call methods on DescribePartnerEventSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePartnerEventSource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplay

      default CompletableFuture<DescribeReplayResponse> describeReplay(DescribeReplayRequest describeReplayRequest)

      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.

      Parameters:
      describeReplayRequest -
      Returns:
      A Java Future containing the result of the DescribeReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeReplay

      default CompletableFuture<DescribeReplayResponse> describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest)

      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 DescribeReplayRequest.Builder avoiding the need to create one manually via DescribeReplayRequest.builder()

      Parameters:
      describeReplayRequest - A Consumer that will call methods on DescribeReplayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRule

      default CompletableFuture<DescribeRuleResponse> describeRule(DescribeRuleRequest describeRuleRequest)

      Describes the specified rule.

      DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

      Parameters:
      describeRuleRequest -
      Returns:
      A Java Future containing the result of the DescribeRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRule

      default CompletableFuture<DescribeRuleResponse> describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)

      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 DescribeRuleRequest.Builder avoiding the need to create one manually via DescribeRuleRequest.builder()

      Parameters:
      describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableRule

      default CompletableFuture<DisableRuleResponse> disableRule(DisableRuleRequest disableRuleRequest)

      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.

      Parameters:
      disableRuleRequest -
      Returns:
      A Java Future containing the result of the DisableRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableRule

      default CompletableFuture<DisableRuleResponse> disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)

      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 DisableRuleRequest.Builder avoiding the need to create one manually via DisableRuleRequest.builder()

      Parameters:
      disableRuleRequest - A Consumer that will call methods on DisableRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableRule

      default CompletableFuture<EnableRuleResponse> enableRule(EnableRuleRequest enableRuleRequest)

      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.

      Parameters:
      enableRuleRequest -
      Returns:
      A Java Future containing the result of the EnableRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableRule

      default CompletableFuture<EnableRuleResponse> enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)

      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 EnableRuleRequest.Builder avoiding the need to create one manually via EnableRuleRequest.builder()

      Parameters:
      enableRuleRequest - A Consumer that will call methods on EnableRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApiDestinations

      default CompletableFuture<ListApiDestinationsResponse> listApiDestinations(ListApiDestinationsRequest listApiDestinationsRequest)

      Retrieves a list of API destination in the account in the current Region.

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

    • listApiDestinations

      default CompletableFuture<ListApiDestinationsResponse> listApiDestinations(Consumer<ListApiDestinationsRequest.Builder> listApiDestinationsRequest)

      Retrieves a list of API destination in the account in the current Region.


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

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

    • listArchives

      default CompletableFuture<ListArchivesResponse> listArchives(ListArchivesRequest listArchivesRequest)

      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.

      Parameters:
      listArchivesRequest -
      Returns:
      A Java Future containing the result of the ListArchives operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listArchives

      default CompletableFuture<ListArchivesResponse> listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest)

      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 ListArchivesRequest.Builder avoiding the need to create one manually via ListArchivesRequest.builder()

      Parameters:
      listArchivesRequest - A Consumer that will call methods on ListArchivesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListArchives operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnections

      default CompletableFuture<ListConnectionsResponse> listConnections(ListConnectionsRequest listConnectionsRequest)

      Retrieves a list of connections from the account.

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

    • listConnections

      default CompletableFuture<ListConnectionsResponse> listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest)

      Retrieves a list of connections from the account.


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

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

    • listEventBuses

      default CompletableFuture<ListEventBusesResponse> listEventBuses(ListEventBusesRequest listEventBusesRequest)

      Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

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

    • listEventBuses

      default CompletableFuture<ListEventBusesResponse> listEventBuses(Consumer<ListEventBusesRequest.Builder> listEventBusesRequest)

      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 ListEventBusesRequest.Builder avoiding the need to create one manually via ListEventBusesRequest.builder()

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

    • listEventSources

      default CompletableFuture<ListEventSourcesResponse> listEventSources(ListEventSourcesRequest listEventSourcesRequest)

      You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.

      Parameters:
      listEventSourcesRequest -
      Returns:
      A Java Future containing the result of the ListEventSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEventSources

      default CompletableFuture<ListEventSourcesResponse> listEventSources(Consumer<ListEventSourcesRequest.Builder> listEventSourcesRequest)

      You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.


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

      Parameters:
      listEventSourcesRequest - A Consumer that will call methods on ListEventSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEventSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPartnerEventSourceAccounts

      default CompletableFuture<ListPartnerEventSourceAccountsResponse> listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest)

      An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.

      Parameters:
      listPartnerEventSourceAccountsRequest -
      Returns:
      A Java Future containing the result of the ListPartnerEventSourceAccounts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPartnerEventSourceAccounts

      default CompletableFuture<ListPartnerEventSourceAccountsResponse> listPartnerEventSourceAccounts(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest)

      An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.


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

      Parameters:
      listPartnerEventSourceAccountsRequest - A Consumer that will call methods on ListPartnerEventSourceAccountsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPartnerEventSourceAccounts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPartnerEventSources

      default CompletableFuture<ListPartnerEventSourcesResponse> listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest)

      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 Amazon Web Services customers.

      Parameters:
      listPartnerEventSourcesRequest -
      Returns:
      A Java Future containing the result of the ListPartnerEventSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPartnerEventSources

      default CompletableFuture<ListPartnerEventSourcesResponse> listPartnerEventSources(Consumer<ListPartnerEventSourcesRequest.Builder> listPartnerEventSourcesRequest)

      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 Amazon Web Services customers.


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

      Parameters:
      listPartnerEventSourcesRequest - A Consumer that will call methods on ListPartnerEventSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPartnerEventSources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listReplays

      default CompletableFuture<ListReplaysResponse> listReplays(ListReplaysRequest listReplaysRequest)

      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.

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

    • listReplays

      default CompletableFuture<ListReplaysResponse> listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest)

      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 ListReplaysRequest.Builder avoiding the need to create one manually via ListReplaysRequest.builder()

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

    • listRuleNamesByTarget

      default CompletableFuture<ListRuleNamesByTargetResponse> listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)

      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.

      Parameters:
      listRuleNamesByTargetRequest -
      Returns:
      A Java Future containing the result of the ListRuleNamesByTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRuleNamesByTarget

      default CompletableFuture<ListRuleNamesByTargetResponse> listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)

      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 ListRuleNamesByTargetRequest.Builder avoiding the need to create one manually via ListRuleNamesByTargetRequest.builder()

      Parameters:
      listRuleNamesByTargetRequest - A Consumer that will call methods on ListRuleNamesByTargetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRuleNamesByTarget operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRules

      default CompletableFuture<ListRulesResponse> listRules(ListRulesRequest listRulesRequest)

      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.

      Parameters:
      listRulesRequest -
      Returns:
      A Java Future containing the result of the ListRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRules

      default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)

      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 ListRulesRequest.Builder avoiding the need to create one manually via ListRulesRequest.builder()

      Parameters:
      listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRules

      default CompletableFuture<ListRulesResponse> listRules()

      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.

      Returns:
      A Java Future containing the result of the ListRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

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

      Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.


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

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

    • listTargetsByRule

      default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)

      Lists the targets assigned to the specified rule.

      Parameters:
      listTargetsByRuleRequest -
      Returns:
      A Java Future containing the result of the ListTargetsByRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTargetsByRule

      default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)

      Lists the targets assigned to the specified rule.


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

      Parameters:
      listTargetsByRuleRequest - A Consumer that will call methods on ListTargetsByRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTargetsByRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)

      Sends custom events to Amazon EventBridge so that they can be matched to rules.

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

    • putEvents

      default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)

      Sends custom events to Amazon EventBridge so that they can be matched to rules.


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

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

    • putPartnerEvents

      default CompletableFuture<PutPartnerEventsResponse> putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest)

      This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.

      Parameters:
      putPartnerEventsRequest -
      Returns:
      A Java Future containing the result of the PutPartnerEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPartnerEvents

      default CompletableFuture<PutPartnerEventsResponse> putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest)

      This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.


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

      Parameters:
      putPartnerEventsRequest - A Consumer that will call methods on PutPartnerEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutPartnerEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalException This exception occurs due to unexpected causes.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPermission

      default CompletableFuture<PutPermissionResponse> putPermission(PutPermissionRequest putPermissionRequest)

      Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services Accounts in the Amazon EventBridge User Guide.

      The permission policy on the event bus cannot exceed 10 KB in size.

      Parameters:
      putPermissionRequest -
      Returns:
      A Java Future containing the result of the PutPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • PolicyLengthExceededException The event bus policy is too long. For more information, see the limits.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putPermission

      default CompletableFuture<PutPermissionResponse> putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)

      Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services Accounts in the Amazon EventBridge User Guide.

      The permission policy on the event bus cannot exceed 10 KB in size.


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

      Parameters:
      putPermissionRequest - A Consumer that will call methods on PutPermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutPermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • PolicyLengthExceededException The event bus policy is too long. For more information, see the limits.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putRule

      default CompletableFuture<PutRuleResponse> putRule(PutRuleRequest putRuleRequest)

      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 Amazon Web Services 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 Amazon Web Services 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.

      Parameters:
      putRuleRequest -
      Returns:
      A Java Future containing the result of the PutRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidEventPatternException The event pattern is not valid.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putRule

      default CompletableFuture<PutRuleResponse> putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)

      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 Amazon Web Services 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 Amazon Web Services 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 PutRuleRequest.Builder avoiding the need to create one manually via PutRuleRequest.builder()

      Parameters:
      putRuleRequest - A Consumer that will call methods on PutRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidEventPatternException The event pattern is not valid.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • ResourceNotFoundException An entity that you specified does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTargets

      default CompletableFuture<PutTargetsResponse> putTargets(PutTargetsRequest putTargetsRequest)

      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:

      • API destination

      • Amazon API Gateway REST API endpoints

      • API Gateway

      • Batch job queue

      • CloudWatch Logs group

      • CodeBuild project

      • CodePipeline

      • Amazon EC2 CreateSnapshot API call

      • Amazon EC2 RebootInstances API call

      • Amazon EC2 StopInstances API call

      • Amazon EC2 TerminateInstances API call

      • Amazon ECS tasks

      • Event bus in a different Amazon Web Services account or Region.

        You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

      • Firehose delivery stream (Kinesis Data Firehose)

      • Inspector assessment template (Amazon Inspector)

      • Kinesis stream (Kinesis Data Stream)

      • Lambda function

      • Redshift clusters (Data API statement execution)

      • Amazon SNS topic

      • Amazon SQS queues (includes FIFO queues

      • SSM Automation

      • SSM OpsItem

      • SSM Run Command

      • Step Functions state machines

      Creating rules with built-in targets is supported only in the Amazon Web Services 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 needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, 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 Amazon Web Services 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 Pricing.

      Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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, invalid input: '&#36'.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.

      Parameters:
      putTargetsRequest -
      Returns:
      A Java Future containing the result of the PutTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTargets

      default CompletableFuture<PutTargetsResponse> putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest)

      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:

      • API destination

      • Amazon API Gateway REST API endpoints

      • API Gateway

      • Batch job queue

      • CloudWatch Logs group

      • CodeBuild project

      • CodePipeline

      • Amazon EC2 CreateSnapshot API call

      • Amazon EC2 RebootInstances API call

      • Amazon EC2 StopInstances API call

      • Amazon EC2 TerminateInstances API call

      • Amazon ECS tasks

      • Event bus in a different Amazon Web Services account or Region.

        You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

      • Firehose delivery stream (Kinesis Data Firehose)

      • Inspector assessment template (Amazon Inspector)

      • Kinesis stream (Kinesis Data Stream)

      • Lambda function

      • Redshift clusters (Data API statement execution)

      • Amazon SNS topic

      • Amazon SQS queues (includes FIFO queues

      • SSM Automation

      • SSM OpsItem

      • SSM Run Command

      • Step Functions state machines

      Creating rules with built-in targets is supported only in the Amazon Web Services 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 needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, 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 Amazon Web Services 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 Pricing.

      Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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, invalid input: '&#36'.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 PutTargetsRequest.Builder avoiding the need to create one manually via PutTargetsRequest.builder()

      Parameters:
      putTargetsRequest - A Consumer that will call methods on PutTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removePermission

      default CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)

      Revokes the permission of another Amazon Web Services 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 .

      Parameters:
      removePermissionRequest -
      Returns:
      A Java Future containing the result of the RemovePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removePermission

      default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)

      Revokes the permission of another Amazon Web Services 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 RemovePermissionRequest.Builder avoiding the need to create one manually via RemovePermissionRequest.builder()

      Parameters:
      removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemovePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • OperationDisabledException The operation you are attempting is not available in this region.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTargets

      default CompletableFuture<RemoveTargetsResponse> removeTargets(RemoveTargetsRequest removeTargetsRequest)

      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.

      Parameters:
      removeTargetsRequest -
      Returns:
      A Java Future containing the result of the RemoveTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTargets

      default CompletableFuture<RemoveTargetsResponse> removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)

      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 RemoveTargetsRequest.Builder avoiding the need to create one manually via RemoveTargetsRequest.builder()

      Parameters:
      removeTargetsRequest - A Consumer that will call methods on RemoveTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startReplay

      default CompletableFuture<StartReplayResponse> startReplay(StartReplayRequest startReplayRequest)

      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.

      Parameters:
      startReplayRequest -
      Returns:
      A Java Future containing the result of the StartReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • InvalidEventPatternException The event pattern is not valid.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startReplay

      default CompletableFuture<StartReplayResponse> startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest)

      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 StartReplayRequest.Builder avoiding the need to create one manually via StartReplayRequest.builder()

      Parameters:
      startReplayRequest - A Consumer that will call methods on StartReplayRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartReplay operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ResourceAlreadyExistsException The resource you are trying to create already exists.
      • InvalidEventPatternException The event pattern is not valid.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified 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 Amazon Web Services 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.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InternalException This exception occurs due to unexpected causes.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Assigns one or more tags (key-value pairs) to the specified 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 Amazon Web Services 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 TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • InternalException This exception occurs due to unexpected causes.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testEventPattern

      default CompletableFuture<TestEventPatternResponse> testEventPattern(TestEventPatternRequest testEventPatternRequest)

      Tests whether the specified event pattern matches the provided event.

      Most services in Amazon Web Services 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.

      Parameters:
      testEventPatternRequest -
      Returns:
      A Java Future containing the result of the TestEventPattern operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidEventPatternException The event pattern is not valid.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testEventPattern

      default CompletableFuture<TestEventPatternResponse> testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)

      Tests whether the specified event pattern matches the provided event.

      Most services in Amazon Web Services 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 TestEventPatternRequest.Builder avoiding the need to create one manually via TestEventPatternRequest.builder()

      Parameters:
      testEventPatternRequest - A Consumer that will call methods on TestEventPatternRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestEventPattern operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidEventPatternException The event pattern is not valid.
      • InternalException This exception occurs due to unexpected causes.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ManagedRuleException This rule was created by an Amazon Web Services 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApiDestination

      default CompletableFuture<UpdateApiDestinationResponse> updateApiDestination(UpdateApiDestinationRequest updateApiDestinationRequest)

      Updates an API destination.

      Parameters:
      updateApiDestinationRequest -
      Returns:
      A Java Future containing the result of the UpdateApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApiDestination

      default CompletableFuture<UpdateApiDestinationResponse> updateApiDestination(Consumer<UpdateApiDestinationRequest.Builder> updateApiDestinationRequest)

      Updates an API destination.


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

      Parameters:
      updateApiDestinationRequest - A Consumer that will call methods on UpdateApiDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApiDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateArchive

      default CompletableFuture<UpdateArchiveResponse> updateArchive(UpdateArchiveRequest updateArchiveRequest)

      Updates the specified archive.

      Parameters:
      updateArchiveRequest -
      Returns:
      A Java Future containing the result of the UpdateArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InvalidEventPatternException The event pattern is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateArchive

      default CompletableFuture<UpdateArchiveResponse> updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest)

      Updates the specified archive.


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

      Parameters:
      updateArchiveRequest - A Consumer that will call methods on UpdateArchiveRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateArchive operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • InvalidEventPatternException The event pattern is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnection

      default CompletableFuture<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest updateConnectionRequest)

      Updates settings for a connection.

      Parameters:
      updateConnectionRequest -
      Returns:
      A Java Future containing the result of the UpdateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnection

      default CompletableFuture<UpdateConnectionResponse> updateConnection(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest)

      Updates settings for a connection.


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

      Parameters:
      updateConnectionRequest - A Consumer that will call methods on UpdateConnectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.
      • ResourceNotFoundException An entity that you specified does not exist.
      • InternalException This exception occurs due to unexpected causes.
      • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • CloudWatchEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • create

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

    • builder

      static CloudWatchEventsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a CloudWatchEventsAsyncClient.