Interface SocialMessagingClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateWhatsAppBusinessAccount(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.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 SocialMessagingClientBuilderbuilder()Create a builder that can be used to configure and create aSocialMessagingClient.static SocialMessagingClientcreate()Create aSocialMessagingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateWhatsAppFlowResponsecreateWhatsAppFlow(Consumer<CreateWhatsAppFlowRequest.Builder> createWhatsAppFlowRequest) Creates a new WhatsApp Flow.default CreateWhatsAppFlowResponsecreateWhatsAppFlow(CreateWhatsAppFlowRequest createWhatsAppFlowRequest) Creates a new WhatsApp Flow.createWhatsAppMessageTemplate(Consumer<CreateWhatsAppMessageTemplateRequest.Builder> createWhatsAppMessageTemplateRequest) Creates a new WhatsApp message template from a custom definition.createWhatsAppMessageTemplate(CreateWhatsAppMessageTemplateRequest createWhatsAppMessageTemplateRequest) Creates a new WhatsApp message template from a custom definition.createWhatsAppMessageTemplateFromLibrary(Consumer<CreateWhatsAppMessageTemplateFromLibraryRequest.Builder> createWhatsAppMessageTemplateFromLibraryRequest) Creates a new WhatsApp message template using a template from Meta's template library.createWhatsAppMessageTemplateFromLibrary(CreateWhatsAppMessageTemplateFromLibraryRequest createWhatsAppMessageTemplateFromLibraryRequest) Creates a new WhatsApp message template using a template from Meta's template library.createWhatsAppMessageTemplateMedia(Consumer<CreateWhatsAppMessageTemplateMediaRequest.Builder> createWhatsAppMessageTemplateMediaRequest) Uploads media for use in a WhatsApp message template.createWhatsAppMessageTemplateMedia(CreateWhatsAppMessageTemplateMediaRequest createWhatsAppMessageTemplateMediaRequest) Uploads media for use in a WhatsApp message template.default DeleteWhatsAppFlowResponsedeleteWhatsAppFlow(Consumer<DeleteWhatsAppFlowRequest.Builder> deleteWhatsAppFlowRequest) Deletes a WhatsApp Flow permanently.default DeleteWhatsAppFlowResponsedeleteWhatsAppFlow(DeleteWhatsAppFlowRequest deleteWhatsAppFlowRequest) Deletes a WhatsApp Flow permanently.deleteWhatsAppMessageMedia(Consumer<DeleteWhatsAppMessageMediaRequest.Builder> deleteWhatsAppMessageMediaRequest) Delete a media object from the WhatsApp service.deleteWhatsAppMessageMedia(DeleteWhatsAppMessageMediaRequest deleteWhatsAppMessageMediaRequest) Delete a media object from the WhatsApp service.deleteWhatsAppMessageTemplate(Consumer<DeleteWhatsAppMessageTemplateRequest.Builder> deleteWhatsAppMessageTemplateRequest) Deletes a WhatsApp message template.deleteWhatsAppMessageTemplate(DeleteWhatsAppMessageTemplateRequest deleteWhatsAppMessageTemplateRequest) Deletes a WhatsApp message template.default DeprecateWhatsAppFlowResponsedeprecateWhatsAppFlow(Consumer<DeprecateWhatsAppFlowRequest.Builder> deprecateWhatsAppFlowRequest) Deprecates a published WhatsApp Flow, marking it as no longer recommended for use.default DeprecateWhatsAppFlowResponsedeprecateWhatsAppFlow(DeprecateWhatsAppFlowRequest deprecateWhatsAppFlowRequest) Deprecates a published WhatsApp Flow, marking it as no longer recommended for use.disassociateWhatsAppBusinessAccount(Consumer<DisassociateWhatsAppBusinessAccountRequest.Builder> disassociateWhatsAppBusinessAccountRequest) Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.disassociateWhatsAppBusinessAccount(DisassociateWhatsAppBusinessAccountRequest disassociateWhatsAppBusinessAccountRequest) Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.getLinkedWhatsAppBusinessAccount(Consumer<GetLinkedWhatsAppBusinessAccountRequest.Builder> getLinkedWhatsAppBusinessAccountRequest) Get the details of your linked WhatsApp Business Account.getLinkedWhatsAppBusinessAccount(GetLinkedWhatsAppBusinessAccountRequest getLinkedWhatsAppBusinessAccountRequest) Get the details of your linked WhatsApp Business Account.getLinkedWhatsAppBusinessAccountPhoneNumber(Consumer<GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder> getLinkedWhatsAppBusinessAccountPhoneNumberRequest) Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.getLinkedWhatsAppBusinessAccountPhoneNumber(GetLinkedWhatsAppBusinessAccountPhoneNumberRequest getLinkedWhatsAppBusinessAccountPhoneNumberRequest) Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.default GetWhatsAppFlowResponsegetWhatsAppFlow(Consumer<GetWhatsAppFlowRequest.Builder> getWhatsAppFlowRequest) Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.default GetWhatsAppFlowResponsegetWhatsAppFlow(GetWhatsAppFlowRequest getWhatsAppFlowRequest) Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.default GetWhatsAppFlowPreviewResponsegetWhatsAppFlowPreview(Consumer<GetWhatsAppFlowPreviewRequest.Builder> getWhatsAppFlowPreviewRequest) Generates a web preview URL for testing a WhatsApp Flow before publishing.default GetWhatsAppFlowPreviewResponsegetWhatsAppFlowPreview(GetWhatsAppFlowPreviewRequest getWhatsAppFlowPreviewRequest) Generates a web preview URL for testing a WhatsApp Flow before publishing.default GetWhatsAppMessageMediaResponsegetWhatsAppMessageMedia(Consumer<GetWhatsAppMessageMediaRequest.Builder> getWhatsAppMessageMediaRequest) Get a media file from the WhatsApp service.default GetWhatsAppMessageMediaResponsegetWhatsAppMessageMedia(GetWhatsAppMessageMediaRequest getWhatsAppMessageMediaRequest) Get a media file from the WhatsApp service.getWhatsAppMessageTemplate(Consumer<GetWhatsAppMessageTemplateRequest.Builder> getWhatsAppMessageTemplateRequest) Retrieves a specific WhatsApp message template.getWhatsAppMessageTemplate(GetWhatsAppMessageTemplateRequest getWhatsAppMessageTemplateRequest) Retrieves a specific WhatsApp message template.listLinkedWhatsAppBusinessAccounts(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest) List all WhatsApp Business Accounts linked to your Amazon Web Services account.listLinkedWhatsAppBusinessAccounts(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest) List all WhatsApp Business Accounts linked to your Amazon Web Services account.listLinkedWhatsAppBusinessAccountsPaginator(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest) listLinkedWhatsAppBusinessAccountsPaginator(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest) default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all tags associated with a resource, such as a phone number or WABA.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags associated with a resource, such as a phone number or WABA.default ListWhatsAppFlowAssetsResponselistWhatsAppFlowAssets(Consumer<ListWhatsAppFlowAssetsRequest.Builder> listWhatsAppFlowAssetsRequest) Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs.default ListWhatsAppFlowAssetsResponselistWhatsAppFlowAssets(ListWhatsAppFlowAssetsRequest listWhatsAppFlowAssetsRequest) Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs.default ListWhatsAppFlowAssetsIterablelistWhatsAppFlowAssetsPaginator(Consumer<ListWhatsAppFlowAssetsRequest.Builder> listWhatsAppFlowAssetsRequest) This is a variant oflistWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation.default ListWhatsAppFlowAssetsIterablelistWhatsAppFlowAssetsPaginator(ListWhatsAppFlowAssetsRequest listWhatsAppFlowAssetsRequest) This is a variant oflistWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation.default ListWhatsAppFlowsResponselistWhatsAppFlows(Consumer<ListWhatsAppFlowsRequest.Builder> listWhatsAppFlowsRequest) Lists all WhatsApp Flows for a WhatsApp Business Account.default ListWhatsAppFlowsResponselistWhatsAppFlows(ListWhatsAppFlowsRequest listWhatsAppFlowsRequest) Lists all WhatsApp Flows for a WhatsApp Business Account.default ListWhatsAppFlowsIterablelistWhatsAppFlowsPaginator(Consumer<ListWhatsAppFlowsRequest.Builder> listWhatsAppFlowsRequest) This is a variant oflistWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation.default ListWhatsAppFlowsIterablelistWhatsAppFlowsPaginator(ListWhatsAppFlowsRequest listWhatsAppFlowsRequest) This is a variant oflistWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation.listWhatsAppMessageTemplates(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest) Lists WhatsApp message templates for a specific WhatsApp Business Account.listWhatsAppMessageTemplates(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest) Lists WhatsApp message templates for a specific WhatsApp Business Account.listWhatsAppMessageTemplatesPaginator(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest) This is a variant oflistWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest)operation.listWhatsAppMessageTemplatesPaginator(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest) This is a variant oflistWhatsAppMessageTemplates(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppMessageTemplatesRequest)operation.listWhatsAppTemplateLibrary(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest) Lists templates available in Meta's template library for WhatsApp messaging.listWhatsAppTemplateLibrary(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest) Lists templates available in Meta's template library for WhatsApp messaging.listWhatsAppTemplateLibraryPaginator(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest) This is a variant oflistWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest)operation.listWhatsAppTemplateLibraryPaginator(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest) This is a variant oflistWhatsAppTemplateLibrary(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppTemplateLibraryRequest)operation.default PostWhatsAppMessageMediaResponsepostWhatsAppMessageMedia(Consumer<PostWhatsAppMessageMediaRequest.Builder> postWhatsAppMessageMediaRequest) Upload a media file to the WhatsApp service.default PostWhatsAppMessageMediaResponsepostWhatsAppMessageMedia(PostWhatsAppMessageMediaRequest postWhatsAppMessageMediaRequest) Upload a media file to the WhatsApp service.default PublishWhatsAppFlowResponsepublishWhatsAppFlow(Consumer<PublishWhatsAppFlowRequest.Builder> publishWhatsAppFlowRequest) Publishes a WhatsApp Flow, making it available for use in template messages.default PublishWhatsAppFlowResponsepublishWhatsAppFlow(PublishWhatsAppFlowRequest publishWhatsAppFlowRequest) Publishes a WhatsApp Flow, making it available for use in template messages.putWhatsAppBusinessAccountEventDestinations(Consumer<PutWhatsAppBusinessAccountEventDestinationsRequest.Builder> putWhatsAppBusinessAccountEventDestinationsRequest) Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).putWhatsAppBusinessAccountEventDestinations(PutWhatsAppBusinessAccountEventDestinationsRequest putWhatsAppBusinessAccountEventDestinationsRequest) Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).default SendWhatsAppMessageResponsesendWhatsAppMessage(Consumer<SendWhatsAppMessageRequest.Builder> sendWhatsAppMessageRequest) Send a WhatsApp message.default SendWhatsAppMessageResponsesendWhatsAppMessage(SendWhatsAppMessageRequest sendWhatsAppMessageRequest) Send a WhatsApp message.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites only the specified tags for the specified resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds or overwrites only the specified tags for the specified resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from a resource.default UpdateWhatsAppFlowResponseupdateWhatsAppFlow(Consumer<UpdateWhatsAppFlowRequest.Builder> updateWhatsAppFlowRequest) Updates the metadata of a WhatsApp Flow, such as its name or categories.default UpdateWhatsAppFlowResponseupdateWhatsAppFlow(UpdateWhatsAppFlowRequest updateWhatsAppFlowRequest) Updates the metadata of a WhatsApp Flow, such as its name or categories.default UpdateWhatsAppFlowAssetsResponseupdateWhatsAppFlowAssets(Consumer<UpdateWhatsAppFlowAssetsRequest.Builder> updateWhatsAppFlowAssetsRequest) Updates the Flow JSON definition (assets) of a WhatsApp Flow.default UpdateWhatsAppFlowAssetsResponseupdateWhatsAppFlowAssets(UpdateWhatsAppFlowAssetsRequest updateWhatsAppFlowAssetsRequest) Updates the Flow JSON definition (assets) of a WhatsApp Flow.updateWhatsAppMessageTemplate(Consumer<UpdateWhatsAppMessageTemplateRequest.Builder> updateWhatsAppMessageTemplateRequest) Updates an existing WhatsApp message template.updateWhatsAppMessageTemplate(UpdateWhatsAppMessageTemplateRequest updateWhatsAppMessageTemplateRequest) Updates an existing WhatsApp message template.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
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:
-
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.Builderavoiding the need to create one manually viaAssociateWhatsAppBusinessAccountRequest.builder()- Parameters:
associateWhatsAppBusinessAccountRequest- AConsumerthat will call methods onAssociateWhatsAppBusinessAccountRequest.Builderto create a request.- Returns:
- Result of the AssociateWhatsAppBusinessAccount operation returned by the service.
- See Also:
-
createWhatsAppFlow
default CreateWhatsAppFlowResponse createWhatsAppFlow(CreateWhatsAppFlowRequest createWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If
publishis set totrueand a validflowJsonis provided, the Flow is published immediately.- Parameters:
createWhatsAppFlowRequest-- Returns:
- Result of the CreateWhatsAppFlow operation returned by the service.
- See Also:
-
createWhatsAppFlow
default CreateWhatsAppFlowResponse createWhatsAppFlow(Consumer<CreateWhatsAppFlowRequest.Builder> createWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If
publishis set totrueand a validflowJsonis provided, the Flow is published immediately.
This is a convenience which creates an instance of the
CreateWhatsAppFlowRequest.Builderavoiding the need to create one manually viaCreateWhatsAppFlowRequest.builder()- Parameters:
createWhatsAppFlowRequest- AConsumerthat will call methods onCreateWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the CreateWhatsAppFlow operation returned by the service.
- See Also:
-
createWhatsAppMessageTemplate
default CreateWhatsAppMessageTemplateResponse createWhatsAppMessageTemplate(CreateWhatsAppMessageTemplateRequest createWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Creates a new WhatsApp message template from a custom definition.
Amazon Web Services End User Messaging Social does not store any WhatsApp message template content.
- Parameters:
createWhatsAppMessageTemplateRequest-- Returns:
- Result of the CreateWhatsAppMessageTemplate operation returned by the service.
- See Also:
-
createWhatsAppMessageTemplate
default CreateWhatsAppMessageTemplateResponse createWhatsAppMessageTemplate(Consumer<CreateWhatsAppMessageTemplateRequest.Builder> createWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Creates a new WhatsApp message template from a custom definition.
Amazon Web Services End User Messaging Social does not store any WhatsApp message template content.
This is a convenience which creates an instance of the
CreateWhatsAppMessageTemplateRequest.Builderavoiding the need to create one manually viaCreateWhatsAppMessageTemplateRequest.builder()- Parameters:
createWhatsAppMessageTemplateRequest- AConsumerthat will call methods onCreateWhatsAppMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateWhatsAppMessageTemplate operation returned by the service.
- See Also:
-
createWhatsAppMessageTemplateFromLibrary
default CreateWhatsAppMessageTemplateFromLibraryResponse createWhatsAppMessageTemplateFromLibrary(CreateWhatsAppMessageTemplateFromLibraryRequest createWhatsAppMessageTemplateFromLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
createWhatsAppMessageTemplateFromLibrary
default CreateWhatsAppMessageTemplateFromLibraryResponse createWhatsAppMessageTemplateFromLibrary(Consumer<CreateWhatsAppMessageTemplateFromLibraryRequest.Builder> createWhatsAppMessageTemplateFromLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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.Builderavoiding the need to create one manually viaCreateWhatsAppMessageTemplateFromLibraryRequest.builder()- Parameters:
createWhatsAppMessageTemplateFromLibraryRequest- AConsumerthat will call methods onCreateWhatsAppMessageTemplateFromLibraryRequest.Builderto create a request.- Returns:
- Result of the CreateWhatsAppMessageTemplateFromLibrary operation returned by the service.
- See Also:
-
createWhatsAppMessageTemplateMedia
default CreateWhatsAppMessageTemplateMediaResponse createWhatsAppMessageTemplateMedia(CreateWhatsAppMessageTemplateMediaRequest createWhatsAppMessageTemplateMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
createWhatsAppMessageTemplateMedia
default CreateWhatsAppMessageTemplateMediaResponse createWhatsAppMessageTemplateMedia(Consumer<CreateWhatsAppMessageTemplateMediaRequest.Builder> createWhatsAppMessageTemplateMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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.Builderavoiding the need to create one manually viaCreateWhatsAppMessageTemplateMediaRequest.builder()- Parameters:
createWhatsAppMessageTemplateMediaRequest- AConsumerthat will call methods onCreateWhatsAppMessageTemplateMediaRequest.Builderto create a request.- Returns:
- Result of the CreateWhatsAppMessageTemplateMedia operation returned by the service.
- See Also:
-
deleteWhatsAppFlow
default DeleteWhatsAppFlowResponse deleteWhatsAppFlow(DeleteWhatsAppFlowRequest deleteWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.
- Parameters:
deleteWhatsAppFlowRequest-- Returns:
- Result of the DeleteWhatsAppFlow operation returned by the service.
- See Also:
-
deleteWhatsAppFlow
default DeleteWhatsAppFlowResponse deleteWhatsAppFlow(Consumer<DeleteWhatsAppFlowRequest.Builder> deleteWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Deletes a WhatsApp Flow permanently. Only Flows in DRAFT status can be deleted. Published or deprecated Flows cannot be deleted.
This is a convenience which creates an instance of the
DeleteWhatsAppFlowRequest.Builderavoiding the need to create one manually viaDeleteWhatsAppFlowRequest.builder()- Parameters:
deleteWhatsAppFlowRequest- AConsumerthat will call methods onDeleteWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the DeleteWhatsAppFlow operation returned by the service.
- See Also:
-
deleteWhatsAppMessageMedia
default DeleteWhatsAppMessageMediaResponse deleteWhatsAppMessageMedia(DeleteWhatsAppMessageMediaRequest deleteWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, 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:
-
deleteWhatsAppMessageMedia
default DeleteWhatsAppMessageMediaResponse deleteWhatsAppMessageMedia(Consumer<DeleteWhatsAppMessageMediaRequest.Builder> deleteWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, 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.Builderavoiding the need to create one manually viaDeleteWhatsAppMessageMediaRequest.builder()- Parameters:
deleteWhatsAppMessageMediaRequest- AConsumerthat will call methods onDeleteWhatsAppMessageMediaRequest.Builderto create a request.- Returns:
- Result of the DeleteWhatsAppMessageMedia operation returned by the service.
- See Also:
-
deleteWhatsAppMessageTemplate
default DeleteWhatsAppMessageTemplateResponse deleteWhatsAppMessageTemplate(DeleteWhatsAppMessageTemplateRequest deleteWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
deleteWhatsAppMessageTemplate
default DeleteWhatsAppMessageTemplateResponse deleteWhatsAppMessageTemplate(Consumer<DeleteWhatsAppMessageTemplateRequest.Builder> deleteWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Deletes a WhatsApp message template.
This is a convenience which creates an instance of the
DeleteWhatsAppMessageTemplateRequest.Builderavoiding the need to create one manually viaDeleteWhatsAppMessageTemplateRequest.builder()- Parameters:
deleteWhatsAppMessageTemplateRequest- AConsumerthat will call methods onDeleteWhatsAppMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteWhatsAppMessageTemplate operation returned by the service.
- See Also:
-
deprecateWhatsAppFlow
default DeprecateWhatsAppFlowResponse deprecateWhatsAppFlow(DeprecateWhatsAppFlowRequest deprecateWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Deprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation.
- Parameters:
deprecateWhatsAppFlowRequest-- Returns:
- Result of the DeprecateWhatsAppFlow operation returned by the service.
- See Also:
-
deprecateWhatsAppFlow
default DeprecateWhatsAppFlowResponse deprecateWhatsAppFlow(Consumer<DeprecateWhatsAppFlowRequest.Builder> deprecateWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Deprecates a published WhatsApp Flow, marking it as no longer recommended for use. The Flow must be in PUBLISHED status. This is an irreversible operation.
This is a convenience which creates an instance of the
DeprecateWhatsAppFlowRequest.Builderavoiding the need to create one manually viaDeprecateWhatsAppFlowRequest.builder()- Parameters:
deprecateWhatsAppFlowRequest- AConsumerthat will call methods onDeprecateWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the DeprecateWhatsAppFlow operation returned by the service.
- See Also:
-
disassociateWhatsAppBusinessAccount
default DisassociateWhatsAppBusinessAccountResponse disassociateWhatsAppBusinessAccount(DisassociateWhatsAppBusinessAccountRequest disassociateWhatsAppBusinessAccountRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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:
-
disassociateWhatsAppBusinessAccount
default DisassociateWhatsAppBusinessAccountResponse disassociateWhatsAppBusinessAccount(Consumer<DisassociateWhatsAppBusinessAccountRequest.Builder> disassociateWhatsAppBusinessAccountRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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.Builderavoiding the need to create one manually viaDisassociateWhatsAppBusinessAccountRequest.builder()- Parameters:
disassociateWhatsAppBusinessAccountRequest- AConsumerthat will call methods onDisassociateWhatsAppBusinessAccountRequest.Builderto create a request.- Returns:
- Result of the DisassociateWhatsAppBusinessAccount operation returned by the service.
- See Also:
-
getLinkedWhatsAppBusinessAccount
default GetLinkedWhatsAppBusinessAccountResponse getLinkedWhatsAppBusinessAccount(GetLinkedWhatsAppBusinessAccountRequest getLinkedWhatsAppBusinessAccountRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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:
-
getLinkedWhatsAppBusinessAccount
default GetLinkedWhatsAppBusinessAccountResponse getLinkedWhatsAppBusinessAccount(Consumer<GetLinkedWhatsAppBusinessAccountRequest.Builder> getLinkedWhatsAppBusinessAccountRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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.Builderavoiding the need to create one manually viaGetLinkedWhatsAppBusinessAccountRequest.builder()- Parameters:
getLinkedWhatsAppBusinessAccountRequest- AConsumerthat will call methods onGetLinkedWhatsAppBusinessAccountRequest.Builderto create a request.- Returns:
- Result of the GetLinkedWhatsAppBusinessAccount operation returned by the service.
- See Also:
-
getLinkedWhatsAppBusinessAccountPhoneNumber
default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse getLinkedWhatsAppBusinessAccountPhoneNumber(GetLinkedWhatsAppBusinessAccountPhoneNumberRequest getLinkedWhatsAppBusinessAccountPhoneNumberRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.
- Parameters:
getLinkedWhatsAppBusinessAccountPhoneNumberRequest-- Returns:
- Result of the GetLinkedWhatsAppBusinessAccountPhoneNumber operation returned by the service.
- See Also:
-
getLinkedWhatsAppBusinessAccountPhoneNumber
default GetLinkedWhatsAppBusinessAccountPhoneNumberResponse getLinkedWhatsAppBusinessAccountPhoneNumber(Consumer<GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builder> getLinkedWhatsAppBusinessAccountPhoneNumberRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Retrieve the WABA account id and phone number details of a WhatsApp business account phone number.
This is a convenience which creates an instance of the
GetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builderavoiding the need to create one manually viaGetLinkedWhatsAppBusinessAccountPhoneNumberRequest.builder()- Parameters:
getLinkedWhatsAppBusinessAccountPhoneNumberRequest- AConsumerthat will call methods onGetLinkedWhatsAppBusinessAccountPhoneNumberRequest.Builderto create a request.- Returns:
- Result of the GetLinkedWhatsAppBusinessAccountPhoneNumber operation returned by the service.
- See Also:
-
getWhatsAppFlow
default GetWhatsAppFlowResponse getWhatsAppFlow(GetWhatsAppFlowRequest getWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.
- Parameters:
getWhatsAppFlowRequest-- Returns:
- Result of the GetWhatsAppFlow operation returned by the service.
- See Also:
-
getWhatsAppFlow
default GetWhatsAppFlowResponse getWhatsAppFlow(Consumer<GetWhatsAppFlowRequest.Builder> getWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.
This is a convenience which creates an instance of the
GetWhatsAppFlowRequest.Builderavoiding the need to create one manually viaGetWhatsAppFlowRequest.builder()- Parameters:
getWhatsAppFlowRequest- AConsumerthat will call methods onGetWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the GetWhatsAppFlow operation returned by the service.
- See Also:
-
getWhatsAppFlowPreview
default GetWhatsAppFlowPreviewResponse getWhatsAppFlowPreview(GetWhatsAppFlowPreviewRequest getWhatsAppFlowPreviewRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.
- Parameters:
getWhatsAppFlowPreviewRequest-- Returns:
- Result of the GetWhatsAppFlowPreview operation returned by the service.
- See Also:
-
getWhatsAppFlowPreview
default GetWhatsAppFlowPreviewResponse getWhatsAppFlowPreview(Consumer<GetWhatsAppFlowPreviewRequest.Builder> getWhatsAppFlowPreviewRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.
This is a convenience which creates an instance of the
GetWhatsAppFlowPreviewRequest.Builderavoiding the need to create one manually viaGetWhatsAppFlowPreviewRequest.builder()- Parameters:
getWhatsAppFlowPreviewRequest- AConsumerthat will call methods onGetWhatsAppFlowPreviewRequest.Builderto create a request.- Returns:
- Result of the GetWhatsAppFlowPreview operation returned by the service.
- See Also:
-
getWhatsAppMessageMedia
default GetWhatsAppMessageMediaResponse getWhatsAppMessageMedia(GetWhatsAppMessageMediaRequest getWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, 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
destinationS3FileordestinationS3PresignedUrlfor the destination. If both are used then anInvalidParameterExceptionis returned.- Parameters:
getWhatsAppMessageMediaRequest-- Returns:
- Result of the GetWhatsAppMessageMedia operation returned by the service.
- See Also:
-
getWhatsAppMessageMedia
default GetWhatsAppMessageMediaResponse getWhatsAppMessageMedia(Consumer<GetWhatsAppMessageMediaRequest.Builder> getWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, 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
destinationS3FileordestinationS3PresignedUrlfor the destination. If both are used then anInvalidParameterExceptionis returned.
This is a convenience which creates an instance of the
GetWhatsAppMessageMediaRequest.Builderavoiding the need to create one manually viaGetWhatsAppMessageMediaRequest.builder()- Parameters:
getWhatsAppMessageMediaRequest- AConsumerthat will call methods onGetWhatsAppMessageMediaRequest.Builderto create a request.- Returns:
- Result of the GetWhatsAppMessageMedia operation returned by the service.
- See Also:
-
getWhatsAppMessageTemplate
default GetWhatsAppMessageTemplateResponse getWhatsAppMessageTemplate(GetWhatsAppMessageTemplateRequest getWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
getWhatsAppMessageTemplate
default GetWhatsAppMessageTemplateResponse getWhatsAppMessageTemplate(Consumer<GetWhatsAppMessageTemplateRequest.Builder> getWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Retrieves a specific WhatsApp message template.
This is a convenience which creates an instance of the
GetWhatsAppMessageTemplateRequest.Builderavoiding the need to create one manually viaGetWhatsAppMessageTemplateRequest.builder()- Parameters:
getWhatsAppMessageTemplateRequest- AConsumerthat will call methods onGetWhatsAppMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the GetWhatsAppMessageTemplate operation returned by the service.
- See Also:
-
listLinkedWhatsAppBusinessAccounts
default ListLinkedWhatsAppBusinessAccountsResponse listLinkedWhatsAppBusinessAccounts(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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:
-
listLinkedWhatsAppBusinessAccounts
default ListLinkedWhatsAppBusinessAccountsResponse listLinkedWhatsAppBusinessAccounts(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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.Builderavoiding the need to create one manually viaListLinkedWhatsAppBusinessAccountsRequest.builder()- Parameters:
listLinkedWhatsAppBusinessAccountsRequest- AConsumerthat will call methods onListLinkedWhatsAppBusinessAccountsRequest.Builderto create a request.- Returns:
- Result of the ListLinkedWhatsAppBusinessAccounts operation returned by the service.
- See Also:
-
listLinkedWhatsAppBusinessAccountsPaginator
default ListLinkedWhatsAppBusinessAccountsIterable listLinkedWhatsAppBusinessAccountsPaginator(ListLinkedWhatsAppBusinessAccountsRequest listLinkedWhatsAppBusinessAccountsRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
listLinkedWhatsAppBusinessAccountsPaginator
default ListLinkedWhatsAppBusinessAccountsIterable listLinkedWhatsAppBusinessAccountsPaginator(Consumer<ListLinkedWhatsAppBusinessAccountsRequest.Builder> listLinkedWhatsAppBusinessAccountsRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListLinkedWhatsAppBusinessAccountsIterable responses = client.listLinkedWhatsAppBusinessAccountsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListLinkedWhatsAppBusinessAccountsRequest.builder()- Parameters:
listLinkedWhatsAppBusinessAccountsRequest- AConsumerthat will call methods onListLinkedWhatsAppBusinessAccountsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listWhatsAppFlowAssets
default ListWhatsAppFlowAssetsResponse listWhatsAppFlowAssets(ListWhatsAppFlowAssetsRequest listWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period.
- Parameters:
listWhatsAppFlowAssetsRequest-- Returns:
- Result of the ListWhatsAppFlowAssets operation returned by the service.
- See Also:
-
listWhatsAppFlowAssets
default ListWhatsAppFlowAssetsResponse listWhatsAppFlowAssets(Consumer<ListWhatsAppFlowAssetsRequest.Builder> listWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period.
This is a convenience which creates an instance of the
ListWhatsAppFlowAssetsRequest.Builderavoiding the need to create one manually viaListWhatsAppFlowAssetsRequest.builder()- Parameters:
listWhatsAppFlowAssetsRequest- AConsumerthat will call methods onListWhatsAppFlowAssetsRequest.Builderto create a request.- Returns:
- Result of the ListWhatsAppFlowAssets operation returned by the service.
- See Also:
-
listWhatsAppFlowAssetsPaginator
default ListWhatsAppFlowAssetsIterable listWhatsAppFlowAssetsPaginator(ListWhatsAppFlowAssetsRequest listWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException This is a variant of
listWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client.listWhatsAppFlowAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client .listWhatsAppFlowAssetsPaginator(request); for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client.listWhatsAppFlowAssetsPaginator(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
listWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation.- Parameters:
listWhatsAppFlowAssetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatsAppFlowAssetsPaginator
default ListWhatsAppFlowAssetsIterable listWhatsAppFlowAssetsPaginator(Consumer<ListWhatsAppFlowAssetsRequest.Builder> listWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException This is a variant of
listWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client.listWhatsAppFlowAssetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client .listWhatsAppFlowAssetsPaginator(request); for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowAssetsIterable responses = client.listWhatsAppFlowAssetsPaginator(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
listWhatsAppFlowAssets(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowAssetsRequest)operation.
This is a convenience which creates an instance of the
ListWhatsAppFlowAssetsRequest.Builderavoiding the need to create one manually viaListWhatsAppFlowAssetsRequest.builder()- Parameters:
listWhatsAppFlowAssetsRequest- AConsumerthat will call methods onListWhatsAppFlowAssetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatsAppFlows
default ListWhatsAppFlowsResponse listWhatsAppFlows(ListWhatsAppFlowsRequest listWhatsAppFlowsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.
- Parameters:
listWhatsAppFlowsRequest-- Returns:
- Result of the ListWhatsAppFlows operation returned by the service.
- See Also:
-
listWhatsAppFlows
default ListWhatsAppFlowsResponse listWhatsAppFlows(Consumer<ListWhatsAppFlowsRequest.Builder> listWhatsAppFlowsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.
This is a convenience which creates an instance of the
ListWhatsAppFlowsRequest.Builderavoiding the need to create one manually viaListWhatsAppFlowsRequest.builder()- Parameters:
listWhatsAppFlowsRequest- AConsumerthat will call methods onListWhatsAppFlowsRequest.Builderto create a request.- Returns:
- Result of the ListWhatsAppFlows operation returned by the service.
- See Also:
-
listWhatsAppFlowsPaginator
default ListWhatsAppFlowsIterable listWhatsAppFlowsPaginator(ListWhatsAppFlowsRequest listWhatsAppFlowsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException This is a variant of
listWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client.listWhatsAppFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client .listWhatsAppFlowsPaginator(request); for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client.listWhatsAppFlowsPaginator(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
listWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation.- Parameters:
listWhatsAppFlowsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatsAppFlowsPaginator
default ListWhatsAppFlowsIterable listWhatsAppFlowsPaginator(Consumer<ListWhatsAppFlowsRequest.Builder> listWhatsAppFlowsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException This is a variant of
listWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client.listWhatsAppFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client .listWhatsAppFlowsPaginator(request); for (software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppFlowsIterable responses = client.listWhatsAppFlowsPaginator(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
listWhatsAppFlows(software.amazon.awssdk.services.socialmessaging.model.ListWhatsAppFlowsRequest)operation.
This is a convenience which creates an instance of the
ListWhatsAppFlowsRequest.Builderavoiding the need to create one manually viaListWhatsAppFlowsRequest.builder()- Parameters:
listWhatsAppFlowsRequest- AConsumerthat will call methods onListWhatsAppFlowsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatsAppMessageTemplates
default ListWhatsAppMessageTemplatesResponse listWhatsAppMessageTemplates(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
listWhatsAppMessageTemplates
default ListWhatsAppMessageTemplatesResponse listWhatsAppMessageTemplates(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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.Builderavoiding the need to create one manually viaListWhatsAppMessageTemplatesRequest.builder()- Parameters:
listWhatsAppMessageTemplatesRequest- AConsumerthat will call methods onListWhatsAppMessageTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListWhatsAppMessageTemplates operation returned by the service.
- See Also:
-
listWhatsAppMessageTemplatesPaginator
default ListWhatsAppMessageTemplatesIterable listWhatsAppMessageTemplatesPaginator(ListWhatsAppMessageTemplatesRequest listWhatsAppMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
listWhatsAppMessageTemplatesPaginator
default ListWhatsAppMessageTemplatesIterable listWhatsAppMessageTemplatesPaginator(Consumer<ListWhatsAppMessageTemplatesRequest.Builder> listWhatsAppMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppMessageTemplatesIterable responses = client.listWhatsAppMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWhatsAppMessageTemplatesRequest.builder()- Parameters:
listWhatsAppMessageTemplatesRequest- AConsumerthat will call methods onListWhatsAppMessageTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatsAppTemplateLibrary
default ListWhatsAppTemplateLibraryResponse listWhatsAppTemplateLibrary(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
listWhatsAppTemplateLibrary
default ListWhatsAppTemplateLibraryResponse listWhatsAppTemplateLibrary(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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.Builderavoiding the need to create one manually viaListWhatsAppTemplateLibraryRequest.builder()- Parameters:
listWhatsAppTemplateLibraryRequest- AConsumerthat will call methods onListWhatsAppTemplateLibraryRequest.Builderto create a request.- Returns:
- Result of the ListWhatsAppTemplateLibrary operation returned by the service.
- See Also:
-
listWhatsAppTemplateLibraryPaginator
default ListWhatsAppTemplateLibraryIterable listWhatsAppTemplateLibraryPaginator(ListWhatsAppTemplateLibraryRequest listWhatsAppTemplateLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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:
-
listWhatsAppTemplateLibraryPaginator
default ListWhatsAppTemplateLibraryIterable listWhatsAppTemplateLibraryPaginator(Consumer<ListWhatsAppTemplateLibraryRequest.Builder> listWhatsAppTemplateLibraryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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
2) Using For loopsoftware.amazon.awssdk.services.socialmessaging.paginators.ListWhatsAppTemplateLibraryIterable responses = client.listWhatsAppTemplateLibraryPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListWhatsAppTemplateLibraryRequest.builder()- Parameters:
listWhatsAppTemplateLibraryRequest- AConsumerthat will call methods onListWhatsAppTemplateLibraryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
postWhatsAppMessageMedia
default PostWhatsAppMessageMediaResponse postWhatsAppMessageMedia(PostWhatsAppMessageMediaRequest postWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Upload a media file to the WhatsApp service. Only the specified
originationPhoneNumberIdhas the permissions to send the media file when using SendWhatsAppMessage. You must use eithersourceS3FileorsourceS3PresignedUrlfor the source. If both or neither are specified then anInvalidParameterExceptionis returned.- Parameters:
postWhatsAppMessageMediaRequest-- Returns:
- Result of the PostWhatsAppMessageMedia operation returned by the service.
- See Also:
-
postWhatsAppMessageMedia
default PostWhatsAppMessageMediaResponse postWhatsAppMessageMedia(Consumer<PostWhatsAppMessageMediaRequest.Builder> postWhatsAppMessageMediaRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Upload a media file to the WhatsApp service. Only the specified
originationPhoneNumberIdhas the permissions to send the media file when using SendWhatsAppMessage. You must use eithersourceS3FileorsourceS3PresignedUrlfor the source. If both or neither are specified then anInvalidParameterExceptionis returned.
This is a convenience which creates an instance of the
PostWhatsAppMessageMediaRequest.Builderavoiding the need to create one manually viaPostWhatsAppMessageMediaRequest.builder()- Parameters:
postWhatsAppMessageMediaRequest- AConsumerthat will call methods onPostWhatsAppMessageMediaRequest.Builderto create a request.- Returns:
- Result of the PostWhatsAppMessageMedia operation returned by the service.
- See Also:
-
publishWhatsAppFlow
default PublishWhatsAppFlowResponse publishWhatsAppFlow(PublishWhatsAppFlowRequest publishWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation.
- Parameters:
publishWhatsAppFlowRequest-- Returns:
- Result of the PublishWhatsAppFlow operation returned by the service.
- See Also:
-
publishWhatsAppFlow
default PublishWhatsAppFlowResponse publishWhatsAppFlow(Consumer<PublishWhatsAppFlowRequest.Builder> publishWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation.
This is a convenience which creates an instance of the
PublishWhatsAppFlowRequest.Builderavoiding the need to create one manually viaPublishWhatsAppFlowRequest.builder()- Parameters:
publishWhatsAppFlowRequest- AConsumerthat will call methods onPublishWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the PublishWhatsAppFlow operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaPutWhatsAppBusinessAccountEventDestinationsRequest.builder()- Parameters:
putWhatsAppBusinessAccountEventDestinationsRequest- AConsumerthat will call methods onPutWhatsAppBusinessAccountEventDestinationsRequest.Builderto create a request.- Returns:
- Result of the PutWhatsAppBusinessAccountEventDestinations operation returned by the service.
- See Also:
-
sendWhatsAppMessage
default SendWhatsAppMessageResponse sendWhatsAppMessage(SendWhatsAppMessageRequest sendWhatsAppMessageRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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:
-
sendWhatsAppMessage
default SendWhatsAppMessageResponse sendWhatsAppMessage(Consumer<SendWhatsAppMessageRequest.Builder> sendWhatsAppMessageRequest) throws ValidationException, AccessDeniedException, InvalidParametersException, ResourceNotFoundException, 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.Builderavoiding the need to create one manually viaSendWhatsAppMessageRequest.builder()- Parameters:
sendWhatsAppMessageRequest- AConsumerthat will call methods onSendWhatsAppMessageRequest.Builderto create a request.- Returns:
- Result of the SendWhatsAppMessage operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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:
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateWhatsAppFlow
default UpdateWhatsAppFlowResponse updateWhatsAppFlow(UpdateWhatsAppFlowRequest updateWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.
- Parameters:
updateWhatsAppFlowRequest-- Returns:
- Result of the UpdateWhatsAppFlow operation returned by the service.
- See Also:
-
updateWhatsAppFlow
default UpdateWhatsAppFlowResponse updateWhatsAppFlow(Consumer<UpdateWhatsAppFlowRequest.Builder> updateWhatsAppFlowRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use UpdateWhatsAppFlowAssets to update the Flow JSON.
This is a convenience which creates an instance of the
UpdateWhatsAppFlowRequest.Builderavoiding the need to create one manually viaUpdateWhatsAppFlowRequest.builder()- Parameters:
updateWhatsAppFlowRequest- AConsumerthat will call methods onUpdateWhatsAppFlowRequest.Builderto create a request.- Returns:
- Result of the UpdateWhatsAppFlow operation returned by the service.
- See Also:
-
updateWhatsAppFlowAssets
default UpdateWhatsAppFlowAssetsResponse updateWhatsAppFlowAssets(UpdateWhatsAppFlowAssetsRequest updateWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.
- Parameters:
updateWhatsAppFlowAssetsRequest-- Returns:
- Result of the UpdateWhatsAppFlowAssets operation returned by the service.
- See Also:
-
updateWhatsAppFlowAssets
default UpdateWhatsAppFlowAssetsResponse updateWhatsAppFlowAssets(Consumer<UpdateWhatsAppFlowAssetsRequest.Builder> updateWhatsAppFlowAssetsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.
This is a convenience which creates an instance of the
UpdateWhatsAppFlowAssetsRequest.Builderavoiding the need to create one manually viaUpdateWhatsAppFlowAssetsRequest.builder()- Parameters:
updateWhatsAppFlowAssetsRequest- AConsumerthat will call methods onUpdateWhatsAppFlowAssetsRequest.Builderto create a request.- Returns:
- Result of the UpdateWhatsAppFlowAssets operation returned by the service.
- See Also:
-
updateWhatsAppMessageTemplate
default UpdateWhatsAppMessageTemplateResponse updateWhatsAppMessageTemplate(UpdateWhatsAppMessageTemplateRequest updateWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, 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:
-
updateWhatsAppMessageTemplate
default UpdateWhatsAppMessageTemplateResponse updateWhatsAppMessageTemplate(Consumer<UpdateWhatsAppMessageTemplateRequest.Builder> updateWhatsAppMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidParametersException, AccessDeniedByMetaException, ThrottledRequestException, InternalServiceException, DependencyException, AwsServiceException, SdkClientException, SocialMessagingException Updates an existing WhatsApp message template.
This is a convenience which creates an instance of the
UpdateWhatsAppMessageTemplateRequest.Builderavoiding the need to create one manually viaUpdateWhatsAppMessageTemplateRequest.builder()- Parameters:
updateWhatsAppMessageTemplateRequest- AConsumerthat will call methods onUpdateWhatsAppMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateWhatsAppMessageTemplate operation returned by the service.
- See Also:
-
create
Create aSocialMessagingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSocialMessagingClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-