Class: Aws::SocialMessaging::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SocialMessaging::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb
Overview
An API client for SocialMessaging. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SocialMessaging::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_whats_app_business_account(params = {}) ⇒ Types::AssociateWhatsAppBusinessAccountOutput
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.
-
#create_whats_app_message_template(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateOutput
Creates a new WhatsApp message template from a custom definition.
-
#create_whats_app_message_template_from_library(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateFromLibraryOutput
Creates a new WhatsApp message template using a template from Meta's template library.
-
#create_whats_app_message_template_media(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateMediaOutput
Uploads media for use in a WhatsApp message template.
-
#delete_whats_app_message_media(params = {}) ⇒ Types::DeleteWhatsAppMessageMediaOutput
Delete a media object from the WhatsApp service.
-
#delete_whats_app_message_template(params = {}) ⇒ Struct
Deletes a WhatsApp message template.
-
#disassociate_whats_app_business_account(params = {}) ⇒ Struct
Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
-
#get_linked_whats_app_business_account(params = {}) ⇒ Types::GetLinkedWhatsAppBusinessAccountOutput
Get the details of your linked WhatsApp Business Account.
-
#get_linked_whats_app_business_account_phone_number(params = {}) ⇒ Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput
Use your WhatsApp phone number id to get the WABA account id and phone number details.
-
#get_whats_app_message_media(params = {}) ⇒ Types::GetWhatsAppMessageMediaOutput
Get a media file from the WhatsApp service.
-
#get_whats_app_message_template(params = {}) ⇒ Types::GetWhatsAppMessageTemplateOutput
Retrieves a specific WhatsApp message template.
-
#list_linked_whats_app_business_accounts(params = {}) ⇒ Types::ListLinkedWhatsAppBusinessAccountsOutput
List all WhatsApp Business Accounts linked to your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List all tags associated with a resource, such as a phone number or WABA.
-
#list_whats_app_message_templates(params = {}) ⇒ Types::ListWhatsAppMessageTemplatesOutput
Lists WhatsApp message templates for a specific WhatsApp Business Account.
-
#list_whats_app_template_library(params = {}) ⇒ Types::ListWhatsAppTemplateLibraryOutput
Lists templates available in Meta's template library for WhatsApp messaging.
-
#post_whats_app_message_media(params = {}) ⇒ Types::PostWhatsAppMessageMediaOutput
Upload a media file to the WhatsApp service.
-
#put_whats_app_business_account_event_destinations(params = {}) ⇒ Struct
Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).
-
#send_whats_app_message(params = {}) ⇒ Types::SendWhatsAppMessageOutput
Send a WhatsApp message.
-
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
Adds or overwrites only the specified tags for the specified resource.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceOutput
Removes the specified tags from a resource.
-
#update_whats_app_message_template(params = {}) ⇒ Struct
Updates an existing WhatsApp message template.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
476 477 478 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 476 def initialize(*args) super end |
Instance Method Details
#associate_whats_app_business_account(params = {}) ⇒ Types::AssociateWhatsAppBusinessAccountOutput
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.
561 562 563 564 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 561 def associate_whats_app_business_account(params = {}, = {}) req = build_request(:associate_whats_app_business_account, params) req.send_request() end |
#create_whats_app_message_template(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateOutput
Creates a new WhatsApp message template from a custom definition.
598 599 600 601 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 598 def (params = {}, = {}) req = build_request(:create_whats_app_message_template, params) req.send_request() end |
#create_whats_app_message_template_from_library(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateFromLibraryOutput
Creates a new WhatsApp message template using a template from Meta's template library.
665 666 667 668 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 665 def (params = {}, = {}) req = build_request(:create_whats_app_message_template_from_library, params) req.send_request() end |
#create_whats_app_message_template_media(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateMediaOutput
Uploads media for use in a WhatsApp message template.
701 702 703 704 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 701 def (params = {}, = {}) req = build_request(:create_whats_app_message_template_media, params) req.send_request() end |
#delete_whats_app_message_media(params = {}) ⇒ Types::DeleteWhatsAppMessageMediaOutput
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.
746 747 748 749 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 746 def (params = {}, = {}) req = build_request(:delete_whats_app_message_media, params) req.send_request() end |
#delete_whats_app_message_template(params = {}) ⇒ Struct
Deletes a WhatsApp message template.
780 781 782 783 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 780 def (params = {}, = {}) req = build_request(:delete_whats_app_message_template, params) req.send_request() end |
#disassociate_whats_app_business_account(params = {}) ⇒ Struct
Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
810 811 812 813 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 810 def disassociate_whats_app_business_account(params = {}, = {}) req = build_request(:disassociate_whats_app_business_account, params) req.send_request() end |
#get_linked_whats_app_business_account(params = {}) ⇒ Types::GetLinkedWhatsAppBusinessAccountOutput
Get the details of your linked WhatsApp Business Account.
863 864 865 866 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 863 def get_linked_whats_app_business_account(params = {}, = {}) req = build_request(:get_linked_whats_app_business_account, params) req.send_request() end |
#get_linked_whats_app_business_account_phone_number(params = {}) ⇒ Types::GetLinkedWhatsAppBusinessAccountPhoneNumberOutput
Use your WhatsApp phone number id to get the WABA account id and phone number details.
908 909 910 911 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 908 def get_linked_whats_app_business_account_phone_number(params = {}, = {}) req = build_request(:get_linked_whats_app_business_account_phone_number, params) req.send_request() end |
#get_whats_app_message_media(params = {}) ⇒ Types::GetWhatsAppMessageMediaOutput
Get a media file from the WhatsApp service. On successful completion
the media file is retrieved from Meta and stored in the specified
Amazon S3 bucket. Use either destinationS3File
or
destinationS3PresignedUrl
for the destination. If both are used then
an InvalidParameterException
is returned.
973 974 975 976 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 973 def (params = {}, = {}) req = build_request(:get_whats_app_message_media, params) req.send_request() end |
#get_whats_app_message_template(params = {}) ⇒ Types::GetWhatsAppMessageTemplateOutput
Retrieves a specific WhatsApp message template.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1005 def (params = {}, = {}) req = build_request(:get_whats_app_message_template, params) req.send_request() end |
#list_linked_whats_app_business_accounts(params = {}) ⇒ Types::ListLinkedWhatsAppBusinessAccountsOutput
List all WhatsApp Business Accounts linked to your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1051 def list_linked_whats_app_business_accounts(params = {}, = {}) req = build_request(:list_linked_whats_app_business_accounts, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List all tags associated with a resource, such as a phone number or WABA.
1085 1086 1087 1088 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1085 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_whats_app_message_templates(params = {}) ⇒ Types::ListWhatsAppMessageTemplatesOutput
Lists WhatsApp message templates for a specific WhatsApp Business Account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1132 def (params = {}, = {}) req = build_request(:list_whats_app_message_templates, params) req.send_request() end |
#list_whats_app_template_library(params = {}) ⇒ Types::ListWhatsAppTemplateLibraryOutput
Lists templates available in Meta's template library for WhatsApp messaging.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1200 def list_whats_app_template_library(params = {}, = {}) req = build_request(:list_whats_app_template_library, params) req.send_request() end |
#post_whats_app_message_media(params = {}) ⇒ Types::PostWhatsAppMessageMediaOutput
Upload a media file to the WhatsApp service. Only the specified
originationPhoneNumberId
has the permissions to send the media file
when using SendWhatsAppMessage. You must use either
sourceS3File
or sourceS3PresignedUrl
for the source. If both or
neither are specified then an InvalidParameterException
is returned.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1259 def (params = {}, = {}) req = build_request(:post_whats_app_message_media, params) req.send_request() end |
#put_whats_app_business_account_event_destinations(params = {}) ⇒ Struct
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.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1301 def put_whats_app_business_account_event_destinations(params = {}, = {}) req = build_request(:put_whats_app_business_account_event_destinations, params) req.send_request() end |
#send_whats_app_message(params = {}) ⇒ Types::SendWhatsAppMessageOutput
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 .
1364 1365 1366 1367 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1364 def (params = {}, = {}) req = build_request(:send_whats_app_message, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1403 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceOutput
Removes the specified tags from a resource.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1435 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_whats_app_message_template(params = {}) ⇒ Struct
Updates an existing WhatsApp message template.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1470 def (params = {}, = {}) req = build_request(:update_whats_app_message_template, params) req.send_request() end |