Class: Aws::SocialMessaging::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SocialMessaging::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::SocialMessaging::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 473

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.

Examples:

Request syntax with placeholder values


resp = client.({
  signup_callback: {
    access_token: "WhatsAppSignupCallbackAccessTokenString", # required
    callback_url: "WhatsAppSignupCallbackCallbackUrlString",
  },
  setup_finalization: {
    associate_in_progress_token: "AssociateInProgressToken", # required
    phone_numbers: [ # required
      {
        id: "WhatsAppPhoneNumber", # required
        two_factor_pin: "TwoFactorPin", # required
        data_localization_region: "IsoCountryCode",
        tags: [
          {
            key: "TagKeyString", # required
            value: "TagValueString",
          },
        ],
      },
    ],
    phone_number_parent: "LinkedWhatsAppBusinessAccountId",
    waba: {
      id: "WhatsAppBusinessAccountId",
      event_destinations: [
        {
          event_destination_arn: "EventDestinationArn", # required
          role_arn: "RoleArn",
        },
      ],
      tags: [
        {
          key: "TagKeyString", # required
          value: "TagValueString",
        },
      ],
    },
  },
})

Response structure


resp..associate_in_progress_token #=> String
resp..linked_accounts_with_incomplete_setup #=> Hash
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"]. #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].registration_status #=> String, one of "COMPLETE", "INCOMPLETE"
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers #=> Array
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].arn #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].phone_number #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].phone_number_id #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].meta_phone_number_id #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number_name #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].display_phone_number #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].quality_rating #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].unregistered_whats_app_phone_numbers[0].data_localization_region #=> String
resp..linked_accounts_with_incomplete_setup["WhatsAppBusinessAccountId"].waba_id #=> String
resp.status_code #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



558
559
560
561
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 558

def (params = {}, options = {})
  req = build_request(:associate_whats_app_business_account, params)
  req.send_request(options)
end

#create_whats_app_message_template(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateOutput

Creates a new WhatsApp message template from a custom definition.

Examples:

Request syntax with placeholder values


resp = client.create_whats_app_message_template({
  template_definition: "data", # required
  id: "LinkedWhatsAppBusinessAccountId", # required
})

Response structure


resp.meta_template_id #=> String
resp.template_status #=> String
resp.category #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_definition (required, String, StringIO, File) —

    The complete template definition as a JSON blob.

  • :id (required, String) —

    The ID of the WhatsApp Business Account to associate with this template.

Returns:

See Also:



595
596
597
598
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 595

