API for AWS Application Discovery Service¶

ABAP Package	`/AWS1/API_ADS_IMPL`
ABAP SDK "TLA"	`ADS`
ABAP Interface	`/AWS1/IF_ADS`

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 Application Discovery Service is ADS. 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 Application Discovery 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¶

Amazon Web Services Application Discovery Service

Amazon Web Services Application Discovery Service (Application Discovery Service) helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ.

Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:

Agentless discovery using Amazon Web Services Application Discovery Service Agentless Collector (Agentless Collector), which doesn't require you to install an agent on each host.
- Agentless Collector gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.
- Agentless Collector doesn't collect information about network dependencies, only agent-based discovery collects that information.

Agent-based discovery using the Amazon Web Services Application Discovery Agent (Application Discovery Agent) collects a richer set of data than agentless discovery, which you install on one or more hosts in your data center.
- The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.
- The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the Amazon Web Services cloud. For more information, see Amazon Web Services Application Discovery Agent.

Amazon Web Services Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Amazon Web Services Migration Hub (Migration Hub) without using Agentless Collector or Application Discovery Agent.
- Third-party application discovery tools can query Amazon Web Services Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
- In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.

Working With This Guide

This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

Remember that you must set your Migration Hub home Region before you call any of these APIs.
You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home Region, or a HomeRegionNotSetException error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside of your home Region.
Although it is unlikely, the Migration Hub home Region could change. If you call APIs outside the home Region, an InvalidInputException is returned.
You must call GetHomeRegion to obtain the latest Migration Hub home Region.

This guide is intended for use with the Amazon Web Services Application Discovery Service User Guide.

All data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.

Using the SDK¶

In your code, create a client using the SDK module for AWS Application Discovery Service, which is created with factory method /AWS1/CL_ADS_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_ads)       = /aws1/cl_ads_factory=>create( go_session ).

Your variable go_ads is an instance of /AWS1/IF_ADS, and all of the operations in the AWS Application Discovery Service service are accessed by calling methods in /AWS1/IF_ADS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Application Discovery Service, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_ADS.

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_ADS` `/AWS1/IF_ADS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Application Discovery Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ADS_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 Application Discovery Service can be found in interface /AWS1/IF_ADS_PAGINATOR.