Interface EndUserMessagingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.

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
static EndUserMessagingClientBuilder	builder()	Create a builder that can be used to configure and create a EndUserMessagingClient.
static EndUserMessagingClient	create()	Create a EndUserMessagingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBrandProfileResponse	createBrandProfile(Consumer<CreateBrandProfileRequest.Builder> createBrandProfileRequest)	Creates a brand profile.
default CreateBrandProfileResponse	createBrandProfile(CreateBrandProfileRequest createBrandProfileRequest)	Creates a brand profile.
default CreateBrandProfileAttributesResponse	createBrandProfileAttributes(Consumer<CreateBrandProfileAttributesRequest.Builder> createBrandProfileAttributesRequest)	Creates up to 10 attributes for a brand profile in a single request.
default CreateBrandProfileAttributesResponse	createBrandProfileAttributes(CreateBrandProfileAttributesRequest createBrandProfileAttributesRequest)	Creates up to 10 attributes for a brand profile in a single request.
default CreateBrandProfileFromRegistrationResponse	createBrandProfileFromRegistration(Consumer<CreateBrandProfileFromRegistrationRequest.Builder> createBrandProfileFromRegistrationRequest)	Creates a brand profile and populates its attributes from an existing registration.
default CreateBrandProfileFromRegistrationResponse	createBrandProfileFromRegistration(CreateBrandProfileFromRegistrationRequest createBrandProfileFromRegistrationRequest)	Creates a brand profile and populates its attributes from an existing registration.
default CreateNotifyCodeConfigurationResponse	createNotifyCodeConfiguration(Consumer<CreateNotifyCodeConfigurationRequest.Builder> createNotifyCodeConfigurationRequest)	Creates a notify code configuration.
default CreateNotifyCodeConfigurationResponse	createNotifyCodeConfiguration(CreateNotifyCodeConfigurationRequest createNotifyCodeConfigurationRequest)	Creates a notify code configuration.
default CreateRegistrationsFromBrandProfileResponse	createRegistrationsFromBrandProfile(Consumer<CreateRegistrationsFromBrandProfileRequest.Builder> createRegistrationsFromBrandProfileRequest)	Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile.
default CreateRegistrationsFromBrandProfileResponse	createRegistrationsFromBrandProfile(CreateRegistrationsFromBrandProfileRequest createRegistrationsFromBrandProfileRequest)	Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile.
default DeleteBrandProfileResponse	deleteBrandProfile(Consumer<DeleteBrandProfileRequest.Builder> deleteBrandProfileRequest)	Deletes a brand profile.
default DeleteBrandProfileResponse	deleteBrandProfile(DeleteBrandProfileRequest deleteBrandProfileRequest)	Deletes a brand profile.
default DeleteBrandProfileAttributeResponse	deleteBrandProfileAttribute(Consumer<DeleteBrandProfileAttributeRequest.Builder> deleteBrandProfileAttributeRequest)	Deletes a brand profile attribute.
default DeleteBrandProfileAttributeResponse	deleteBrandProfileAttribute(DeleteBrandProfileAttributeRequest deleteBrandProfileAttributeRequest)	Deletes a brand profile attribute.
default DeleteNotifyCodeConfigurationResponse	deleteNotifyCodeConfiguration(Consumer<DeleteNotifyCodeConfigurationRequest.Builder> deleteNotifyCodeConfigurationRequest)	Deletes a notify code configuration.
default DeleteNotifyCodeConfigurationResponse	deleteNotifyCodeConfiguration(DeleteNotifyCodeConfigurationRequest deleteNotifyCodeConfigurationRequest)	Deletes a notify code configuration.
default GetBrandProfileResponse	getBrandProfile(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest)	Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps.
default GetBrandProfileResponse	getBrandProfile(GetBrandProfileRequest getBrandProfileRequest)	Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps.
default GetBrandProfileAttributeResponse	getBrandProfileAttribute(Consumer<GetBrandProfileAttributeRequest.Builder> getBrandProfileAttributeRequest)	Retrieves a single brand profile attribute.
default GetBrandProfileAttributeResponse	getBrandProfileAttribute(GetBrandProfileAttributeRequest getBrandProfileAttributeRequest)	Retrieves a single brand profile attribute.
default GetJobResponse	getJob(Consumer<GetJobRequest.Builder> getJobRequest)	Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
default GetJobResponse	getJob(GetJobRequest getJobRequest)	Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.
default GetNotifyCodeConfigurationResponse	getNotifyCodeConfiguration(Consumer<GetNotifyCodeConfigurationRequest.Builder> getNotifyCodeConfigurationRequest)	Retrieves a notify code configuration.
default GetNotifyCodeConfigurationResponse	getNotifyCodeConfiguration(GetNotifyCodeConfigurationRequest getNotifyCodeConfigurationRequest)	Retrieves a notify code configuration.
default ListBrandProfileAttributesResponse	listBrandProfileAttributes(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)	Retrieves a paginated list of the attributes for a brand profile.
default ListBrandProfileAttributesResponse	listBrandProfileAttributes(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)	Retrieves a paginated list of the attributes for a brand profile.
default ListBrandProfileAttributesIterable	listBrandProfileAttributesPaginator(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)	This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.
default ListBrandProfileAttributesIterable	listBrandProfileAttributesPaginator(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)	This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.
default ListBrandProfilesResponse	listBrandProfiles(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)	Retrieves a paginated list of the brand profiles in your account.
default ListBrandProfilesResponse	listBrandProfiles(ListBrandProfilesRequest listBrandProfilesRequest)	Retrieves a paginated list of the brand profiles in your account.
default ListBrandProfilesIterable	listBrandProfilesPaginator(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)	This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.
default ListBrandProfilesIterable	listBrandProfilesPaginator(ListBrandProfilesRequest listBrandProfilesRequest)	This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.
default ListJobsResponse	listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)	Retrieves a paginated list of the asynchronous jobs in your account.
default ListJobsResponse	listJobs(ListJobsRequest listJobsRequest)	Retrieves a paginated list of the asynchronous jobs in your account.
default ListJobsIterable	listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)	This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.
default ListJobsIterable	listJobsPaginator(ListJobsRequest listJobsRequest)	This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.
default ListNotifyCodeConfigurationsResponse	listNotifyCodeConfigurations(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)	Retrieves a paginated list of the notify code configurations in your account.
default ListNotifyCodeConfigurationsResponse	listNotifyCodeConfigurations(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)	Retrieves a paginated list of the notify code configurations in your account.
default ListNotifyCodeConfigurationsIterable	listNotifyCodeConfigurationsPaginator(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)	This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.
default ListNotifyCodeConfigurationsIterable	listNotifyCodeConfigurationsPaginator(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)	This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.
default ListRegistrationsFromBrandProfileResponse	listRegistrationsFromBrandProfile(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)	Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
default ListRegistrationsFromBrandProfileResponse	listRegistrationsFromBrandProfile(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)	Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.
default ListRegistrationsFromBrandProfileIterable	listRegistrationsFromBrandProfilePaginator(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)	This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.
default ListRegistrationsFromBrandProfileIterable	listRegistrationsFromBrandProfilePaginator(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)	This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves the tags that are associated with a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves the tags that are associated with a resource.
default SendNotifyCodeVerificationResponse	sendNotifyCodeVerification(Consumer<SendNotifyCodeVerificationRequest.Builder> sendNotifyCodeVerificationRequest)	Generates a one-time passcode and delivers it to a recipient over the requested channel.
default SendNotifyCodeVerificationResponse	sendNotifyCodeVerification(SendNotifyCodeVerificationRequest sendNotifyCodeVerificationRequest)	Generates a one-time passcode and delivers it to a recipient over the requested channel.
default EndUserMessagingServiceClientConfiguration	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)	Adds or overwrites the tags on a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or overwrites the tags on a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags from a resource.
default UpdateBrandProfileResponse	updateBrandProfile(Consumer<UpdateBrandProfileRequest.Builder> updateBrandProfileRequest)	Updates the name or the deletion protection setting of a brand profile.
default UpdateBrandProfileResponse	updateBrandProfile(UpdateBrandProfileRequest updateBrandProfileRequest)	Updates the name or the deletion protection setting of a brand profile.
default UpdateBrandProfileAttributeResponse	updateBrandProfileAttribute(Consumer<UpdateBrandProfileAttributeRequest.Builder> updateBrandProfileAttributeRequest)	Updates the value, description, or category of an existing brand profile attribute.
default UpdateBrandProfileAttributeResponse	updateBrandProfileAttribute(UpdateBrandProfileAttributeRequest updateBrandProfileAttributeRequest)	Updates the value, description, or category of an existing brand profile attribute.
default UpdateBrandProfileFromRegistrationResponse	updateBrandProfileFromRegistration(Consumer<UpdateBrandProfileFromRegistrationRequest.Builder> updateBrandProfileFromRegistrationRequest)	Imports or refreshes the attributes of an existing brand profile from an existing registration.
default UpdateBrandProfileFromRegistrationResponse	updateBrandProfileFromRegistration(UpdateBrandProfileFromRegistrationRequest updateBrandProfileFromRegistrationRequest)	Imports or refreshes the attributes of an existing brand profile from an existing registration.
default UpdateNotifyCodeConfigurationResponse	updateNotifyCodeConfiguration(Consumer<UpdateNotifyCodeConfigurationRequest.Builder> updateNotifyCodeConfigurationRequest)	Updates the mutable fields of a notify code configuration.
default UpdateNotifyCodeConfigurationResponse	updateNotifyCodeConfiguration(UpdateNotifyCodeConfigurationRequest updateNotifyCodeConfigurationRequest)	Updates the mutable fields of a notify code configuration.
default UpdateRegistrationsFromBrandProfileResponse	updateRegistrationsFromBrandProfile(Consumer<UpdateRegistrationsFromBrandProfileRequest.Builder> updateRegistrationsFromBrandProfileRequest)	Repushes the attributes of a brand profile into existing DRAFT registrations.
default UpdateRegistrationsFromBrandProfileResponse	updateRegistrationsFromBrandProfile(UpdateRegistrationsFromBrandProfileRequest updateRegistrationsFromBrandProfileRequest)	Repushes the attributes of a brand profile into existing DRAFT registrations.
default ValidateNotifyCodeVerificationResponse	validateNotifyCodeVerification(Consumer<ValidateNotifyCodeVerificationRequest.Builder> validateNotifyCodeVerificationRequest)	Validates a one-time passcode that a recipient submitted.
default ValidateNotifyCodeVerificationResponse	validateNotifyCodeVerification(ValidateNotifyCodeVerificationRequest validateNotifyCodeVerificationRequest)	Validates a one-time passcode that a recipient submitted.
default EndUserMessagingWaiter	waiter()	Create an instance of EndUserMessagingWaiter using this client.

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

