Interface NotificationsContactsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
AWS User Notifications Contacts is a service that allows you to create and manage email contacts for AWS User Notifications. The AWS User Notifications Contacts API Reference provides descriptions, API request parameters, and the JSON response for all email contact related API actions.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionactivateEmailContact(Consumer<ActivateEmailContactRequest.Builder> activateEmailContactRequest) Activates an email contact using an activation code.activateEmailContact(ActivateEmailContactRequest activateEmailContactRequest) Activates an email contact using an activation code.builder()Create a builder that can be used to configure and create aNotificationsContactsAsyncClient.create()Create aNotificationsContactsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createEmailContact(Consumer<CreateEmailContactRequest.Builder> createEmailContactRequest) Creates an email contact for the provided email address.createEmailContact(CreateEmailContactRequest createEmailContactRequest) Creates an email contact for the provided email address.deleteEmailContact(Consumer<DeleteEmailContactRequest.Builder> deleteEmailContactRequest) Deletes an email contact.deleteEmailContact(DeleteEmailContactRequest deleteEmailContactRequest) Deletes an email contact.default CompletableFuture<GetEmailContactResponse> getEmailContact(Consumer<GetEmailContactRequest.Builder> getEmailContactRequest) Returns an email contact.default CompletableFuture<GetEmailContactResponse> getEmailContact(GetEmailContactRequest getEmailContactRequest) Returns an email contact.listEmailContacts(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest) Lists all email contacts created under the Account.listEmailContacts(ListEmailContactsRequest listEmailContactsRequest) Lists all email contacts created under the Account.default ListEmailContactsPublisherlistEmailContactsPaginator(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest) This is a variant oflistEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation.default ListEmailContactsPublisherlistEmailContactsPaginator(ListEmailContactsRequest listEmailContactsRequest) This is a variant oflistEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest) Sends an activation email to the email address associated with the specified email contact.sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest) Sends an activation email to the email address associated with the specified email contact.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activateEmailContact
default CompletableFuture<ActivateEmailContactResponse> activateEmailContact(ActivateEmailContactRequest activateEmailContactRequest) Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.
- Parameters:
activateEmailContactRequest-- Returns:
- A Java Future containing the result of the ActivateEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateEmailContact
default CompletableFuture<ActivateEmailContactResponse> activateEmailContact(Consumer<ActivateEmailContactRequest.Builder> activateEmailContactRequest) Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.
This is a convenience which creates an instance of the
ActivateEmailContactRequest.Builderavoiding the need to create one manually viaActivateEmailContactRequest.builder()- Parameters:
activateEmailContactRequest- AConsumerthat will call methods onActivateEmailContactRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ActivateEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEmailContact
default CompletableFuture<CreateEmailContactResponse> createEmailContact(CreateEmailContactRequest createEmailContactRequest) Creates an email contact for the provided email address.
- Parameters:
createEmailContactRequest-- Returns:
- A Java Future containing the result of the CreateEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEmailContact
default CompletableFuture<CreateEmailContactResponse> createEmailContact(Consumer<CreateEmailContactRequest.Builder> createEmailContactRequest) Creates an email contact for the provided email address.
This is a convenience which creates an instance of the
CreateEmailContactRequest.Builderavoiding the need to create one manually viaCreateEmailContactRequest.builder()- Parameters:
createEmailContactRequest- AConsumerthat will call methods onCreateEmailContactRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailContact
default CompletableFuture<DeleteEmailContactResponse> deleteEmailContact(DeleteEmailContactRequest deleteEmailContactRequest) Deletes an email contact.
Deleting an email contact removes it from all associated notification configurations.
- Parameters:
deleteEmailContactRequest-- Returns:
- A Java Future containing the result of the DeleteEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEmailContact
default CompletableFuture<DeleteEmailContactResponse> deleteEmailContact(Consumer<DeleteEmailContactRequest.Builder> deleteEmailContactRequest) Deletes an email contact.
Deleting an email contact removes it from all associated notification configurations.
This is a convenience which creates an instance of the
DeleteEmailContactRequest.Builderavoiding the need to create one manually viaDeleteEmailContactRequest.builder()- Parameters:
deleteEmailContactRequest- AConsumerthat will call methods onDeleteEmailContactRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEmailContact
default CompletableFuture<GetEmailContactResponse> getEmailContact(GetEmailContactRequest getEmailContactRequest) Returns an email contact.
- Parameters:
getEmailContactRequest-- Returns:
- A Java Future containing the result of the GetEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEmailContact
default CompletableFuture<GetEmailContactResponse> getEmailContact(Consumer<GetEmailContactRequest.Builder> getEmailContactRequest) Returns an email contact.
This is a convenience which creates an instance of the
GetEmailContactRequest.Builderavoiding the need to create one manually viaGetEmailContactRequest.builder()- Parameters:
getEmailContactRequest- AConsumerthat will call methods onGetEmailContactRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEmailContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailContacts
default CompletableFuture<ListEmailContactsResponse> listEmailContacts(ListEmailContactsRequest listEmailContactsRequest) Lists all email contacts created under the Account.
- Parameters:
listEmailContactsRequest-- Returns:
- A Java Future containing the result of the ListEmailContacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailContacts
default CompletableFuture<ListEmailContactsResponse> listEmailContacts(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest) Lists all email contacts created under the Account.
This is a convenience which creates an instance of the
ListEmailContactsRequest.Builderavoiding the need to create one manually viaListEmailContactsRequest.builder()- Parameters:
listEmailContactsRequest- AConsumerthat will call methods onListEmailContactsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEmailContacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailContactsPaginator
default ListEmailContactsPublisher listEmailContactsPaginator(ListEmailContactsRequest listEmailContactsRequest) This is a variant of
listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsPublisher publisher = client.listEmailContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsPublisher publisher = client.listEmailContactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation.- Parameters:
listEmailContactsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEmailContactsPaginator
default ListEmailContactsPublisher listEmailContactsPaginator(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest) This is a variant of
listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsPublisher publisher = client.listEmailContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsPublisher publisher = client.listEmailContactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest)operation.
This is a convenience which creates an instance of the
ListEmailContactsRequest.Builderavoiding the need to create one manually viaListEmailContactsRequest.builder()- Parameters:
listEmailContactsRequest- AConsumerthat will call methods onListEmailContactsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendActivationCode
default CompletableFuture<SendActivationCodeResponse> sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest) Sends an activation email to the email address associated with the specified email contact.
It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email.
- Parameters:
sendActivationCodeRequest-- Returns:
- A Java Future containing the result of the SendActivationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
sendActivationCode
default CompletableFuture<SendActivationCodeResponse> sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest) Sends an activation email to the email address associated with the specified email contact.
It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email.
This is a convenience which creates an instance of the
SendActivationCodeRequest.Builderavoiding the need to create one manually viaSendActivationCodeRequest.builder()- Parameters:
sendActivationCodeRequest- AConsumerthat will call methods onSendActivationCodeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SendActivationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts..
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Unexpected error during processing of request.
- ResourceNotFoundException Your request references a resource which does not exist.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- 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.
- NotificationsContactsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aNotificationsContactsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aNotificationsContactsAsyncClient.
-