Skip to content

API for Amazon Simple Workflow Service

ABAP Package /AWS1/API_SWF_IMPL
ABAP SDK "TLA" SWF
ABAP Interface /AWS1/IF_SWF

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 Workflow Service is SWF. 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 SWF 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 Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

Using the SDK

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

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

API Operations

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

Factory Method

/AWS1/CL_SWF_FACTORY=>create( )

Creates an object of type /AWS1/IF_SWF.

IMPORTING

Optional arguments:

IV_PROTOCOL TYPE /AWS1/RT_PROTOCOL

IO_SESSION TYPE REF TO /AWS1/CL_RT_SESSION_BASE

IV_REGION TYPE /AWS1/RT_REGION_ID

IV_CUSTOM_ENDPOINT TYPE /AWS1/RT_ENDPOINT

RETURNING

OO_CLIENT TYPE REF TO /AWS1/IF_SWF

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

Configuring Programmatically

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

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

Paginators

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