Skip to content

API for Amazon Simple Queue Service

ABAP Package /AWS1/API_SQS_IMPL
ABAP SDK "TLA" SQS
ABAP Interface /AWS1/IF_SQS

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 Queue Service is SQS. 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 SQS 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

Welcome to the Amazon SQS API Reference.

Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

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

You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

  • Cryptographically sign your service requests

  • Retry requests

  • Handle error responses

Additional information

Using the SDK

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

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

API Operations

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

Factory Method

/AWS1/CL_SQS_FACTORY=>create( )

Creates an object of type /AWS1/IF_SQS.

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_SQS /AWS1/IF_SQS

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

Configuring Programmatically

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

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

Paginators

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