Struct Client

pub struct Client { /* private fields */ }

Client for AWS End User Messaging Social

Client for invoking operations on AWS End User Messaging Social. Each operation on AWS End User Messaging Social is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_socialmessaging::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_socialmessaging::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteWhatsAppMessageMedia operation has a Client::delete_whats_app_message_media, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_whats_app_message_media()
    .media_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_whats_app_business_account( &self, ) -> AssociateWhatsAppBusinessAccountFluentBuilder

Constructs a fluent builder for the AssociateWhatsAppBusinessAccount operation.

• The fluent builder is configurable:
  • signup_callback(WhatsAppSignupCallback) / set_signup_callback(Option<WhatsAppSignupCallback>):
    required: false
    

    Contains the callback access token.

    
    
  • setup_finalization(WhatsAppSetupFinalization) / set_setup_finalization(Option<WhatsAppSetupFinalization>):
    required: false
    

    A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.

    
    
• On success, responds with AssociateWhatsAppBusinessAccountOutput with field(s):
  • signup_callback_result(Option<WhatsAppSignupCallbackResult>):

    Contains your WhatsApp registration status.

  • status_code(Option<i32>):

    The status code for the response.

• On failure, responds with SdkError<AssociateWhatsAppBusinessAccountError>

impl Client

pub fn delete_whats_app_message_media( &self, ) -> DeleteWhatsAppMessageMediaFluentBuilder

Constructs a fluent builder for the DeleteWhatsAppMessageMedia operation.

• The fluent builder is configurable:
  • media_id(impl Into<String>) / set_media_id(Option<String>):
    required: true
    

    The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.

    
    
  • origination_phone_number_id(impl Into<String>) / set_origination_phone_number_id(Option<String>):
    required: true
    

    The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

    
    
• On success, responds with DeleteWhatsAppMessageMediaOutput with field(s):
  • success(Option<bool>):

    Success indicator for deleting the media file.

• On failure, responds with SdkError<DeleteWhatsAppMessageMediaError>

impl Client

pub fn disassociate_whats_app_business_account( &self, ) -> DisassociateWhatsAppBusinessAccountFluentBuilder

Constructs a fluent builder for the DisassociateWhatsAppBusinessAccount operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

    
    
• On success, responds with DisassociateWhatsAppBusinessAccountOutput
• On failure, responds with SdkError<DisassociateWhatsAppBusinessAccountError>

impl Client

pub fn get_linked_whats_app_business_account( &self, ) -> GetLinkedWhatsAppBusinessAccountFluentBuilder

Constructs a fluent builder for the GetLinkedWhatsAppBusinessAccount operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

    
    
• On success, responds with GetLinkedWhatsAppBusinessAccountOutput with field(s):
  • account(Option<LinkedWhatsAppBusinessAccount>):

    The details of the linked WhatsApp Business Account.

• On failure, responds with SdkError<GetLinkedWhatsAppBusinessAccountError>

impl Client

pub fn get_linked_whats_app_business_account_phone_number( &self, ) -> GetLinkedWhatsAppBusinessAccountPhoneNumberFluentBuilder

Constructs a fluent builder for the GetLinkedWhatsAppBusinessAccountPhoneNumber operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the phone number. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

    
    
• On success, responds with GetLinkedWhatsAppBusinessAccountPhoneNumberOutput with field(s):
  • phone_number(Option<WhatsAppPhoneNumberDetail>):

    The details of your WhatsApp phone number.

  • linked_whats_app_business_account_id(Option<String>):

    The WABA identifier linked to the phone number, formatted as waba-01234567890123456789012345678901.

• On failure, responds with SdkError<GetLinkedWhatsAppBusinessAccountPhoneNumberError>

impl Client

pub fn get_whats_app_message_media( &self, ) -> GetWhatsAppMessageMediaFluentBuilder

Constructs a fluent builder for the GetWhatsAppMessageMedia operation.