def create_whats_app_message_template(params = {}, options = {})
  req = build_request(:create_whats_app_message_template, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_whats_app_message_template_from_library({
  meta_library_template: { # required
    template_name: "MetaTemplateName", # required
    library_template_name: "MetaTemplateName", # required
    template_category: "MetaTemplateCategory", # required
    template_language: "MetaTemplateLanguage", # required
    library_template_button_inputs: [
      {
        type: "ButtonType",
        phone_number: "PhoneNumber",
        url: {
          "MetaUrlWithSuffixExampleKeyString" => "MetaUrlWithSuffixExampleValueString",
        },
        otp_type: "OtpType",
        zero_tap_terms_accepted: false,
        supported_apps: [
          {
            "SupportedAppKeyString" => "SupportedAppValueString",
          },
        ],
      },
    ],
    library_template_body_inputs: {
      add_contact_number: false,
      add_learn_more_link: false,
      add_security_recommendation: false,
      add_track_package_link: false,
      code_expiration_minutes: 1,
    },
  },
  id: "LinkedWhatsAppBusinessAccountId", # required
})

Response structure


resp.meta_template_id #=> String
resp.template_status #=> String
resp.category #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meta_library_template (required, Types::MetaLibraryTemplate) —

    The template configuration from Meta's library, including customizations for buttons and body text.

  • :id (required, String) —

    The ID of the WhatsApp Business Account to associate with this template.

Returns:

See Also:



662
663
664
665
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 662

def create_whats_app_message_template_from_library(params = {}, options = {})
  req = build_request(:create_whats_app_message_template_from_library, params)
  req.send_request(options)
end

#create_whats_app_message_template_media(params = {}) ⇒ Types::CreateWhatsAppMessageTemplateMediaOutput

Uploads media for use in a WhatsApp message template.

Examples:

Request syntax with placeholder values


resp = client.create_whats_app_message_template_media({
  id: "LinkedWhatsAppBusinessAccountId", # required
  source_s3_file: {
    bucket_name: "S3FileBucketNameString", # required
    key: "S3FileKeyString", # required
  },
})

Response structure


resp.meta_header_handle #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the WhatsApp Business Account associated with this media upload.

  • :source_s3_file (Types::S3File) —

    Contains information for the S3 bucket that contains media files.

Returns:

See Also:



698
699
700
701
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 698

def create_whats_app_message_template_media(params = {}, options = {})
  req = build_request(:create_whats_app_message_template_media, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_whats_app_message_media({
  media_id: "WhatsAppMediaId", # required
  origination_phone_number_id: "WhatsAppPhoneNumberId", # required
})

Response structure


resp.success #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :media_id (required, String) —

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

  • :origination_phone_number_id (required, String) —

    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.

Returns:

See Also:



743
744
745
746
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 743

def delete_whats_app_message_media(params = {}, options = {})
  req = build_request(:delete_whats_app_message_media, params)
  req.send_request(options)
end

#delete_whats_app_message_template(params = {}) ⇒ Struct

Deletes a WhatsApp message template.

Examples:

Request syntax with placeholder values


resp = client.delete_whats_app_message_template({
  meta_template_id: "MetaTemplateId",
  delete_all_languages: false,
  id: "LinkedWhatsAppBusinessAccountId", # required
  template_name: "MetaTemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meta_template_id (String) —

    The numeric ID of the template assigned by Meta.

  • :delete_all_languages (Boolean) —

    If true, deletes all language versions of the template.

  • :id (required, String) —

    The ID of the WhatsApp Business Account associated with this template.

  • :template_name (required, String) —

    The name of the template to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



777
778
779
780
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 777

def delete_whats_app_message_template(params = {}, options = {})
  req = build_request(:delete_whats_app_message_template, params)
  req.send_request(options)
end

#disassociate_whats_app_business_account(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.({
  id: "LinkedWhatsAppBusinessAccountId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



807
808
809
810
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 807

def (params = {}, options = {})
  req = build_request(:disassociate_whats_app_business_account, params)
  req.send_request(options)
end

#get_linked_whats_app_business_account(params = {}) ⇒ Types::GetLinkedWhatsAppBusinessAccountOutput

Get the details of your linked WhatsApp Business Account.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "LinkedWhatsAppBusinessAccountId", # required
})

Response structure


resp..arn #=> String
resp..id #=> String
resp..waba_id #=> String
resp..registration_status #=> String, one of "COMPLETE", "INCOMPLETE"
resp..link_date #=> Time
resp..waba_name #=> String
resp..event_destinations #=> Array
resp..event_destinations[0].event_destination_arn #=> String
resp..event_destinations[0].role_arn #=> String
resp..phone_numbers #=> Array
resp..phone_numbers[0].arn #=> String
resp..phone_numbers[0].phone_number #=> String
resp..phone_numbers[0].phone_number_id #=> String
resp..phone_numbers[0].meta_phone_number_id #=> String
resp..phone_numbers[0].display_phone_number_name #=> String
resp..phone_numbers[0].display_phone_number #=> String
resp..phone_numbers[0].quality_rating #=> String
resp..phone_numbers[0].data_localization_region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    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.

Returns:

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 860

def (params = {}, options = {})
  req = build_request(:get_linked_whats_app_business_account, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "WhatsAppPhoneNumberId", # required
})

Response structure


resp.phone_number.arn #=> String
resp.phone_number.phone_number #=> String
resp.phone_number.phone_number_id #=> String
resp.phone_number.meta_phone_number_id #=> String
resp.phone_number.display_phone_number_name #=> String
resp.phone_number.display_phone_number #=> String
resp.phone_number.quality_rating #=> String
resp.phone_number.data_localization_region #=> String
resp. #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    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.

Returns:

See Also:



905
906
907
908
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 905

def (params = {}, options = {})
  req = build_request(:get_linked_whats_app_business_account_phone_number, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_whats_app_message_media({
  media_id: "WhatsAppMediaId", # required
  origination_phone_number_id: "WhatsAppPhoneNumberId", # required
  metadata_only: false,
  destination_s3_presigned_url: {
    url: "S3PresignedUrlUrlString", # required
    headers: { # required
      "String" => "String",
    },
  },
  destination_s3_file: {
    bucket_name: "S3FileBucketNameString", # required
    key: "S3FileKeyString", # required
  },
})

Response structure


resp.mime_type #=> String
resp.file_size #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :media_id (required, String) —

    The unique identifier for the media file.

  • :origination_phone_number_id (required, String) —

    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 (Boolean) —

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

  • :destination_s3_presigned_url (Types::S3PresignedUrl) —

    The presign url of the media file.

  • :destination_s3_file (Types::S3File) —

    The bucketName and key of the S3 media file.

Returns:

See Also:



970
971
972
973
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 970

def get_whats_app_message_media(params = {}, options = {})
  req = build_request(:get_whats_app_message_media, params)
  req.send_request(options)
end

#get_whats_app_message_template(params = {}) ⇒ Types::GetWhatsAppMessageTemplateOutput

Retrieves a specific WhatsApp message template.

Examples:

Request syntax with placeholder values


resp = client.get_whats_app_message_template({
  meta_template_id: "MetaTemplateId", # required
  id: "LinkedWhatsAppBusinessAccountId", # required
})

Response structure


resp.template #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :meta_template_id (required, String) —

    The numeric ID of the template assigned by Meta.

  • :id (required, String) —

    The ID of the WhatsApp Business Account associated with this template.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1002

def get_whats_app_message_template(params = {}, options = {})
  req = build_request(:get_whats_app_message_template, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_linked_whats_app_business_accounts({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.linked_accounts #=> Array
resp.linked_accounts[0].arn #=> String
resp.linked_accounts[0].id #=> String
resp.linked_accounts[0].waba_id #=> String
resp.linked_accounts[0].registration_status #=> String, one of "COMPLETE", "INCOMPLETE"
resp.linked_accounts[0].link_date #=> Time
resp.linked_accounts[0].waba_name #=> String
resp.linked_accounts[0].event_destinations #=> Array
resp.linked_accounts[0].event_destinations[0].event_destination_arn #=> String
resp.linked_accounts[0].event_destinations[0].role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The next token for pagination.

  • :max_results (Integer) —

    The maximum number of results to return.

Returns:

See Also:



1048
1049
1050
1051
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1048

def list_linked_whats_app_business_accounts(params = {}, options = {})
  req = build_request(:list_linked_whats_app_business_accounts, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.status_code #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1082
1083
1084
1085
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1082

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_whats_app_message_templates({
  id: "LinkedWhatsAppBusinessAccountId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.templates #=> Array
resp.templates[0].template_name #=> String
resp.templates[0].meta_template_id #=> String
resp.templates[0].template_status #=> String
resp.templates[0].template_quality_score #=> String
resp.templates[0].template_language #=> String
resp.templates[0].template_category #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the WhatsApp Business Account to list templates for.

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return per page (1-100).

Returns:

See Also:



1129
1130
1131
1132
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1129

def list_whats_app_message_templates(params = {}, options = {})
  req = build_request(:list_whats_app_message_templates, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_whats_app_template_library({
  next_token: "NextToken",
  max_results: 1,
  id: "LinkedWhatsAppBusinessAccountId", # required
  filters: {
    "FilterKeyString" => "FilterValueString",
  },
})

Response structure


resp.meta_library_templates #=> Array
resp.meta_library_templates[0].template_name #=> String
resp.meta_library_templates[0].template_language #=> String
resp.meta_library_templates[0].template_category #=> String
resp.meta_library_templates[0].template_topic #=> String
resp.meta_library_templates[0].template_use_case #=> String
resp.meta_library_templates[0].template_industry #=> Array
resp.meta_library_templates[0].template_industry[0] #=> String
resp.meta_library_templates[0].template_header #=> String
resp.meta_library_templates[0].template_body #=> String
resp.meta_library_templates[0].template_buttons #=> Array
resp.meta_library_templates[0].template_buttons[0].type #=> String
resp.meta_library_templates[0].template_buttons[0].text #=> String
resp.meta_library_templates[0].template_buttons[0].phone_number #=> String
resp.meta_library_templates[0].template_buttons[0].url #=> String
resp.meta_library_templates[0].template_buttons[0].otp_type #=> String
resp.meta_library_templates[0].template_buttons[0].zero_tap_terms_accepted #=> Boolean
resp.meta_library_templates[0].template_buttons[0].supported_apps #=> Array
resp.meta_library_templates[0].template_buttons[0].supported_apps[0] #=> Hash
resp.meta_library_templates[0].template_buttons[0].supported_apps[0]["SupportedAppKeyString"] #=> String
resp.meta_library_templates[0].template_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return per page (1-100).

  • :id (required, String) —

    The ID of the WhatsApp Business Account to list library templates for.

  • :filters (Hash<String,String>) —

    Map of filters to apply (searchKey, topic, usecase, industry, language).

Returns:

See Also:



1197
1198
1199
1200
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1197

def list_whats_app_template_library(params = {}, options = {})
  req = build_request(:list_whats_app_template_library, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.post_whats_app_message_media({
  origination_phone_number_id: "WhatsAppPhoneNumberId", # required
  source_s3_presigned_url: {
    url: "S3PresignedUrlUrlString", # required
    headers: { # required
      "String" => "String",
    },
  },
  source_s3_file: {
    bucket_name: "S3FileBucketNameString", # required
    key: "S3FileKeyString", # required
  },
})

Response structure


resp.media_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :origination_phone_number_id (required, String) —

    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 (Types::S3PresignedUrl) —

    The source presign url of the media file.

  • :source_s3_file (Types::S3File) —

    The source S3 url for the media file.

Returns:

See Also:



1256
1257
1258
1259
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1256

def post_whats_app_message_media(params = {}, options = {})
  req = build_request(:post_whats_app_message_media, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.({
  id: "LinkedWhatsAppBusinessAccountId", # required
  event_destinations: [ # required
    {
      event_destination_arn: "EventDestinationArn", # required
      role_arn: "RoleArn",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1298
1299
1300
1301
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1298

def (params = {}, options = {})
  req = build_request(:put_whats_app_business_account_event_destinations, params)
  req.send_request(options)
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 .

Examples:

Request syntax with placeholder values


resp = client.send_whats_app_message({
  origination_phone_number_id: "WhatsAppPhoneNumberId", # required
  message: "data", # required
  meta_api_version: "String", # required
})

Response structure


resp.message_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :origination_phone_number_id (required, String) —

    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 (required, String, StringIO, File) —

    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 (required, String) —

    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.

Returns:

See Also:



1361
1362
1363
1364
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1361

def send_whats_app_message(params = {}, options = {})
  req = build_request(:send_whats_app_message, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKeyString", # required
      value: "TagValueString",
    },
  ],
})

Response structure


resp.status_code #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    The tags to add to the resource.

Returns:

See Also:



1400
1401
1402
1403
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1400

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Types::UntagResourceOutput

Removes the specified tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["String"], # required
})

Response structure


resp.status_code #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The keys of the tags to remove from the resource.

Returns:

See Also:



1432
1433
1434
1435
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1432

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_whats_app_message_template(params = {}) ⇒ Struct

Updates an existing WhatsApp message template.

Examples:

Request syntax with placeholder values


resp = client.update_whats_app_message_template({
  id: "LinkedWhatsAppBusinessAccountId", # required
  meta_template_id: "MetaTemplateId", # required
  template_category: "MetaTemplateCategory",
  template_components: "data",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the WhatsApp Business Account associated with this template.

  • :meta_template_id (required, String) —

    The numeric ID of the template assigned by Meta.

  • :template_category (String) —

    The new category for the template (for example, UTILITY or MARKETING).

  • :template_components (String, StringIO, File) —

    The updated components of the template as a JSON blob (maximum 3000 characters).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1467
1468
1469
1470
 
# File 'gems/aws-sdk-socialmessaging/lib/aws-sdk-socialmessaging/client.rb', line 1467

def update_whats_app_message_template(params = {}, options = {})
  req = build_request(:update_whats_app_message_template, params)
  req.send_request(options)
end