Interface NotificationsAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NotificationsAsyncClient extends AwsClient
Service client for accessing AWS User Notifications asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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.The AWS User Notifications API Reference provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.
User Notification control APIs are currently available in US East (Virginia) -
us-east-1.GetNotificationEvent and ListNotificationEvents APIs are currently available in commercial partition Regions and only return notifications stored in the same Region in which they're called.
The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a notification hub in addition to US East (Virginia).
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateChannel
default CompletableFuture<AssociateChannelResponse> associateChannel(AssociateChannelRequest associateChannelRequest)
Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
- Parameters:
associateChannelRequest-- Returns:
- A Java Future containing the result of the AssociateChannel 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
associateChannel
default CompletableFuture<AssociateChannelResponse> associateChannel(Consumer<AssociateChannelRequest.Builder> associateChannelRequest)
Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
This is a convenience which creates an instance of the
AssociateChannelRequest.Builderavoiding the need to create one manually viaAssociateChannelRequest.builder()- Parameters:
associateChannelRequest- AConsumerthat will call methods onAssociateChannelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateChannel 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createEventRule
default CompletableFuture<CreateEventRuleResponse> createEventRule(CreateEventRuleRequest createEventRuleRequest)
Creates an EventRule that is associated with a specified Notification Configuration.
- Parameters:
createEventRuleRequest-- Returns:
- A Java Future containing the result of the CreateEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createEventRule
default CompletableFuture<CreateEventRuleResponse> createEventRule(Consumer<CreateEventRuleRequest.Builder> createEventRuleRequest)
Creates an EventRule that is associated with a specified Notification Configuration.
This is a convenience which creates an instance of the
CreateEventRuleRequest.Builderavoiding the need to create one manually viaCreateEventRuleRequest.builder()- Parameters:
createEventRuleRequest- AConsumerthat will call methods onCreateEventRuleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createNotificationConfiguration
default CompletableFuture<CreateNotificationConfigurationResponse> createNotificationConfiguration(CreateNotificationConfigurationRequest createNotificationConfigurationRequest)
Creates a new NotificationConfiguration.
- Parameters:
createNotificationConfigurationRequest-- Returns:
- A Java Future containing the result of the CreateNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createNotificationConfiguration
default CompletableFuture<CreateNotificationConfigurationResponse> createNotificationConfiguration(Consumer<CreateNotificationConfigurationRequest.Builder> createNotificationConfigurationRequest)
Creates a new NotificationConfiguration.
This is a convenience which creates an instance of the
CreateNotificationConfigurationRequest.Builderavoiding the need to create one manually viaCreateNotificationConfigurationRequest.builder()- Parameters:
createNotificationConfigurationRequest- AConsumerthat will call methods onCreateNotificationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteEventRule
default CompletableFuture<DeleteEventRuleResponse> deleteEventRule(DeleteEventRuleRequest deleteEventRuleRequest)
Deletes an EventRule.
- Parameters:
deleteEventRuleRequest-- Returns:
- A Java Future containing the result of the DeleteEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteEventRule
default CompletableFuture<DeleteEventRuleResponse> deleteEventRule(Consumer<DeleteEventRuleRequest.Builder> deleteEventRuleRequest)
Deletes an EventRule.
This is a convenience which creates an instance of the
DeleteEventRuleRequest.Builderavoiding the need to create one manually viaDeleteEventRuleRequest.builder()- Parameters:
deleteEventRuleRequest- AConsumerthat will call methods onDeleteEventRuleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default CompletableFuture<DeleteNotificationConfigurationResponse> deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes a NotificationConfiguration.
- Parameters:
deleteNotificationConfigurationRequest-- Returns:
- A Java Future containing the result of the DeleteNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default CompletableFuture<DeleteNotificationConfigurationResponse> deleteNotificationConfiguration(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest)
Deletes a NotificationConfiguration.
This is a convenience which creates an instance of the
DeleteNotificationConfigurationRequest.Builderavoiding the need to create one manually viaDeleteNotificationConfigurationRequest.builder()- Parameters:
deleteNotificationConfigurationRequest- AConsumerthat will call methods onDeleteNotificationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deregisterNotificationHub
default CompletableFuture<DeregisterNotificationHubResponse> deregisterNotificationHub(DeregisterNotificationHubRequest deregisterNotificationHubRequest)
Deregisters a NotificationHub in the specified Region.
You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationHub are no longer be visible. Recreating a new NotificationHub in the same Region restores access to those NotificationEvents.
- Parameters:
deregisterNotificationHubRequest-- Returns:
- A Java Future containing the result of the DeregisterNotificationHub 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deregisterNotificationHub
default CompletableFuture<DeregisterNotificationHubResponse> deregisterNotificationHub(Consumer<DeregisterNotificationHubRequest.Builder> deregisterNotificationHubRequest)
Deregisters a NotificationHub in the specified Region.
You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationHub are no longer be visible. Recreating a new NotificationHub in the same Region restores access to those NotificationEvents.
This is a convenience which creates an instance of the
DeregisterNotificationHubRequest.Builderavoiding the need to create one manually viaDeregisterNotificationHubRequest.builder()- Parameters:
deregisterNotificationHubRequest- AConsumerthat will call methods onDeregisterNotificationHubRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeregisterNotificationHub 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disassociateChannel
default CompletableFuture<DisassociateChannelResponse> disassociateChannel(DisassociateChannelRequest disassociateChannelRequest)
Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
- Parameters:
disassociateChannelRequest-- Returns:
- A Java Future containing the result of the DisassociateChannel 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
disassociateChannel
default CompletableFuture<DisassociateChannelResponse> disassociateChannel(Consumer<DisassociateChannelRequest.Builder> disassociateChannelRequest)
Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
This is a convenience which creates an instance of the
DisassociateChannelRequest.Builderavoiding the need to create one manually viaDisassociateChannelRequest.builder()- Parameters:
disassociateChannelRequest- AConsumerthat will call methods onDisassociateChannelRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateChannel 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getEventRule
default CompletableFuture<GetEventRuleResponse> getEventRule(GetEventRuleRequest getEventRuleRequest)
Returns a specified EventRule.
- Parameters:
getEventRuleRequest-- Returns:
- A Java Future containing the result of the GetEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getEventRule
default CompletableFuture<GetEventRuleResponse> getEventRule(Consumer<GetEventRuleRequest.Builder> getEventRuleRequest)
Returns a specified EventRule.
This is a convenience which creates an instance of the
GetEventRuleRequest.Builderavoiding the need to create one manually viaGetEventRuleRequest.builder()- Parameters:
getEventRuleRequest- AConsumerthat will call methods onGetEventRuleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getNotificationConfiguration
default CompletableFuture<GetNotificationConfigurationResponse> getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest)
Returns a specified NotificationConfiguration.
- Parameters:
getNotificationConfigurationRequest-- Returns:
- A Java Future containing the result of the GetNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getNotificationConfiguration
default CompletableFuture<GetNotificationConfigurationResponse> getNotificationConfiguration(Consumer<GetNotificationConfigurationRequest.Builder> getNotificationConfigurationRequest)
Returns a specified NotificationConfiguration.
This is a convenience which creates an instance of the
GetNotificationConfigurationRequest.Builderavoiding the need to create one manually viaGetNotificationConfigurationRequest.builder()- Parameters:
getNotificationConfigurationRequest- AConsumerthat will call methods onGetNotificationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getNotificationEvent
default CompletableFuture<GetNotificationEventResponse> getNotificationEvent(GetNotificationEventRequest getNotificationEventRequest)
Returns a specified NotificationEvent.
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide.
- Parameters:
getNotificationEventRequest-- Returns:
- A Java Future containing the result of the GetNotificationEvent 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getNotificationEvent
default CompletableFuture<GetNotificationEventResponse> getNotificationEvent(Consumer<GetNotificationEventRequest.Builder> getNotificationEventRequest)
Returns a specified NotificationEvent.
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide.
This is a convenience which creates an instance of the
GetNotificationEventRequest.Builderavoiding the need to create one manually viaGetNotificationEventRequest.builder()- Parameters:
getNotificationEventRequest- AConsumerthat will call methods onGetNotificationEventRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetNotificationEvent 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(ListChannelsRequest listChannelsRequest)
Returns a list of Channels for a NotificationConfiguration.
- Parameters:
listChannelsRequest-- Returns:
- A Java Future containing the result of the ListChannels 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listChannels
default CompletableFuture<ListChannelsResponse> listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
Returns a list of Channels for a NotificationConfiguration.
This is a convenience which creates an instance of the
ListChannelsRequest.Builderavoiding the need to create one manually viaListChannelsRequest.builder()- Parameters:
listChannelsRequest- AConsumerthat will call methods onListChannelsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListChannels 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(ListChannelsRequest listChannelsRequest)
This is a variant of
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListChannelsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation.- Parameters:
listChannelsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listChannelsPaginator
default ListChannelsPublisher listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest)
This is a variant of
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListChannelsPublisher publisher = client.listChannelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListChannelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListChannelsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation.
This is a convenience which creates an instance of the
ListChannelsRequest.Builderavoiding the need to create one manually viaListChannelsRequest.builder()- Parameters:
listChannelsRequest- AConsumerthat will call methods onListChannelsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEventRules
default CompletableFuture<ListEventRulesResponse> listEventRules(ListEventRulesRequest listEventRulesRequest)
Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
- Parameters:
listEventRulesRequest-- Returns:
- A Java Future containing the result of the ListEventRules 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEventRules
default CompletableFuture<ListEventRulesResponse> listEventRules(Consumer<ListEventRulesRequest.Builder> listEventRulesRequest)
Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
This is a convenience which creates an instance of the
ListEventRulesRequest.Builderavoiding the need to create one manually viaListEventRulesRequest.builder()- Parameters:
listEventRulesRequest- AConsumerthat will call methods onListEventRulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEventRules 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEventRulesPaginator
default ListEventRulesPublisher listEventRulesPaginator(ListEventRulesRequest listEventRulesRequest)
This is a variant of
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesPublisher publisher = client.listEventRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListEventRulesPublisher publisher = client.listEventRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListEventRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListEventRulesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation.- Parameters:
listEventRulesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listEventRulesPaginator
default ListEventRulesPublisher listEventRulesPaginator(Consumer<ListEventRulesRequest.Builder> listEventRulesRequest)
This is a variant of
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesPublisher publisher = client.listEventRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListEventRulesPublisher publisher = client.listEventRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListEventRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListEventRulesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation.
This is a convenience which creates an instance of the
ListEventRulesRequest.Builderavoiding the need to create one manually viaListEventRulesRequest.builder()- Parameters:
listEventRulesRequest- AConsumerthat will call methods onListEventRulesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationConfigurations
default CompletableFuture<ListNotificationConfigurationsResponse> listNotificationConfigurations(ListNotificationConfigurationsRequest listNotificationConfigurationsRequest)
Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
- Parameters:
listNotificationConfigurationsRequest-- Returns:
- A Java Future containing the result of the ListNotificationConfigurations 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationConfigurations
default CompletableFuture<ListNotificationConfigurationsResponse> listNotificationConfigurations(Consumer<ListNotificationConfigurationsRequest.Builder> listNotificationConfigurationsRequest)
Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
This is a convenience which creates an instance of the
ListNotificationConfigurationsRequest.Builderavoiding the need to create one manually viaListNotificationConfigurationsRequest.builder()- Parameters:
listNotificationConfigurationsRequest- AConsumerthat will call methods onListNotificationConfigurationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListNotificationConfigurations 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationConfigurationsPaginator
default ListNotificationConfigurationsPublisher listNotificationConfigurationsPaginator(ListNotificationConfigurationsRequest listNotificationConfigurationsRequest)
This is a variant of
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsPublisher publisher = client.listNotificationConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsPublisher publisher = client.listNotificationConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation.- Parameters:
listNotificationConfigurationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationConfigurationsPaginator
default ListNotificationConfigurationsPublisher listNotificationConfigurationsPaginator(Consumer<ListNotificationConfigurationsRequest.Builder> listNotificationConfigurationsRequest)
This is a variant of
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsPublisher publisher = client.listNotificationConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsPublisher publisher = client.listNotificationConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation.
This is a convenience which creates an instance of the
ListNotificationConfigurationsRequest.Builderavoiding the need to create one manually viaListNotificationConfigurationsRequest.builder()- Parameters:
listNotificationConfigurationsRequest- AConsumerthat will call methods onListNotificationConfigurationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationEvents
default CompletableFuture<ListNotificationEventsResponse> listNotificationEvents(ListNotificationEventsRequest listNotificationEventsRequest)
Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide.
- Parameters:
listNotificationEventsRequest-- Returns:
- A Java Future containing the result of the ListNotificationEvents 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationEvents
default CompletableFuture<ListNotificationEventsResponse> listNotificationEvents(Consumer<ListNotificationEventsRequest.Builder> listNotificationEventsRequest)
Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).
User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see Notification hubs in the AWS User Notifications User Guide.
This is a convenience which creates an instance of the
ListNotificationEventsRequest.Builderavoiding the need to create one manually viaListNotificationEventsRequest.builder()- Parameters:
listNotificationEventsRequest- AConsumerthat will call methods onListNotificationEventsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListNotificationEvents 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationEventsPaginator
default ListNotificationEventsPublisher listNotificationEventsPaginator(ListNotificationEventsRequest listNotificationEventsRequest)
This is a variant of
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsPublisher publisher = client.listNotificationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationEventsPublisher publisher = client.listNotificationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation.- Parameters:
listNotificationEventsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationEventsPaginator
default ListNotificationEventsPublisher listNotificationEventsPaginator(Consumer<ListNotificationEventsRequest.Builder> listNotificationEventsRequest)
This is a variant of
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsPublisher publisher = client.listNotificationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationEventsPublisher publisher = client.listNotificationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation.
This is a convenience which creates an instance of the
ListNotificationEventsRequest.Builderavoiding the need to create one manually viaListNotificationEventsRequest.builder()- Parameters:
listNotificationEventsRequest- AConsumerthat will call methods onListNotificationEventsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationHubs
default CompletableFuture<ListNotificationHubsResponse> listNotificationHubs(ListNotificationHubsRequest listNotificationHubsRequest)
Returns a list of NotificationHubs.
- Parameters:
listNotificationHubsRequest-- Returns:
- A Java Future containing the result of the ListNotificationHubs 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationHubs
default CompletableFuture<ListNotificationHubsResponse> listNotificationHubs(Consumer<ListNotificationHubsRequest.Builder> listNotificationHubsRequest)
Returns a list of NotificationHubs.
This is a convenience which creates an instance of the
ListNotificationHubsRequest.Builderavoiding the need to create one manually viaListNotificationHubsRequest.builder()- Parameters:
listNotificationHubsRequest- AConsumerthat will call methods onListNotificationHubsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListNotificationHubs 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationHubsPaginator
default ListNotificationHubsPublisher listNotificationHubsPaginator(ListNotificationHubsRequest listNotificationHubsRequest)
This is a variant of
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsPublisher publisher = client.listNotificationHubsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationHubsPublisher publisher = client.listNotificationHubsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation.- Parameters:
listNotificationHubsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNotificationHubsPaginator
default ListNotificationHubsPublisher listNotificationHubsPaginator(Consumer<ListNotificationHubsRequest.Builder> listNotificationHubsRequest)
This is a variant of
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsPublisher publisher = client.listNotificationHubsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notifications.paginators.ListNotificationHubsPublisher publisher = client.listNotificationHubsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation.
This is a convenience which creates an instance of the
ListNotificationHubsRequest.Builderavoiding the need to create one manually viaListNotificationHubsRequest.builder()- Parameters:
listNotificationHubsRequest- AConsumerthat will call methods onListNotificationHubsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
This is only supported for NotificationConfigurations.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
This is only supported for NotificationConfigurations.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
registerNotificationHub
default CompletableFuture<RegisterNotificationHubResponse> registerNotificationHub(RegisterNotificationHubRequest registerNotificationHubRequest)
Registers a NotificationHub in the specified Region.
There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.
- Parameters:
registerNotificationHubRequest-- Returns:
- A Java Future containing the result of the RegisterNotificationHub 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
registerNotificationHub
default CompletableFuture<RegisterNotificationHubResponse> registerNotificationHub(Consumer<RegisterNotificationHubRequest.Builder> registerNotificationHubRequest)
Registers a NotificationHub in the specified Region.
There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.
This is a convenience which creates an instance of the
RegisterNotificationHubRequest.Builderavoiding the need to create one manually viaRegisterNotificationHubRequest.builder()- Parameters:
registerNotificationHubRequest- AConsumerthat will call methods onRegisterNotificationHubRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RegisterNotificationHub 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 invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags the resource with a tag key and value.
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
This is only supported for NotificationConfigurations.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags the resource with a tag key and value.
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
This is only supported for NotificationConfigurations.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
For more information, see Tagging your AWS resources in the Tagging AWS Resources User Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateEventRule
default CompletableFuture<UpdateEventRuleResponse> updateEventRule(UpdateEventRuleRequest updateEventRuleRequest)
Updates an existing EventRule.
- Parameters:
updateEventRuleRequest-- Returns:
- A Java Future containing the result of the UpdateEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateEventRule
default CompletableFuture<UpdateEventRuleResponse> updateEventRule(Consumer<UpdateEventRuleRequest.Builder> updateEventRuleRequest)
Updates an existing EventRule.
This is a convenience which creates an instance of the
UpdateEventRuleRequest.Builderavoiding the need to create one manually viaUpdateEventRuleRequest.builder()- Parameters:
updateEventRuleRequest- AConsumerthat will call methods onUpdateEventRuleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateEventRule 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateNotificationConfiguration
default CompletableFuture<UpdateNotificationConfigurationResponse> updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest)
Updates a NotificationConfiguration.
- Parameters:
updateNotificationConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateNotificationConfiguration
default CompletableFuture<UpdateNotificationConfigurationResponse> updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest)
Updates a NotificationConfiguration.
This is a convenience which creates an instance of the
UpdateNotificationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateNotificationConfigurationRequest.builder()- Parameters:
updateNotificationConfigurationRequest- AConsumerthat will call methods onUpdateNotificationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateNotificationConfiguration 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 invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException User does not have sufficient access to perform this action.
- ValidationException This exception is thrown when the notification event fails validation.
- InternalServerException Unexpected error during processing of request.
- ThrottlingException Request was denied due to request throttling.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException Request references a resource which 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.
- NotificationsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default NotificationsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static NotificationsAsyncClient create()
Create aNotificationsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static NotificationsAsyncClientBuilder builder()
Create a builder that can be used to configure and create aNotificationsAsyncClient.
-
-