• The fluent builder is configurable:
  • media_id(impl Into<String>) / set_media_id(Option<String>):
    required: true
    

    The unique identifier for the media file.

    
    
  • origination_phone_number_id(impl Into<String>) / set_origination_phone_number_id(Option<String>):
    required: true
    

    The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

    
    
  • metadata_only(bool) / set_metadata_only(Option<bool>):
    required: false
    

    Set to True to get only the metadata for the file.

    
    
  • destination_s3_presigned_url(S3PresignedUrl) / set_destination_s3_presigned_url(Option<S3PresignedUrl>):
    required: false
    

    The presign url of the media file.

    
    
  • destination_s3_file(S3File) / set_destination_s3_file(Option<S3File>):
    required: false
    

    The bucketName and key of the S3 media file.

    
    
• On success, responds with GetWhatsAppMessageMediaOutput with field(s):
  • mime_type(Option<String>):

    The MIME type of the media.

  • file_size(Option<i64>):

    The file size of the media, in KB.

• On failure, responds with SdkError<GetWhatsAppMessageMediaError>

impl Client

pub fn list_linked_whats_app_business_accounts( &self, ) -> ListLinkedWhatsAppBusinessAccountsFluentBuilder

Constructs a fluent builder for the ListLinkedWhatsAppBusinessAccounts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The next token for pagination.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
• On success, responds with ListLinkedWhatsAppBusinessAccountsOutput with field(s):
  • linked_accounts(Option<Vec::<LinkedWhatsAppBusinessAccountSummary>>):

    A list of WhatsApp Business Accounts linked to your Amazon Web Services account.

  • next_token(Option<String>):

    The next token for pagination.

• On failure, responds with SdkError<ListLinkedWhatsAppBusinessAccountsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to retrieve the tags from.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • status_code(Option<i32>):

    The status code of the response.

  • tags(Option<Vec::<Tag>>):

    The tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn post_whats_app_message_media( &self, ) -> PostWhatsAppMessageMediaFluentBuilder

Constructs a fluent builder for the PostWhatsAppMessageMedia operation.

• The fluent builder is configurable:
  • origination_phone_number_id(impl Into<String>) / set_origination_phone_number_id(Option<String>):
    required: true
    

    The ID of the phone number to associate with the WhatsApp media file. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

    
    
  • source_s3_presigned_url(S3PresignedUrl) / set_source_s3_presigned_url(Option<S3PresignedUrl>):
    required: false
    

    The source presign url of the media file.

    
    
  • source_s3_file(S3File) / set_source_s3_file(Option<S3File>):
    required: false
    

    The source S3 url for the media file.

    
    
• On success, responds with PostWhatsAppMessageMediaOutput with field(s):
  • media_id(Option<String>):

    The unique identifier of the posted WhatsApp message.

• On failure, responds with SdkError<PostWhatsAppMessageMediaError>

impl Client

pub fn put_whats_app_business_account_event_destinations( &self, ) -> PutWhatsAppBusinessAccountEventDestinationsFluentBuilder

Constructs a fluent builder for the PutWhatsAppBusinessAccountEventDestinations operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

    
    
  • event_destinations(WhatsAppBusinessAccountEventDestination) / set_event_destinations(Option<Vec::<WhatsAppBusinessAccountEventDestination>>):
    required: true
    

    An array of WhatsAppBusinessAccountEventDestination event destinations.

    
    
• On success, responds with PutWhatsAppBusinessAccountEventDestinationsOutput
• On failure, responds with SdkError<PutWhatsAppBusinessAccountEventDestinationsError>

impl Client

pub fn send_whats_app_message(&self) -> SendWhatsAppMessageFluentBuilder

Constructs a fluent builder for the SendWhatsAppMessage operation.

• The fluent builder is configurable:
  • origination_phone_number_id(impl Into<String>) / set_origination_phone_number_id(Option<String>):
    required: true
    

    The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s id.

    
    
  • message(Blob) / set_message(Option<Blob>):
    required: true
    

    The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.

    
    
  • meta_api_version(impl Into<String>) / set_meta_api_version(Option<String>):
    required: true
    

    The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

    
    
• On success, responds with SendWhatsAppMessageOutput with field(s):
  • message_id(Option<String>):

    The unique identifier of the message.

• On failure, responds with SdkError<SendWhatsAppMessageError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to tag.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to add to the resource.

    
    
• On success, responds with TagResourceOutput with field(s):
  • status_code(Option<i32>):

    The status code of the tag resource operation.

• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput with field(s):
  • status_code(Option<i32>):

    The status code of the untag resource operation.

• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.