API for Amazon CloudDirectory¶

ABAP Package	`/AWS1/API_DIR_IMPL`
ABAP SDK "TLA"	`DIR`
ABAP Interface	`/AWS1/IF_DIR`

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 CloudDirectory is DIR. 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 CloudDirectory 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 Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.

Using the SDK¶

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

Your variable go_dir is an instance of /AWS1/IF_DIR, and all of the operations in the Amazon CloudDirectory service are accessed by calling methods in /AWS1/IF_DIR.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_DIR.

IMPORTING¶

Required arguments:¶

`IO_SESSION` `TYPE REF TO` `/AWS1/CL_RT_SESSION_BASE`¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE` `/AWS1/RT_PROTOCOL`¶

`IV_REGION` `TYPE` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO` `/AWS1/IF_DIR`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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