API for AWS End User Messaging¶

ABAP Package	`/AWS1/API_PPU`
ABAP SDK "TLA"	`PPU`
ABAP Interface	`/AWS1/IF_PPU`

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 is PPU. 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 EndUserMessaging 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¶

AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.

Using the SDK¶

In your code, create a client using the SDK module for AWS End User Messaging, which is created with factory method /AWS1/CL_PPU_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_ppu)       = /aws1/cl_ppu_factory=>create( go_session ).

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

API Operations¶

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

Factory Method¶

`/AWS1/CL_PPU_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_PPU.

IMPORTING¶

Optional arguments:¶

`iv_protocol` `TYPE /aws1/rt_protocol` `/AWS1/RT_PROTOCOL`¶

`io_session` `TYPE REF TO /aws1/cl_rt_session_base` `/AWS1/CL_RT_SESSION_BASE`¶

`iv_region` `TYPE /aws1/rt_region_id` `/AWS1/RT_REGION_ID`¶

`iv_custom_endpoint` `TYPE /aws1/rt_endpoint` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`oo_client` `TYPE REF TO /aws1/if_ppu` `/AWS1/IF_PPU`¶

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

Configuring Programmatically¶

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

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

Waiters¶

Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.

Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_PPU_WAITER.

Paginators¶

Paginators for AWS End User Messaging can be created via get_paginator() which returns a paginator object of type /AWS1/IF_PPU_PAGINATOR. 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 can be found in interface /AWS1/IF_PPU_PAGINATOR.