Interface SocialMessagingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.

The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.

If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications. The guide also provides key information, such as integration with other Amazon Web Services services, and the quotas that apply to use of the service.

Regional availability

The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.

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 AssociateWhatsAppBusinessAccountResponse	associateWhatsAppBusinessAccount(Consumer<AssociateWhatsAppBusinessAccountRequest.Builder> associateWhatsAppBusinessAccountRequest)	This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.
default AssociateWhatsAppBusinessAccountResponse	associateWhatsAppBusinessAccount(AssociateWhatsAppBusinessAccountRequest associateWhatsAppBusinessAccountRequest)	This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.
static SocialMessagingClientBuilder	builder()	Create a builder that can be used to configure and create a SocialMessagingClient.
static SocialMessagingClient	create()	Create a SocialMessagingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateWhatsAppMessageTemplateResponse	createWhatsAppMessageTemplate(Consumer<CreateWhatsAppMessageTemplateRequest.Builder> createWhatsAppMessageTemplateRequest)	Creates a new WhatsApp message template from a custom definition.
default CreateWhatsAppMessageTemplateResponse	createWhatsAppMessageTemplate(CreateWhatsAppMessageTemplateRequest createWhatsAppMessageTemplateRequest)	Creates a new WhatsApp message template from a custom definition.
default CreateWhatsAppMessageTemplateFromLibraryResponse	createWhatsAppMessageTemplateFromLibrary(Consumer<CreateWhatsAppMessageTemplateFromLibraryRequest.Builder> createWhatsAppMessageTemplateFromLibraryRequest)	Creates a new WhatsApp message template using a template from Meta's template library.
default CreateWhatsAppMessageTemplateFromLibraryResponse	createWhatsAppMessageTemplateFromLibrary(CreateWhatsAppMessageTemplateFromLibraryRequest createWhatsAppMessageTemplateFromLibraryRequest)	Creates a new WhatsApp message template using a template from Meta's template library.
default CreateWhatsAppMessageTemplateMediaResponse	createWhatsAppMessageTemplateMedia(Consumer<CreateWhatsAppMessageTemplateMediaRequest.Builder> createWhatsAppMessageTemplateMediaRequest)	Uploads media for use in a WhatsApp message template.
default CreateWhatsAppMessageTemplateMediaResponse	createWhatsAppMessageTemplateMedia(CreateWhatsAppMessageTemplateMediaRequest createWhatsAppMessageTemplateMediaRequest)	Uploads media for use in a WhatsApp message template.
default DeleteWhatsAppMessageMediaResponse	deleteWhatsAppMessageMedia(Consumer<DeleteWhatsAppMessageMediaRequest.Builder> deleteWhatsAppMessageMediaRequest)	Delete a media object from the WhatsApp service.
default DeleteWhatsAppMessageMediaResponse	deleteWhatsAppMessageMedia(DeleteWhatsAppMessageMediaRequest deleteWhatsAppMessageMediaRequest)	Delete a media object from the WhatsApp service.
default DeleteWhatsAppMessageTemplateResponse	deleteWhatsAppMessageTemplate(Consumer<DeleteWhatsAppMessageTemplateRequest.Builder> deleteWhatsAppMessageTemplateRequest)	Deletes a WhatsApp message template.
default DeleteWhatsAppMessageTemplateResponse	deleteWhatsAppMessageTemplate(DeleteWhatsAppMessageTemplateRequest deleteWhatsAppMessageTemplateRequest)	Deletes a WhatsApp message template.
default DisassociateWhatsAppBusinessAccountResponse	disassociateWhatsAppBusinessAccount(Consumer<DisassociateWhatsAppBusinessAccountRequest.Builder> disassociateWhatsAppBusinessAccountRequest)	Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
default DisassociateWhatsAppBusinessAccountResponse	disassociateWhatsAppBusinessAccount(DisassociateWhatsAppBusinessAccountRequest disassociateWhatsAppBusinessAccountRequest)	Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
default GetLinkedWhatsAppBusinessAccountResponse	getLinkedWhatsAppBusinessAccount(Consumer<GetLinkedWhatsAppBusinessAccountRequest.Builder> getLinkedWhatsAppBusinessAccountRequest)	Get the details of your linked WhatsApp Business Account.
default GetLinkedWhatsAppBusinessAccountResponse	getLinkedWhatsAppBusinessAccount(GetLinkedWhatsAppBusinessAccountRequest getLinkedWhatsAppBusinessAccountRequest)	Get the details of your linked WhatsApp Business Account.
default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse	getLinkedWhatsAppBusinessAccountPhoneNumber(Consumer<GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder> getLinkedWhatsAppBusinessAccountPhoneNumberRequest)	Use your WhatsApp phone number id to get the WABA account id and phone number details.
default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse	getLinkedWhatsAppBusinessAccountPhoneNumber(GetLinkedWhatsAppBusinessAccountPhoneNumberRequest getLinkedWhatsAppBusinessAccountPhoneNumberRequest)	Use your WhatsApp phone number id to get the WABA account id and phone number details.
default GetWhatsAppMessageMediaResponse	getWhatsAppMessageMedia(Consumer<GetWhatsAppMessageMediaRequest.Builder> getWhatsAppMessageMediaRequest)	Get a media file from the WhatsApp service.
default GetWhatsAppMessageMediaResponse	getWhatsAppMessageMedia(GetWhatsAppMessageMediaRequest getWhatsAppMessageMediaRequest)	Get a media file from the WhatsApp service.
default GetWhatsAppMessageTemplateResponse	getWhatsAppMessageTemplate(Consumer<GetWhatsAppMessageTemplateRequest.Builder> getWhatsAppMessageTemplateRequest)	Retrieves a specific WhatsApp message template.
default GetWhatsAppMessageTemplateResponse	getWhatsAppMessageTemplate(GetWhatsAppMessageTemplateRequest getWhatsAppMessageTemplateRequest)	Retrieves a specific WhatsApp message template.
default ListLinkedWhatsAppBusinessAccountsResponse	listLinkedWhatsAppBusinessAccounts(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest)	List all WhatsApp Business Accounts linked to your Amazon Web Services account.
default ListLinkedWhatsAppBusinessAccountsResponse	listLinkedWhatsAppBusinessAccounts(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest)	List all WhatsApp Business Accounts linked to your Amazon Web Services account.
default ListLinkedWhatsAppBusinessAccountsIterable	listLinkedWhatsAppBusinessAccountsPaginator(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest)	This is a variant of listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) operation.
default ListLinkedWhatsAppBusinessAccountsIterable	listLinkedWhatsAppBusinessAccountsPaginator(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest)	This is a variant of listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List all tags associated with a resource, such as a phone number or WABA.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List all tags associated with a resource, such as a phone number or WABA.
default ListWhatsAppMessageTemplatesResponse	listWhatsAppMessageTemplates(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest)	Lists WhatsApp message templates for a specific WhatsApp Business Account.
default ListWhatsAppMessageTemplatesResponse	listWhatsAppMessageTemplates(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest)	Lists WhatsApp message templates for a specific WhatsApp Business Account.
default ListWhatsAppMessageTemplatesIterable	listWhatsAppMessageTemplatesPaginator(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest)	This is a variant of listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) operation.
default ListWhatsAppMessageTemplatesIterable	listWhatsAppMessageTemplatesPaginator(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest)	This is a variant of listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) operation.
default ListWhatsAppTemplateLibraryResponse	listWhatsAppTemplateLibrary(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest)	Lists templates available in Meta's template library for WhatsApp messaging.
default ListWhatsAppTemplateLibraryResponse	listWhatsAppTemplateLibrary(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest)	Lists templates available in Meta's template library for WhatsApp messaging.
default ListWhatsAppTemplateLibraryIterable	listWhatsAppTemplateLibraryPaginator(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest)	This is a variant of listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) operation.
default ListWhatsAppTemplateLibraryIterable	listWhatsAppTemplateLibraryPaginator(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest)	This is a variant of listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) operation.
default PostWhatsAppMessageMediaResponse	postWhatsAppMessageMedia(Consumer<PostWhatsAppMessageMediaRequest.Builder> postWhatsAppMessageMediaRequest)	Upload a media file to the WhatsApp service.
default PostWhatsAppMessageMediaResponse	postWhatsAppMessageMedia(PostWhatsAppMessageMediaRequest postWhatsAppMessageMediaRequest)	Upload a media file to the WhatsApp service.
default PutWhatsAppBusinessAccountEventDestinationsResponse	putWhatsAppBusinessAccountEventDestinations(Consumer<PutWhatsAppBusinessAccountEventDestinationsRequest.Builder> putWhatsAppBusinessAccountEventDestinationsRequest)	Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).
default PutWhatsAppBusinessAccountEventDestinationsResponse	putWhatsAppBusinessAccountEventDestinations(PutWhatsAppBusinessAccountEventDestinationsRequest putWhatsAppBusinessAccountEventDestinationsRequest)	Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).
default SendWhatsAppMessageResponse	sendWhatsAppMessage(Consumer<SendWhatsAppMessageRequest.Builder> sendWhatsAppMessageRequest)	Send a WhatsApp message.
default SendWhatsAppMessageResponse	sendWhatsAppMessage(SendWhatsAppMessageRequest sendWhatsAppMessageRequest)	Send a WhatsApp message.
default SocialMessagingServiceClientConfiguration	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 only the specified tags for the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or overwrites only the specified tags for the specified 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 UpdateWhatsAppMessageTemplateResponse	updateWhatsAppMessageTemplate(Consumer<UpdateWhatsAppMessageTemplateRequest.Builder> updateWhatsAppMessageTemplateRequest)	Updates an existing WhatsApp message template.
default UpdateWhatsAppMessageTemplateResponse	updateWhatsAppMessageTemplate(UpdateWhatsAppMessageTemplateRequest updateWhatsAppMessageTemplateRequest)	Updates an existing WhatsApp message template.

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

