API for AWS Directory Service¶
ABAP Package | /AWS1/API_DSR_IMPL |
---|---|
ABAP SDK "TLA" | DSR |
ABAP Interface | /AWS1/IF_DSR |
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 AWS Directory Service is DSR
.
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 Directory Service 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¶
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Using the SDK¶
In your code, create a client using the SDK module for AWS Directory Service, which is created with
factory method /AWS1/CL_DSR_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_dsr) = /aws1/cl_dsr_factory=>create( go_session ).
Your variable go_dsr
is an instance of /AWS1/IF_DSR
,
and all of the operations
in the AWS Directory Service service are accessed by calling methods in /AWS1/IF_DSR
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Directory Service, see the Operation List.
Factory Method¶
/AWS1/CL_DSR_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_DSR
.
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_DSR
/AWS1/IF_DSR
¶
/AWS1/IF_DSR
represents the ABAP client for the Directory Service service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_dsr)->get_config( ).
lo_config
is a variable of type /AWS1/CL_DSR_CONFIG
. See the documentation for /AWS1/CL_DSR_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Directory Service can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_DSR_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 AWS Directory Service can be found in interface /AWS1/IF_DSR_PAGINATOR
.