Interface NotificationsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface NotificationsClient extends AwsClient
Service client for accessing AWS User Notifications. This can be created using the staticbuilder()method.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 AssociateChannelResponse associateChannel(AssociateChannelRequest associateChannelRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the AssociateChannel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateChannel
default AssociateChannelResponse associateChannel(Consumer<AssociateChannelRequest.Builder> associateChannelRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the AssociateChannel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEventRule
default CreateEventRuleResponse createEventRule(CreateEventRuleRequest createEventRuleRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Creates an EventRule that is associated with a specified Notification Configuration.
- Parameters:
createEventRuleRequest-- Returns:
- Result of the CreateEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createEventRule
default CreateEventRuleResponse createEventRule(Consumer<CreateEventRuleRequest.Builder> createEventRuleRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the CreateEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createNotificationConfiguration
default CreateNotificationConfigurationResponse createNotificationConfiguration(CreateNotificationConfigurationRequest createNotificationConfigurationRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, NotificationsException
Creates a new NotificationConfiguration.
- Parameters:
createNotificationConfigurationRequest-- Returns:
- Result of the CreateNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createNotificationConfiguration
default CreateNotificationConfigurationResponse createNotificationConfiguration(Consumer<CreateNotificationConfigurationRequest.Builder> createNotificationConfigurationRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the CreateNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEventRule
default DeleteEventRuleResponse deleteEventRule(DeleteEventRuleRequest deleteEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Deletes an EventRule.
- Parameters:
deleteEventRuleRequest-- Returns:
- Result of the DeleteEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteEventRule
default DeleteEventRuleResponse deleteEventRule(Consumer<DeleteEventRuleRequest.Builder> deleteEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the DeleteEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Deletes a NotificationConfiguration.
- Parameters:
deleteNotificationConfigurationRequest-- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterNotificationHub
default DeregisterNotificationHubResponse deregisterNotificationHub(DeregisterNotificationHubRequest deregisterNotificationHubRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the DeregisterNotificationHub operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterNotificationHub
default DeregisterNotificationHubResponse deregisterNotificationHub(Consumer<DeregisterNotificationHubRequest.Builder> deregisterNotificationHubRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the DeregisterNotificationHub operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateChannel
default DisassociateChannelResponse disassociateChannel(DisassociateChannelRequest disassociateChannelRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).
- Parameters:
disassociateChannelRequest-- Returns:
- Result of the DisassociateChannel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateChannel
default DisassociateChannelResponse disassociateChannel(Consumer<DisassociateChannelRequest.Builder> disassociateChannelRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the DisassociateChannel operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEventRule
default GetEventRuleResponse getEventRule(GetEventRuleRequest getEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Returns a specified EventRule.
- Parameters:
getEventRuleRequest-- Returns:
- Result of the GetEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getEventRule
default GetEventRuleResponse getEventRule(Consumer<GetEventRuleRequest.Builder> getEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the GetEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotificationConfiguration
default GetNotificationConfigurationResponse getNotificationConfiguration(GetNotificationConfigurationRequest getNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Returns a specified NotificationConfiguration.
- Parameters:
getNotificationConfigurationRequest-- Returns:
- Result of the GetNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotificationConfiguration
default GetNotificationConfigurationResponse getNotificationConfiguration(Consumer<GetNotificationConfigurationRequest.Builder> getNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the GetNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotificationEvent
default GetNotificationEventResponse getNotificationEvent(GetNotificationEventRequest getNotificationEventRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the GetNotificationEvent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotificationEvent
default GetNotificationEventResponse getNotificationEvent(Consumer<GetNotificationEventRequest.Builder> getNotificationEventRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the GetNotificationEvent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChannels
default ListChannelsResponse listChannels(ListChannelsRequest listChannelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Returns a list of Channels for a NotificationConfiguration.
- Parameters:
listChannelsRequest-- Returns:
- Result of the ListChannels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChannels
default ListChannelsResponse listChannels(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListChannels operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChannelsPaginator
default ListChannelsIterable listChannelsPaginator(ListChannelsRequest listChannelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client .listChannelsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChannelsPaginator
default ListChannelsIterable listChannelsPaginator(Consumer<ListChannelsRequest.Builder> listChannelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listChannels(software.amazon.awssdk.services.notifications.model.ListChannelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client .listChannelsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListChannelsIterable responses = client.listChannelsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventRules
default ListEventRulesResponse listEventRules(ListEventRulesRequest listEventRulesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).
- Parameters:
listEventRulesRequest-- Returns:
- Result of the ListEventRules operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventRules
default ListEventRulesResponse listEventRules(Consumer<ListEventRulesRequest.Builder> listEventRulesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListEventRules operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventRulesPaginator
default ListEventRulesIterable listEventRulesPaginator(ListEventRulesRequest listEventRulesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client.listEventRulesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client .listEventRulesPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListEventRulesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client.listEventRulesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEventRulesPaginator
default ListEventRulesIterable listEventRulesPaginator(Consumer<ListEventRulesRequest.Builder> listEventRulesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listEventRules(software.amazon.awssdk.services.notifications.model.ListEventRulesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client.listEventRulesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client .listEventRulesPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListEventRulesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListEventRulesIterable responses = client.listEventRulesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationConfigurations
default ListNotificationConfigurationsResponse listNotificationConfigurations(ListNotificationConfigurationsRequest listNotificationConfigurationsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).
- Parameters:
listNotificationConfigurationsRequest-- Returns:
- Result of the ListNotificationConfigurations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationConfigurations
default ListNotificationConfigurationsResponse listNotificationConfigurations(Consumer<ListNotificationConfigurationsRequest.Builder> listNotificationConfigurationsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListNotificationConfigurations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationConfigurationsPaginator
default ListNotificationConfigurationsIterable listNotificationConfigurationsPaginator(ListNotificationConfigurationsRequest listNotificationConfigurationsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client.listNotificationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client .listNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client.listNotificationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationConfigurationsPaginator
default ListNotificationConfigurationsIterable listNotificationConfigurationsPaginator(Consumer<ListNotificationConfigurationsRequest.Builder> listNotificationConfigurationsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationConfigurations(software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client.listNotificationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client .listNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationConfigurationsIterable responses = client.listNotificationConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationEvents
default ListNotificationEventsResponse listNotificationEvents(ListNotificationEventsRequest listNotificationEventsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListNotificationEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationEvents
default ListNotificationEventsResponse listNotificationEvents(Consumer<ListNotificationEventsRequest.Builder> listNotificationEventsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListNotificationEvents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationEventsPaginator
default ListNotificationEventsIterable listNotificationEventsPaginator(ListNotificationEventsRequest listNotificationEventsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client.listNotificationEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client .listNotificationEventsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client.listNotificationEventsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationEventsPaginator
default ListNotificationEventsIterable listNotificationEventsPaginator(Consumer<ListNotificationEventsRequest.Builder> listNotificationEventsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationEvents(software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client.listNotificationEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client .listNotificationEventsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationEventsIterable responses = client.listNotificationEventsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationHubs
default ListNotificationHubsResponse listNotificationHubs(ListNotificationHubsRequest listNotificationHubsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
Returns a list of NotificationHubs.
- Parameters:
listNotificationHubsRequest-- Returns:
- Result of the ListNotificationHubs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationHubs
default ListNotificationHubsResponse listNotificationHubs(Consumer<ListNotificationHubsRequest.Builder> listNotificationHubsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListNotificationHubs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationHubsPaginator
default ListNotificationHubsIterable listNotificationHubsPaginator(ListNotificationHubsRequest listNotificationHubsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client.listNotificationHubsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client .listNotificationHubsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client.listNotificationHubsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotificationHubsPaginator
default ListNotificationHubsIterable listNotificationHubsPaginator(Consumer<ListNotificationHubsRequest.Builder> listNotificationHubsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, NotificationsException
This is a variant of
listNotificationHubs(software.amazon.awssdk.services.notifications.model.ListNotificationHubsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client.listNotificationHubsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client .listNotificationHubsPaginator(request); for (software.amazon.awssdk.services.notifications.model.ListNotificationHubsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.notifications.paginators.ListNotificationHubsIterable responses = client.listNotificationHubsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
registerNotificationHub
default RegisterNotificationHubResponse registerNotificationHub(RegisterNotificationHubRequest registerNotificationHubRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the RegisterNotificationHub operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
registerNotificationHub
default RegisterNotificationHubResponse registerNotificationHub(Consumer<RegisterNotificationHubRequest.Builder> registerNotificationHubRequest) throws ServiceQuotaExceededException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the RegisterNotificationHub operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEventRule
default UpdateEventRuleResponse updateEventRule(UpdateEventRuleRequest updateEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Updates an existing EventRule.
- Parameters:
updateEventRuleRequest-- Returns:
- Result of the UpdateEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateEventRule
default UpdateEventRuleResponse updateEventRule(Consumer<UpdateEventRuleRequest.Builder> updateEventRuleRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the UpdateEventRule operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotificationConfiguration
default UpdateNotificationConfigurationResponse updateNotificationConfiguration(UpdateNotificationConfigurationRequest updateNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
Updates a NotificationConfiguration.
- Parameters:
updateNotificationConfigurationRequest-- Returns:
- Result of the UpdateNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotificationConfiguration
default UpdateNotificationConfigurationResponse updateNotificationConfiguration(Consumer<UpdateNotificationConfigurationRequest.Builder> updateNotificationConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, NotificationsException
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:
- Result of the UpdateNotificationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static NotificationsClient create()
Create aNotificationsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static NotificationsClientBuilder builder()
Create a builder that can be used to configure and create aNotificationsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default NotificationsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-