associateWhatsAppBusinessAccount

default AssociateWhatsAppBusinessAccountResponse associateWhatsAppBusinessAccount(AssociateWhatsAppBusinessAccountRequest associateWhatsAppBusinessAccountRequest)
                                                                           throws ValidationException,
LimitExceededException,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

Parameters:

associateWhatsAppBusinessAccountRequest -

Returns:

Result of the AssociateWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

associateWhatsAppBusinessAccount

default AssociateWhatsAppBusinessAccountResponse associateWhatsAppBusinessAccount(Consumer<AssociateWhatsAppBusinessAccountRequest.Builder> associateWhatsAppBusinessAccountRequest)
                                                                           throws ValidationException,
LimitExceededException,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

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

Parameters:

associateWhatsAppBusinessAccountRequest - A Consumer that will call methods on AssociateWhatsAppBusinessAccountRequest.Builder to create a request.

Returns:

Result of the AssociateWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplate

default CreateWhatsAppMessageTemplateResponse createWhatsAppMessageTemplate(CreateWhatsAppMessageTemplateRequest createWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Creates a new WhatsApp message template from a custom definition.

Parameters:

createWhatsAppMessageTemplateRequest -

Returns:

Result of the CreateWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplate

default CreateWhatsAppMessageTemplateResponse createWhatsAppMessageTemplate(Consumer<CreateWhatsAppMessageTemplateRequest.Builder> createWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Creates a new WhatsApp message template from a custom definition.

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

Parameters:

createWhatsAppMessageTemplateRequest - A Consumer that will call methods on CreateWhatsAppMessageTemplateRequest.Builder to create a request.

Returns:

Result of the CreateWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplateFromLibrary

default CreateWhatsAppMessageTemplateFromLibraryResponse createWhatsAppMessageTemplateFromLibrary(CreateWhatsAppMessageTemplateFromLibraryRequest createWhatsAppMessageTemplateFromLibraryRequest)
                                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Creates a new WhatsApp message template using a template from Meta's template library.

Parameters:

createWhatsAppMessageTemplateFromLibraryRequest -

Returns:

Result of the CreateWhatsAppMessageTemplateFromLibrary operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplateFromLibrary

default CreateWhatsAppMessageTemplateFromLibraryResponse createWhatsAppMessageTemplateFromLibrary(Consumer<CreateWhatsAppMessageTemplateFromLibraryRequest.Builder> createWhatsAppMessageTemplateFromLibraryRequest)
                                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Creates a new WhatsApp message template using a template from Meta's template library.

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

Parameters:

createWhatsAppMessageTemplateFromLibraryRequest - A Consumer that will call methods on CreateWhatsAppMessageTemplateFromLibraryRequest.Builder to create a request.

Returns:

Result of the CreateWhatsAppMessageTemplateFromLibrary operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplateMedia

default CreateWhatsAppMessageTemplateMediaResponse createWhatsAppMessageTemplateMedia(CreateWhatsAppMessageTemplateMediaRequest createWhatsAppMessageTemplateMediaRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Uploads media for use in a WhatsApp message template.

Parameters:

createWhatsAppMessageTemplateMediaRequest -

Returns:

Result of the CreateWhatsAppMessageTemplateMedia operation returned by the service.

See Also:

• AWS API Documentation

createWhatsAppMessageTemplateMedia

default CreateWhatsAppMessageTemplateMediaResponse createWhatsAppMessageTemplateMedia(Consumer<CreateWhatsAppMessageTemplateMediaRequest.Builder> createWhatsAppMessageTemplateMediaRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Uploads media for use in a WhatsApp message template.

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

Parameters:

createWhatsAppMessageTemplateMediaRequest - A Consumer that will call methods on CreateWhatsAppMessageTemplateMediaRequest.Builder to create a request.

Returns:

Result of the CreateWhatsAppMessageTemplateMedia operation returned by the service.

See Also:

• AWS API Documentation

deleteWhatsAppMessageMedia

default DeleteWhatsAppMessageMediaResponse deleteWhatsAppMessageMedia(DeleteWhatsAppMessageMediaRequest deleteWhatsAppMessageMediaRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

Parameters:

deleteWhatsAppMessageMediaRequest -

Returns:

Result of the DeleteWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

deleteWhatsAppMessageMedia

default DeleteWhatsAppMessageMediaResponse deleteWhatsAppMessageMedia(Consumer<DeleteWhatsAppMessageMediaRequest.Builder> deleteWhatsAppMessageMediaRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

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

Parameters:

deleteWhatsAppMessageMediaRequest - A Consumer that will call methods on DeleteWhatsAppMessageMediaRequest.Builder to create a request.

Returns:

Result of the DeleteWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

deleteWhatsAppMessageTemplate

default DeleteWhatsAppMessageTemplateResponse deleteWhatsAppMessageTemplate(DeleteWhatsAppMessageTemplateRequest deleteWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Deletes a WhatsApp message template.

Parameters:

deleteWhatsAppMessageTemplateRequest -

Returns:

Result of the DeleteWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

deleteWhatsAppMessageTemplate

default DeleteWhatsAppMessageTemplateResponse deleteWhatsAppMessageTemplate(Consumer<DeleteWhatsAppMessageTemplateRequest.Builder> deleteWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Deletes a WhatsApp message template.

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

Parameters:

deleteWhatsAppMessageTemplateRequest - A Consumer that will call methods on DeleteWhatsAppMessageTemplateRequest.Builder to create a request.

Returns:

Result of the DeleteWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

disassociateWhatsAppBusinessAccount

default DisassociateWhatsAppBusinessAccountResponse disassociateWhatsAppBusinessAccount(DisassociateWhatsAppBusinessAccountRequest disassociateWhatsAppBusinessAccountRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

Parameters:

disassociateWhatsAppBusinessAccountRequest -

Returns:

Result of the DisassociateWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

disassociateWhatsAppBusinessAccount

default DisassociateWhatsAppBusinessAccountResponse disassociateWhatsAppBusinessAccount(Consumer<DisassociateWhatsAppBusinessAccountRequest.Builder> disassociateWhatsAppBusinessAccountRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

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

Parameters:

disassociateWhatsAppBusinessAccountRequest - A Consumer that will call methods on DisassociateWhatsAppBusinessAccountRequest.Builder to create a request.

Returns:

Result of the DisassociateWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

getLinkedWhatsAppBusinessAccount

default GetLinkedWhatsAppBusinessAccountResponse getLinkedWhatsAppBusinessAccount(GetLinkedWhatsAppBusinessAccountRequest getLinkedWhatsAppBusinessAccountRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Get the details of your linked WhatsApp Business Account.

Parameters:

getLinkedWhatsAppBusinessAccountRequest -

Returns:

Result of the GetLinkedWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

getLinkedWhatsAppBusinessAccount

default GetLinkedWhatsAppBusinessAccountResponse getLinkedWhatsAppBusinessAccount(Consumer<GetLinkedWhatsAppBusinessAccountRequest.Builder> getLinkedWhatsAppBusinessAccountRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Get the details of your linked WhatsApp Business Account.

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

Parameters:

getLinkedWhatsAppBusinessAccountRequest - A Consumer that will call methods on GetLinkedWhatsAppBusinessAccountRequest.Builder to create a request.

Returns:

Result of the GetLinkedWhatsAppBusinessAccount operation returned by the service.

See Also:

• AWS API Documentation

getLinkedWhatsAppBusinessAccountPhoneNumber

default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse getLinkedWhatsAppBusinessAccountPhoneNumber(GetLinkedWhatsAppBusinessAccountPhoneNumberRequest getLinkedWhatsAppBusinessAccountPhoneNumberRequest)
                                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Use your WhatsApp phone number id to get the WABA account id and phone number details.

Parameters:

getLinkedWhatsAppBusinessAccountPhoneNumberRequest -

Returns:

Result of the GetLinkedWhatsAppBusinessAccountPhoneNumber operation returned by the service.

See Also:

• AWS API Documentation

getLinkedWhatsAppBusinessAccountPhoneNumber

default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse getLinkedWhatsAppBusinessAccountPhoneNumber(Consumer<GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder> getLinkedWhatsAppBusinessAccountPhoneNumberRequest)
                                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Use your WhatsApp phone number id to get the WABA account id and phone number details.

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

Parameters:

getLinkedWhatsAppBusinessAccountPhoneNumberRequest - A Consumer that will call methods on GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder to create a request.

Returns:

Result of the GetLinkedWhatsAppBusinessAccountPhoneNumber operation returned by the service.

See Also:

• AWS API Documentation

getWhatsAppMessageMedia

default GetWhatsAppMessageMediaResponse getWhatsAppMessageMedia(GetWhatsAppMessageMediaRequest getWhatsAppMessageMediaRequest)
                                                         throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.

Parameters:

getWhatsAppMessageMediaRequest -

Returns:

Result of the GetWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

getWhatsAppMessageMedia

default GetWhatsAppMessageMediaResponse getWhatsAppMessageMedia(Consumer<GetWhatsAppMessageMediaRequest.Builder> getWhatsAppMessageMediaRequest)
                                                         throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.

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

Parameters:

getWhatsAppMessageMediaRequest - A Consumer that will call methods on GetWhatsAppMessageMediaRequest.Builder to create a request.

Returns:

Result of the GetWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

getWhatsAppMessageTemplate

default GetWhatsAppMessageTemplateResponse getWhatsAppMessageTemplate(GetWhatsAppMessageTemplateRequest getWhatsAppMessageTemplateRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Retrieves a specific WhatsApp message template.

Parameters:

getWhatsAppMessageTemplateRequest -

Returns:

Result of the GetWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

getWhatsAppMessageTemplate

default GetWhatsAppMessageTemplateResponse getWhatsAppMessageTemplate(Consumer<GetWhatsAppMessageTemplateRequest.Builder> getWhatsAppMessageTemplateRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Retrieves a specific WhatsApp message template.

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

Parameters:

getWhatsAppMessageTemplateRequest - A Consumer that will call methods on GetWhatsAppMessageTemplateRequest.Builder to create a request.

Returns:

Result of the GetWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

listLinkedWhatsAppBusinessAccounts

default ListLinkedWhatsAppBusinessAccountsResponse listLinkedWhatsAppBusinessAccounts(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

Parameters:

listLinkedWhatsAppBusinessAccountsRequest -

Returns:

Result of the ListLinkedWhatsAppBusinessAccounts operation returned by the service.

See Also:

• AWS API Documentation

listLinkedWhatsAppBusinessAccounts

default ListLinkedWhatsAppBusinessAccountsResponse listLinkedWhatsAppBusinessAccounts(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest)
                                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

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

Parameters:

listLinkedWhatsAppBusinessAccountsRequest - A Consumer that will call methods on ListLinkedWhatsAppBusinessAccountsRequest.Builder to create a request.

Returns:

Result of the ListLinkedWhatsAppBusinessAccounts operation returned by the service.

See Also:

• AWS API Documentation

listLinkedWhatsAppBusinessAccountsPaginator

default ListLinkedWhatsAppBusinessAccountsIterable listLinkedWhatsAppBusinessAccountsPaginator(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest)
                                                                                        throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) 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.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client
             .listLinkedWhatsAppBusinessAccountsPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(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 listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) operation.

Parameters:

listLinkedWhatsAppBusinessAccountsRequest -

Returns:

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

See Also:

• AWS API Documentation

listLinkedWhatsAppBusinessAccountsPaginator

default ListLinkedWhatsAppBusinessAccountsIterable listLinkedWhatsAppBusinessAccountsPaginator(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest)
                                                                                        throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) 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.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client
             .listLinkedWhatsAppBusinessAccountsPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(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 listLinkedWhatsAppBusinessAccounts(software.amazon.awssdk.services.socialmessaging.model.ListLinkedWhatsAppBusinessAccountsRequest) operation.

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

Parameters:

listLinkedWhatsAppBusinessAccountsRequest - A Consumer that will call methods on ListLinkedWhatsAppBusinessAccountsRequest.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,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

List all tags associated with a resource, such as a phone number or WABA.

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,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

List all tags associated with a resource, such as a phone number or WABA.

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

listWhatsAppMessageTemplates

default ListWhatsAppMessageTemplatesResponse listWhatsAppMessageTemplates(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest)
                                                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Lists WhatsApp message templates for a specific WhatsApp Business Account.

Parameters:

listWhatsAppMessageTemplatesRequest -

Returns:

Result of the ListWhatsAppMessageTemplates operation returned by the service.

See Also:

• AWS API Documentation

listWhatsAppMessageTemplates

default ListWhatsAppMessageTemplatesResponse listWhatsAppMessageTemplates(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest)
                                                                   throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Lists WhatsApp message templates for a specific WhatsApp Business Account.

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

Parameters:

listWhatsAppMessageTemplatesRequest - A Consumer that will call methods on ListWhatsAppMessageTemplatesRequest.Builder to create a request.

Returns:

Result of the ListWhatsAppMessageTemplates operation returned by the service.

See Also:

• AWS API Documentation

listWhatsAppMessageTemplatesPaginator

default ListWhatsAppMessageTemplatesIterable listWhatsAppMessageTemplatesPaginator(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest)
                                                                            throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) 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.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client
             .listWhatsAppMessageTemplatesPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(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 listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) operation.

Parameters:

listWhatsAppMessageTemplatesRequest -

Returns:

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

See Also:

• AWS API Documentation

listWhatsAppMessageTemplatesPaginator

default ListWhatsAppMessageTemplatesIterable listWhatsAppMessageTemplatesPaginator(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest)
                                                                            throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) 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.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client
             .listWhatsAppMessageTemplatesPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(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 listWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest) operation.

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

Parameters:

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

listWhatsAppTemplateLibrary

default ListWhatsAppTemplateLibraryResponse listWhatsAppTemplateLibrary(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Lists templates available in Meta's template library for WhatsApp messaging.

Parameters:

listWhatsAppTemplateLibraryRequest -

Returns:

Result of the ListWhatsAppTemplateLibrary operation returned by the service.

See Also:

• AWS API Documentation

listWhatsAppTemplateLibrary

default ListWhatsAppTemplateLibraryResponse listWhatsAppTemplateLibrary(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest)
                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Lists templates available in Meta's template library for WhatsApp messaging.

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

Parameters:

listWhatsAppTemplateLibraryRequest - A Consumer that will call methods on ListWhatsAppTemplateLibraryRequest.Builder to create a request.

Returns:

Result of the ListWhatsAppTemplateLibrary operation returned by the service.

See Also:

• AWS API Documentation

listWhatsAppTemplateLibraryPaginator

default ListWhatsAppTemplateLibraryIterable listWhatsAppTemplateLibraryPaginator(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest)
                                                                          throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) 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.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client
             .listWhatsAppTemplateLibraryPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(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 listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) operation.

Parameters:

listWhatsAppTemplateLibraryRequest -

Returns:

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

See Also:

• AWS API Documentation

listWhatsAppTemplateLibraryPaginator

default ListWhatsAppTemplateLibraryIterable listWhatsAppTemplateLibraryPaginator(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest)
                                                                          throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

This is a variant of listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) 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.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client
             .listWhatsAppTemplateLibraryPaginator(request);
     for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(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 listWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest) operation.

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

Parameters:

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

postWhatsAppMessageMedia

default PostWhatsAppMessageMediaResponse postWhatsAppMessageMedia(PostWhatsAppMessageMediaRequest postWhatsAppMessageMediaRequest)
                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.

Parameters:

postWhatsAppMessageMediaRequest -

Returns:

Result of the PostWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

postWhatsAppMessageMedia

default PostWhatsAppMessageMediaResponse postWhatsAppMessageMedia(Consumer<PostWhatsAppMessageMediaRequest.Builder> postWhatsAppMessageMediaRequest)
                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
AccessDeniedByMetaException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.

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

Parameters:

postWhatsAppMessageMediaRequest - A Consumer that will call methods on PostWhatsAppMessageMediaRequest.Builder to create a request.

Returns:

Result of the PostWhatsAppMessageMedia operation returned by the service.

See Also:

• AWS API Documentation

putWhatsAppBusinessAccountEventDestinations

default PutWhatsAppBusinessAccountEventDestinationsResponse putWhatsAppBusinessAccountEventDestinations(PutWhatsAppBusinessAccountEventDestinationsRequest putWhatsAppBusinessAccountEventDestinationsRequest)
                                                                                                 throws ValidationException,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.

Parameters:

putWhatsAppBusinessAccountEventDestinationsRequest -

Returns:

Result of the PutWhatsAppBusinessAccountEventDestinations operation returned by the service.

See Also:

• AWS API Documentation

putWhatsAppBusinessAccountEventDestinations

default PutWhatsAppBusinessAccountEventDestinationsResponse putWhatsAppBusinessAccountEventDestinations(Consumer<PutWhatsAppBusinessAccountEventDestinationsRequest.Builder> putWhatsAppBusinessAccountEventDestinationsRequest)
                                                                                                 throws ValidationException,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.

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

Parameters:

putWhatsAppBusinessAccountEventDestinationsRequest - A Consumer that will call methods on PutWhatsAppBusinessAccountEventDestinationsRequest.Builder to create a request.

Returns:

Result of the PutWhatsAppBusinessAccountEventDestinations operation returned by the service.

See Also:

• AWS API Documentation

sendWhatsAppMessage

default SendWhatsAppMessageResponse sendWhatsAppMessage(SendWhatsAppMessageRequest sendWhatsAppMessageRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .

Parameters:

sendWhatsAppMessageRequest -

Returns:

Result of the SendWhatsAppMessage operation returned by the service.

See Also:

• AWS API Documentation

sendWhatsAppMessage

default SendWhatsAppMessageResponse sendWhatsAppMessage(Consumer<SendWhatsAppMessageRequest.Builder> sendWhatsAppMessageRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .

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

Parameters:

sendWhatsAppMessageRequest - A Consumer that will call methods on SendWhatsAppMessageRequest.Builder to create a request.

Returns:

Result of the SendWhatsAppMessage operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value.

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,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value.

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,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

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,
AccessDeniedException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
AwsServiceException,
SdkClientException,
SocialMessagingException

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

updateWhatsAppMessageTemplate

default UpdateWhatsAppMessageTemplateResponse updateWhatsAppMessageTemplate(UpdateWhatsAppMessageTemplateRequest updateWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Updates an existing WhatsApp message template.

Parameters:

updateWhatsAppMessageTemplateRequest -

Returns:

Result of the UpdateWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

updateWhatsAppMessageTemplate

default UpdateWhatsAppMessageTemplateResponse updateWhatsAppMessageTemplate(Consumer<UpdateWhatsAppMessageTemplateRequest.Builder> updateWhatsAppMessageTemplateRequest)
                                                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
InvalidParametersException,
ThrottledRequestException,
InternalServiceException,
DependencyException,
AwsServiceException,
SdkClientException,
SocialMessagingException

Updates an existing WhatsApp message template.

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

Parameters:

updateWhatsAppMessageTemplateRequest - A Consumer that will call methods on UpdateWhatsAppMessageTemplateRequest.Builder to create a request.

Returns:

Result of the UpdateWhatsAppMessageTemplate operation returned by the service.

See Also:

• AWS API Documentation

create

static SocialMessagingClient create()

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

builder

static SocialMessagingClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

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