API for AWS Migration Hub Config¶

ABAP Package	`/AWS1/API_MHC_IMPL`
ABAP SDK "TLA"	`MHC`
ABAP Interface	`/AWS1/IF_MHC`

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 Migration Hub Config is MHC. 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 MigrationHub Config 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¶

The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.

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.
If you call a write API outside the home region, an InvalidInputException is returned.
You can call GetHomeRegion action to obtain the account's Migration Hub home region.

For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.

Using the SDK¶

In your code, create a client using the SDK module for AWS Migration Hub Config, which is created with factory method /AWS1/CL_MHC_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_mhc)       = /aws1/cl_mhc_factory=>create( go_session ).

Your variable go_mhc is an instance of /AWS1/IF_MHC, and all of the operations in the AWS Migration Hub Config service are accessed by calling methods in /AWS1/IF_MHC.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Migration Hub Config, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_MHC.

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_MHC` `/AWS1/IF_MHC`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Migration Hub Config can be created via get_paginator() which returns a paginator object of type /AWS1/IF_MHC_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 Migration Hub Config can be found in interface /AWS1/IF_MHC_PAGINATOR.