API for Amazon Appflow¶

ABAP Package	`/AWS1/API_APF_IMPL`
ABAP SDK "TLA"	`APF`
ABAP Interface	`/AWS1/IF_APF`

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 Appflow is APF. 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 Appflow 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 AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors.

Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

Use the following links to get started on the Amazon AppFlow API:

Actions: An alphabetical list of all Amazon AppFlow API operations.
Data types: An alphabetical list of all Amazon AppFlow data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth documentation.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Appflow, which is created with factory method /AWS1/CL_APF_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_apf)       = /aws1/cl_apf_factory=>create( go_session ).

Your variable go_apf is an instance of /AWS1/IF_APF, and all of the operations in the Amazon Appflow service are accessed by calling methods in /AWS1/IF_APF.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_APF.

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_APF` `/AWS1/IF_APF`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon Appflow can be created via get_paginator() which returns a paginator object of type /AWS1/IF_APF_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 Appflow can be found in interface /AWS1/IF_APF_PAGINATOR.