API for AWS End User Messaging Social

ABAP Package	/AWS1/API_PPM_IMPL
ABAP SDK "TLA"	PPM
ABAP Interface	/AWS1/IF_PPM

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS End User Messaging Social is PPM. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the SocialMessaging module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

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.

Using the SDK

In your code, create a client using the SDK module for AWS End User Messaging Social, which is created with factory method /AWS1/CL_PPM_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_ppm)       = /aws1/cl_ppm_factory=>create( go_session ).

Your variable go_ppm is an instance of /AWS1/IF_PPM, and all of the operations in the AWS End User Messaging Social service are accessed by calling methods in /AWS1/IF_PPM.

API Operations

For an overview of ABAP method calls corresponding to API operations in AWS End User Messaging Social, see the Operation List.

Factory Method

/AWS1/CL_PPM_FACTORY=>create( )

Creates an object of type /AWS1/IF_PPM.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL /AWS1/RT_PROTOCOL

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE /AWS1/CL_RT_SESSION_BASE

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

IV_REGION TYPE /AWS1/RT_REGION_ID /AWS1/RT_REGION_ID

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT /AWS1/RT_ENDPOINT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_PPM /AWS1/IF_PPM

/AWS1/IF_PPM represents the ABAP client for the SocialMessaging service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_ppm)->get_config( ).

lo_config is a variable of type /AWS1/CL_PPM_CONFIG. See the documentation for /AWS1/CL_PPM_CONFIG for details on the settings that can be configured.

Paginators

Paginators for AWS End User Messaging Social can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_PPM_PAGINATOR`](./_AWS1_IF_PPM_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.

Details about the paginator methods available for service AWS End User Messaging Social can be found in interface [`/AWS1/IF_PPM_PAGINATOR`](./_AWS1_IF_PPM_PAGINATOR.md).