API for Amazon Simple Notification Service¶

ABAP Package	`/AWS1/API_SNS_IMPL`
ABAP SDK "TLA"	`SNS`
ABAP Interface	`/AWS1/IF_SNS`

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 Amazon Simple Notification Service is SNS. 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 SNS 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 Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Simple Notification Service, which is created with factory method /AWS1/CL_SNS_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_sns)       = /aws1/cl_sns_factory=>create( go_session ).

Your variable go_sns is an instance of /AWS1/IF_SNS, and all of the operations in the Amazon Simple Notification Service service are accessed by calling methods in /AWS1/IF_SNS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Simple Notification Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_SNS.

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_SNS` `/AWS1/IF_SNS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Simple Notification Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SNS_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 Amazon Simple Notification Service can be found in interface /AWS1/IF_SNS_PAGINATOR.