createBrandProfile

default CreateBrandProfileResponse createBrandProfile(CreateBrandProfileRequest createBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.

Parameters:

createBrandProfileRequest -

Returns:

Result of the CreateBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

createBrandProfile

default CreateBrandProfileResponse createBrandProfile(Consumer<CreateBrandProfileRequest.Builder> createBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.

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

Parameters:

createBrandProfileRequest - A Consumer that will call methods on CreateBrandProfileRequest.Builder to create a request.

Returns:

Result of the CreateBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

createBrandProfileAttributes

default CreateBrandProfileAttributesResponse createBrandProfileAttributes(CreateBrandProfileAttributesRequest createBrandProfileAttributesRequest)
                                                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.

Parameters:

createBrandProfileAttributesRequest -

Returns:

Result of the CreateBrandProfileAttributes operation returned by the service.

See Also:

• AWS API Documentation

createBrandProfileAttributes

default CreateBrandProfileAttributesResponse createBrandProfileAttributes(Consumer<CreateBrandProfileAttributesRequest.Builder> createBrandProfileAttributesRequest)
                                                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates up to 10 attributes for a brand profile in a single request. For attributes of type IMAGE or DOCUMENT, the response includes a presigned Amazon S3 URL that you use to upload the media. This operation is atomic: either all of the attributes are created, or none of them are.

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

Parameters:

createBrandProfileAttributesRequest - A Consumer that will call methods on CreateBrandProfileAttributesRequest.Builder to create a request.

Returns:

Result of the CreateBrandProfileAttributes operation returned by the service.

See Also:

• AWS API Documentation

createBrandProfileFromRegistration

default CreateBrandProfileFromRegistrationResponse createBrandProfileFromRegistration(CreateBrandProfileFromRegistrationRequest createBrandProfileFromRegistrationRequest)
                                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

Parameters:

createBrandProfileFromRegistrationRequest -

Returns:

Result of the CreateBrandProfileFromRegistration operation returned by the service.

See Also:

• AWS API Documentation

createBrandProfileFromRegistration

default CreateBrandProfileFromRegistrationResponse createBrandProfileFromRegistration(Consumer<CreateBrandProfileFromRegistrationRequest.Builder> createBrandProfileFromRegistrationRequest)
                                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

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

Parameters:

createBrandProfileFromRegistrationRequest - A Consumer that will call methods on CreateBrandProfileFromRegistrationRequest.Builder to create a request.

Returns:

Result of the CreateBrandProfileFromRegistration operation returned by the service.

See Also:

• AWS API Documentation

createNotifyCodeConfiguration

default CreateNotifyCodeConfigurationResponse createNotifyCodeConfiguration(CreateNotifyCodeConfigurationRequest createNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.

Parameters:

createNotifyCodeConfigurationRequest -

Returns:

Result of the CreateNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createNotifyCodeConfiguration

default CreateNotifyCodeConfigurationResponse createNotifyCodeConfiguration(Consumer<CreateNotifyCodeConfigurationRequest.Builder> createNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates a notify code configuration. A notify code configuration is a reusable policy that defines how one-time passcodes are generated and rendered, including the code type, length, validity period, maximum number of attempts, and channel templates.

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

Parameters:

createNotifyCodeConfigurationRequest - A Consumer that will call methods on CreateNotifyCodeConfigurationRequest.Builder to create a request.

Returns:

Result of the CreateNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createRegistrationsFromBrandProfile

default CreateRegistrationsFromBrandProfileResponse createRegistrationsFromBrandProfile(CreateRegistrationsFromBrandProfileRequest createRegistrationsFromBrandProfileRequest)
                                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.

Parameters:

createRegistrationsFromBrandProfileRequest -

Returns:

Result of the CreateRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

createRegistrationsFromBrandProfile

default CreateRegistrationsFromBrandProfileResponse createRegistrationsFromBrandProfile(Consumer<CreateRegistrationsFromBrandProfileRequest.Builder> createRegistrationsFromBrandProfileRequest)
                                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.

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

Parameters:

createRegistrationsFromBrandProfileRequest - A Consumer that will call methods on CreateRegistrationsFromBrandProfileRequest.Builder to create a request.

Returns:

Result of the CreateRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteBrandProfile

default DeleteBrandProfileResponse deleteBrandProfile(DeleteBrandProfileRequest deleteBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.

Parameters:

deleteBrandProfileRequest -

Returns:

Result of the DeleteBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteBrandProfile

default DeleteBrandProfileResponse deleteBrandProfile(Consumer<DeleteBrandProfileRequest.Builder> deleteBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a brand profile. This operation also deletes the attributes of the profile and any associated media. The request fails if deletion protection is enabled for the profile.

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

Parameters:

deleteBrandProfileRequest - A Consumer that will call methods on DeleteBrandProfileRequest.Builder to create a request.

Returns:

Result of the DeleteBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteBrandProfileAttribute

default DeleteBrandProfileAttributeResponse deleteBrandProfileAttribute(DeleteBrandProfileAttributeRequest deleteBrandProfileAttributeRequest)
                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.

Parameters:

deleteBrandProfileAttributeRequest -

Returns:

Result of the DeleteBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

deleteBrandProfileAttribute

default DeleteBrandProfileAttributeResponse deleteBrandProfileAttribute(Consumer<DeleteBrandProfileAttributeRequest.Builder> deleteBrandProfileAttributeRequest)
                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a brand profile attribute. If the attribute stores media, this operation also deletes the associated media.

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

Parameters:

deleteBrandProfileAttributeRequest - A Consumer that will call methods on DeleteBrandProfileAttributeRequest.Builder to create a request.

Returns:

Result of the DeleteBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

deleteNotifyCodeConfiguration

default DeleteNotifyCodeConfigurationResponse deleteNotifyCodeConfiguration(DeleteNotifyCodeConfigurationRequest deleteNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.

Parameters:

deleteNotifyCodeConfigurationRequest -

Returns:

Result of the DeleteNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteNotifyCodeConfiguration

default DeleteNotifyCodeConfigurationResponse deleteNotifyCodeConfiguration(Consumer<DeleteNotifyCodeConfigurationRequest.Builder> deleteNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Deletes a notify code configuration. Verifications that are already in progress are not affected, because they capture the policy at the time that the passcode was sent.

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

Parameters:

deleteNotifyCodeConfigurationRequest - A Consumer that will call methods on DeleteNotifyCodeConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getBrandProfile

default GetBrandProfileResponse getBrandProfile(GetBrandProfileRequest getBrandProfileRequest)
                                         throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.

Parameters:

getBrandProfileRequest -

Returns:

Result of the GetBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

getBrandProfile

default GetBrandProfileResponse getBrandProfile(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest)
                                         throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.

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

Parameters:

getBrandProfileRequest - A Consumer that will call methods on GetBrandProfileRequest.Builder to create a request.

Returns:

Result of the GetBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

getBrandProfileAttribute

default GetBrandProfileAttributeResponse getBrandProfileAttribute(GetBrandProfileAttributeRequest getBrandProfileAttributeRequest)
                                                           throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a single brand profile attribute.

Parameters:

getBrandProfileAttributeRequest -

Returns:

Result of the GetBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

getBrandProfileAttribute

default GetBrandProfileAttributeResponse getBrandProfileAttribute(Consumer<GetBrandProfileAttributeRequest.Builder> getBrandProfileAttributeRequest)
                                                           throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a single brand profile attribute.

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

Parameters:

getBrandProfileAttributeRequest - A Consumer that will call methods on GetBrandProfileAttributeRequest.Builder to create a request.

Returns:

Result of the GetBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

getJob

default GetJobResponse getJob(GetJobRequest getJobRequest)
                       throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

Parameters:

getJobRequest -

Returns:

Result of the GetJob operation returned by the service.

See Also:

• AWS API Documentation

getJob

default GetJobResponse getJob(Consumer<GetJobRequest.Builder> getJobRequest)
                       throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

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

Parameters:

getJobRequest - A Consumer that will call methods on GetJobRequest.Builder to create a request.

Returns:

Result of the GetJob operation returned by the service.

See Also:

• AWS API Documentation

getNotifyCodeConfiguration

default GetNotifyCodeConfigurationResponse getNotifyCodeConfiguration(GetNotifyCodeConfigurationRequest getNotifyCodeConfigurationRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a notify code configuration.

Parameters:

getNotifyCodeConfigurationRequest -

Returns:

Result of the GetNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getNotifyCodeConfiguration

default GetNotifyCodeConfigurationResponse getNotifyCodeConfiguration(Consumer<GetNotifyCodeConfigurationRequest.Builder> getNotifyCodeConfigurationRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a notify code configuration.

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

Parameters:

getNotifyCodeConfigurationRequest - A Consumer that will call methods on GetNotifyCodeConfigurationRequest.Builder to create a request.

Returns:

Result of the GetNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

listBrandProfileAttributes

default ListBrandProfileAttributesResponse listBrandProfileAttributes(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the attributes for a brand profile.

Parameters:

listBrandProfileAttributesRequest -

Returns:

Result of the ListBrandProfileAttributes operation returned by the service.

See Also:

• AWS API Documentation

listBrandProfileAttributes

default ListBrandProfileAttributesResponse listBrandProfileAttributes(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the attributes for a brand profile.

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

Parameters:

listBrandProfileAttributesRequest - A Consumer that will call methods on ListBrandProfileAttributesRequest.Builder to create a request.

Returns:

Result of the ListBrandProfileAttributes operation returned by the service.

See Also:

• AWS API Documentation

listBrandProfileAttributesPaginator

default ListBrandProfileAttributesIterable listBrandProfileAttributesPaginator(ListBrandProfileAttributesRequest listBrandProfileAttributesRequest)
                                                                        throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) 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.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client.listBrandProfileAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client
             .listBrandProfileAttributesPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client.listBrandProfileAttributesPaginator(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 listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.

Parameters:

listBrandProfileAttributesRequest -

Returns:

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

See Also:

• AWS API Documentation

listBrandProfileAttributesPaginator

default ListBrandProfileAttributesIterable listBrandProfileAttributesPaginator(Consumer<ListBrandProfileAttributesRequest.Builder> listBrandProfileAttributesRequest)
                                                                        throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) 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.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client.listBrandProfileAttributesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client
             .listBrandProfileAttributesPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfileAttributesIterable responses = client.listBrandProfileAttributesPaginator(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 listBrandProfileAttributes(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfileAttributesRequest) operation.

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

Parameters:

listBrandProfileAttributesRequest - A Consumer that will call methods on ListBrandProfileAttributesRequest.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

listBrandProfiles

default ListBrandProfilesResponse listBrandProfiles(ListBrandProfilesRequest listBrandProfilesRequest)
                                             throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.

Parameters:

listBrandProfilesRequest -

Returns:

Result of the ListBrandProfiles operation returned by the service.

See Also:

• AWS API Documentation

listBrandProfiles

default ListBrandProfilesResponse listBrandProfiles(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)
                                             throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.

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

Parameters:

listBrandProfilesRequest - A Consumer that will call methods on ListBrandProfilesRequest.Builder to create a request.

Returns:

Result of the ListBrandProfiles operation returned by the service.

See Also:

• AWS API Documentation

listBrandProfilesPaginator

default ListBrandProfilesIterable listBrandProfilesPaginator(ListBrandProfilesRequest listBrandProfilesRequest)
                                                      throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) 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.endusermessaging.paginators.ListBrandProfilesIterable responses = client.listBrandProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesIterable responses = client
             .listBrandProfilesPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesIterable responses = client.listBrandProfilesPaginator(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 listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.

Parameters:

listBrandProfilesRequest -

Returns:

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

See Also:

• AWS API Documentation

listBrandProfilesPaginator

default ListBrandProfilesIterable listBrandProfilesPaginator(Consumer<ListBrandProfilesRequest.Builder> listBrandProfilesRequest)
                                                      throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) 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.endusermessaging.paginators.ListBrandProfilesIterable responses = client.listBrandProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesIterable responses = client
             .listBrandProfilesPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListBrandProfilesIterable responses = client.listBrandProfilesPaginator(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 listBrandProfiles(software.amazon.awssdk.services.endusermessaging.model.ListBrandProfilesRequest) operation.

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

Parameters:

listBrandProfilesRequest - A Consumer that will call methods on ListBrandProfilesRequest.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

listJobs

default ListJobsResponse listJobs(ListJobsRequest listJobsRequest)
                           throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.

Parameters:

listJobsRequest -

Returns:

Result of the ListJobs operation returned by the service.

See Also:

• AWS API Documentation

listJobs

default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
                           throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the asynchronous jobs in your account. You can filter the results by status, brand profile, or operation type.

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

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request.

Returns:

Result of the ListJobs operation returned by the service.

See Also:

• AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest)
                                    throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) 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.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(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 listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.

Parameters:

listJobsRequest -

Returns:

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

See Also:

• AWS API Documentation

listJobsPaginator

default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
                                    throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) 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.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListJobsIterable responses = client.listJobsPaginator(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 listJobs(software.amazon.awssdk.services.endusermessaging.model.ListJobsRequest) operation.

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

Parameters:

listJobsRequest - A Consumer that will call methods on ListJobsRequest.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

listNotifyCodeConfigurations

default ListNotifyCodeConfigurationsResponse listNotifyCodeConfigurations(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)
                                                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the notify code configurations in your account.

Parameters:

listNotifyCodeConfigurationsRequest -

Returns:

Result of the ListNotifyCodeConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listNotifyCodeConfigurations

default ListNotifyCodeConfigurationsResponse listNotifyCodeConfigurations(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)
                                                                   throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the notify code configurations in your account.

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

Parameters:

listNotifyCodeConfigurationsRequest - A Consumer that will call methods on ListNotifyCodeConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListNotifyCodeConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listNotifyCodeConfigurationsPaginator

default ListNotifyCodeConfigurationsIterable listNotifyCodeConfigurationsPaginator(ListNotifyCodeConfigurationsRequest listNotifyCodeConfigurationsRequest)
                                                                            throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) 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.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client.listNotifyCodeConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client
             .listNotifyCodeConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client.listNotifyCodeConfigurationsPaginator(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 listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.

Parameters:

listNotifyCodeConfigurationsRequest -

Returns:

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

See Also:

• AWS API Documentation

listNotifyCodeConfigurationsPaginator

default ListNotifyCodeConfigurationsIterable listNotifyCodeConfigurationsPaginator(Consumer<ListNotifyCodeConfigurationsRequest.Builder> listNotifyCodeConfigurationsRequest)
                                                                            throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) 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.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client.listNotifyCodeConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client
             .listNotifyCodeConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListNotifyCodeConfigurationsIterable responses = client.listNotifyCodeConfigurationsPaginator(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 listNotifyCodeConfigurations(software.amazon.awssdk.services.endusermessaging.model.ListNotifyCodeConfigurationsRequest) operation.

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

Parameters:

listNotifyCodeConfigurationsRequest - A Consumer that will call methods on ListNotifyCodeConfigurationsRequest.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

listRegistrationsFromBrandProfile

default ListRegistrationsFromBrandProfileResponse listRegistrationsFromBrandProfile(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)
                                                                             throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.

Parameters:

listRegistrationsFromBrandProfileRequest -

Returns:

Result of the ListRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

listRegistrationsFromBrandProfile

default ListRegistrationsFromBrandProfileResponse listRegistrationsFromBrandProfile(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)
                                                                             throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.

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

Parameters:

listRegistrationsFromBrandProfileRequest - A Consumer that will call methods on ListRegistrationsFromBrandProfileRequest.Builder to create a request.

Returns:

Result of the ListRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

listRegistrationsFromBrandProfilePaginator

default ListRegistrationsFromBrandProfileIterable listRegistrationsFromBrandProfilePaginator(ListRegistrationsFromBrandProfileRequest listRegistrationsFromBrandProfileRequest)
                                                                                      throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) 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.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client.listRegistrationsFromBrandProfilePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client
             .listRegistrationsFromBrandProfilePaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client.listRegistrationsFromBrandProfilePaginator(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 listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.

Parameters:

listRegistrationsFromBrandProfileRequest -

Returns:

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

See Also:

• AWS API Documentation

listRegistrationsFromBrandProfilePaginator

default ListRegistrationsFromBrandProfileIterable listRegistrationsFromBrandProfilePaginator(Consumer<ListRegistrationsFromBrandProfileRequest.Builder> listRegistrationsFromBrandProfileRequest)
                                                                                      throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

This is a variant of listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) 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.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client.listRegistrationsFromBrandProfilePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client
             .listRegistrationsFromBrandProfilePaginator(request);
     for (software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.endusermessaging.paginators.ListRegistrationsFromBrandProfileIterable responses = client.listRegistrationsFromBrandProfilePaginator(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 listRegistrationsFromBrandProfile(software.amazon.awssdk.services.endusermessaging.model.ListRegistrationsFromBrandProfileRequest) operation.

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

Parameters:

listRegistrationsFromBrandProfileRequest - A Consumer that will call methods on ListRegistrationsFromBrandProfileRequest.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 ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the tags that are associated with a resource.

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 ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Retrieves the tags that are associated with a resource.

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

sendNotifyCodeVerification

default SendNotifyCodeVerificationResponse sendNotifyCodeVerification(SendNotifyCodeVerificationRequest sendNotifyCodeVerificationRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.

Parameters:

sendNotifyCodeVerificationRequest -

Returns:

Result of the SendNotifyCodeVerification operation returned by the service.

See Also:

• AWS API Documentation

sendNotifyCodeVerification

default SendNotifyCodeVerificationResponse sendNotifyCodeVerification(Consumer<SendNotifyCodeVerificationRequest.Builder> sendNotifyCodeVerificationRequest)
                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Generates a one-time passcode and delivers it to a recipient over the requested channel. The passcode policy is captured from the referenced notify code configuration at the time of the request, so later updates to the configuration do not affect verifications that are already in progress.

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

Parameters:

sendNotifyCodeVerificationRequest - A Consumer that will call methods on SendNotifyCodeVerificationRequest.Builder to create a request.

Returns:

Result of the SendNotifyCodeVerification operation returned by the service.

See Also:

• AWS API Documentation

tagResource

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

Adds or overwrites the tags on a resource.

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 ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Adds or overwrites the tags on a resource.

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

Parameters:

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

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

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

Removes the specified tags from a resource.

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 ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Removes the specified tags from a resource.

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

updateBrandProfile

default UpdateBrandProfileResponse updateBrandProfile(UpdateBrandProfileRequest updateBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.

Parameters:

updateBrandProfileRequest -

Returns:

Result of the UpdateBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

updateBrandProfile

default UpdateBrandProfileResponse updateBrandProfile(Consumer<UpdateBrandProfileRequest.Builder> updateBrandProfileRequest)
                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.

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

Parameters:

updateBrandProfileRequest - A Consumer that will call methods on UpdateBrandProfileRequest.Builder to create a request.

Returns:

Result of the UpdateBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

updateBrandProfileAttribute

default UpdateBrandProfileAttributeResponse updateBrandProfileAttribute(UpdateBrandProfileAttributeRequest updateBrandProfileAttributeRequest)
                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the value, description, or category of an existing brand profile attribute.

Parameters:

updateBrandProfileAttributeRequest -

Returns:

Result of the UpdateBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

updateBrandProfileAttribute

default UpdateBrandProfileAttributeResponse updateBrandProfileAttribute(Consumer<UpdateBrandProfileAttributeRequest.Builder> updateBrandProfileAttributeRequest)
                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the value, description, or category of an existing brand profile attribute.

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

Parameters:

updateBrandProfileAttributeRequest - A Consumer that will call methods on UpdateBrandProfileAttributeRequest.Builder to create a request.

Returns:

Result of the UpdateBrandProfileAttribute operation returned by the service.

See Also:

• AWS API Documentation

updateBrandProfileFromRegistration

default UpdateBrandProfileFromRegistrationResponse updateBrandProfileFromRegistration(UpdateBrandProfileFromRegistrationRequest updateBrandProfileFromRegistrationRequest)
                                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

Parameters:

updateBrandProfileFromRegistrationRequest -

Returns:

Result of the UpdateBrandProfileFromRegistration operation returned by the service.

See Also:

• AWS API Documentation

updateBrandProfileFromRegistration

default UpdateBrandProfileFromRegistrationResponse updateBrandProfileFromRegistration(Consumer<UpdateBrandProfileFromRegistrationRequest.Builder> updateBrandProfileFromRegistrationRequest)
                                                                               throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

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

Parameters:

updateBrandProfileFromRegistrationRequest - A Consumer that will call methods on UpdateBrandProfileFromRegistrationRequest.Builder to create a request.

Returns:

Result of the UpdateBrandProfileFromRegistration operation returned by the service.

See Also:

• AWS API Documentation

updateNotifyCodeConfiguration

default UpdateNotifyCodeConfigurationResponse updateNotifyCodeConfiguration(UpdateNotifyCodeConfigurationRequest updateNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.

Parameters:

updateNotifyCodeConfigurationRequest -

Returns:

Result of the UpdateNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateNotifyCodeConfiguration

default UpdateNotifyCodeConfigurationResponse updateNotifyCodeConfiguration(Consumer<UpdateNotifyCodeConfigurationRequest.Builder> updateNotifyCodeConfigurationRequest)
                                                                     throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.

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

Parameters:

updateNotifyCodeConfigurationRequest - A Consumer that will call methods on UpdateNotifyCodeConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateNotifyCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateRegistrationsFromBrandProfile

default UpdateRegistrationsFromBrandProfileResponse updateRegistrationsFromBrandProfile(UpdateRegistrationsFromBrandProfileRequest updateRegistrationsFromBrandProfileRequest)
                                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.

Parameters:

updateRegistrationsFromBrandProfileRequest -

Returns:

Result of the UpdateRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

updateRegistrationsFromBrandProfile

default UpdateRegistrationsFromBrandProfileResponse updateRegistrationsFromBrandProfile(Consumer<UpdateRegistrationsFromBrandProfileRequest.Builder> updateRegistrationsFromBrandProfileRequest)
                                                                                 throws ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.

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

Parameters:

updateRegistrationsFromBrandProfileRequest - A Consumer that will call methods on UpdateRegistrationsFromBrandProfileRequest.Builder to create a request.

Returns:

Result of the UpdateRegistrationsFromBrandProfile operation returned by the service.

See Also:

• AWS API Documentation

validateNotifyCodeVerification

default ValidateNotifyCodeVerificationResponse validateNotifyCodeVerification(ValidateNotifyCodeVerificationRequest validateNotifyCodeVerificationRequest)
                                                                       throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.

Parameters:

validateNotifyCodeVerificationRequest -

Returns:

Result of the ValidateNotifyCodeVerification operation returned by the service.

See Also:

• AWS API Documentation

validateNotifyCodeVerification

default ValidateNotifyCodeVerificationResponse validateNotifyCodeVerification(Consumer<ValidateNotifyCodeVerificationRequest.Builder> validateNotifyCodeVerificationRequest)
                                                                       throws ValidationException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
AwsServiceException,
SdkClientException,
EndUserMessagingException

Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.

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

Parameters:

validateNotifyCodeVerificationRequest - A Consumer that will call methods on ValidateNotifyCodeVerificationRequest.Builder to create a request.

Returns:

Result of the ValidateNotifyCodeVerification operation returned by the service.

See Also:

• AWS API Documentation

waiter

default EndUserMessagingWaiter waiter()

Create an instance of EndUserMessagingWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of EndUserMessagingWaiter

create

static EndUserMessagingClient create()

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

builder

static EndUserMessagingClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default EndUserMessagingServiceClientConfiguration 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