Interface NotificationsContactsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface NotificationsContactsClient
extends AwsClient

Service client for accessing AWS User Notifications Contacts. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default ActivateEmailContactResponse	activateEmailContact(Consumer<ActivateEmailContactRequest.Builder> activateEmailContactRequest)	Activates an email contact using an activation code.
default ActivateEmailContactResponse	activateEmailContact(ActivateEmailContactRequest activateEmailContactRequest)	Activates an email contact using an activation code.
static NotificationsContactsClientBuilder	builder()	Create a builder that can be used to configure and create a NotificationsContactsClient.
static NotificationsContactsClient	create()	Create a NotificationsContactsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEmailContactResponse	createEmailContact(Consumer<CreateEmailContactRequest.Builder> createEmailContactRequest)	Creates an email contact for the provided email address.
default CreateEmailContactResponse	createEmailContact(CreateEmailContactRequest createEmailContactRequest)	Creates an email contact for the provided email address.
default DeleteEmailContactResponse	deleteEmailContact(Consumer<DeleteEmailContactRequest.Builder> deleteEmailContactRequest)	Deletes an email contact.
default DeleteEmailContactResponse	deleteEmailContact(DeleteEmailContactRequest deleteEmailContactRequest)	Deletes an email contact.
default GetEmailContactResponse	getEmailContact(Consumer<GetEmailContactRequest.Builder> getEmailContactRequest)	Returns an email contact.
default GetEmailContactResponse	getEmailContact(GetEmailContactRequest getEmailContactRequest)	Returns an email contact.
default ListEmailContactsResponse	listEmailContacts(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest)	Lists all email contacts created under the Account.
default ListEmailContactsResponse	listEmailContacts(ListEmailContactsRequest listEmailContactsRequest)	Lists all email contacts created under the Account.
default ListEmailContactsIterable	listEmailContactsPaginator(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest)	This is a variant of listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) operation.
default ListEmailContactsIterable	listEmailContactsPaginator(ListEmailContactsRequest listEmailContactsRequest)	This is a variant of listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
default SendActivationCodeResponse	sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)	Sends an activation email to the email address associated with the specified email contact.
default SendActivationCodeResponse	sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)	Sends an activation email to the email address associated with the specified email contact.
default NotificationsContactsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).
default 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

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

activateEmailContact

default ActivateEmailContactResponse activateEmailContact(ActivateEmailContactRequest activateEmailContactRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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:

Result of the ActivateEmailContact operation returned by the service.

See Also:

• AWS API Documentation

activateEmailContact

default ActivateEmailContactResponse activateEmailContact(Consumer<ActivateEmailContactRequest.Builder> activateEmailContactRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

activateEmailContactRequest - A Consumer that will call methods on ActivateEmailContactRequest.Builder to create a request.

Returns:

Result of the ActivateEmailContact operation returned by the service.

See Also:

• AWS API Documentation

createEmailContact

default CreateEmailContactResponse createEmailContact(CreateEmailContactRequest createEmailContactRequest)
                                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Creates an email contact for the provided email address.

Parameters:

createEmailContactRequest -

Returns:

Result of the CreateEmailContact operation returned by the service.

See Also:

• AWS API Documentation

createEmailContact

default CreateEmailContactResponse createEmailContact(Consumer<CreateEmailContactRequest.Builder> createEmailContactRequest)
                                               throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Creates an email contact for the provided email address.

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

Parameters:

createEmailContactRequest - A Consumer that will call methods on CreateEmailContactRequest.Builder to create a request.

Returns:

Result of the CreateEmailContact operation returned by the service.

See Also:

• AWS API Documentation

deleteEmailContact

default DeleteEmailContactResponse deleteEmailContact(DeleteEmailContactRequest deleteEmailContactRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Deletes an email contact.

Deleting an email contact removes it from all associated notification configurations.

Parameters:

deleteEmailContactRequest -

Returns:

Result of the DeleteEmailContact operation returned by the service.

See Also:

• AWS API Documentation

deleteEmailContact

default DeleteEmailContactResponse deleteEmailContact(Consumer<DeleteEmailContactRequest.Builder> deleteEmailContactRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

deleteEmailContactRequest - A Consumer that will call methods on DeleteEmailContactRequest.Builder to create a request.

Returns:

Result of the DeleteEmailContact operation returned by the service.

See Also:

• AWS API Documentation

getEmailContact

default GetEmailContactResponse getEmailContact(GetEmailContactRequest getEmailContactRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Returns an email contact.

Parameters:

getEmailContactRequest -

Returns:

Result of the GetEmailContact operation returned by the service.

See Also:

• AWS API Documentation

getEmailContact

default GetEmailContactResponse getEmailContact(Consumer<GetEmailContactRequest.Builder> getEmailContactRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Returns an email contact.

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

Parameters:

getEmailContactRequest - A Consumer that will call methods on GetEmailContactRequest.Builder to create a request.

Returns:

Result of the GetEmailContact operation returned by the service.

See Also:

• AWS API Documentation

listEmailContacts

default ListEmailContactsResponse listEmailContacts(ListEmailContactsRequest listEmailContactsRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Lists all email contacts created under the Account.

Parameters:

listEmailContactsRequest -

Returns:

Result of the ListEmailContacts operation returned by the service.

See Also:

• AWS API Documentation

listEmailContacts

default ListEmailContactsResponse listEmailContacts(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest)
                                             throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

Lists all email contacts created under the Account.

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

Parameters:

listEmailContactsRequest - A Consumer that will call methods on ListEmailContactsRequest.Builder to create a request.

Returns:

Result of the ListEmailContacts operation returned by the service.

See Also:

• AWS API Documentation

listEmailContactsPaginator

default ListEmailContactsIterable listEmailContactsPaginator(ListEmailContactsRequest listEmailContactsRequest)
                                                      throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

This is a variant of listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) 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

 
 software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client.listEmailContactsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client
             .listEmailContactsPaginator(request);
     for (software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client.listEmailContactsPaginator(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 listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) operation.

Parameters:

listEmailContactsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listEmailContactsPaginator

default ListEmailContactsIterable listEmailContactsPaginator(Consumer<ListEmailContactsRequest.Builder> listEmailContactsRequest)
                                                      throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

This is a variant of listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) 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

 
 software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client.listEmailContactsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client
             .listEmailContactsPaginator(request);
     for (software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.notificationscontacts.paginators.ListEmailContactsIterable responses = client.listEmailContactsPaginator(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 listEmailContacts(software.amazon.awssdk.services.notificationscontacts.model.ListEmailContactsRequest) operation.

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

Parameters:

listEmailContactsRequest - A Consumer that will call methods on ListEmailContactsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

sendActivationCode

default SendActivationCodeResponse sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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:

Result of the SendActivationCode operation returned by the service.

See Also:

• AWS API Documentation

sendActivationCode

default SendActivationCodeResponse sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

sendActivationCodeRequest - A Consumer that will call methods on SendActivationCodeRequest.Builder to create a request.

Returns:

Result of the SendActivationCode operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
NotificationsContactsException

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static NotificationsContactsClient create()

Create a NotificationsContactsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static NotificationsContactsClientBuilder builder()

Create a builder that can be used to configure and create a NotificationsContactsClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default NotificationsContactsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration