API for AWS User Experience Customization¶

ABAP Package	`/AWS1/API_ACU`
ABAP SDK "TLA"	`ACU`
ABAP Interface	`/AWS1/IF_ACU`

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 User Experience Customization is ACU. 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 uxc 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¶

This is the Amazon Web Services User Experience Customization (UXC) API Reference. Amazon Web Services User Experience Customization (UXC) is a utility that provides programmatic access to enable account administrators to customize the visual appearance of the Amazon Web Services Management Console and manage these settings at the account level.

The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.

For more information about UXC features and console procedures, see Getting started with Amazon Web Services User Experience Customization. For information about required permissions, see Identity and access management for Amazon Web Services Management Console.

Using the SDK¶

In your code, create a client using the SDK module for AWS User Experience Customization, which is created with factory method /AWS1/CL_ACU_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_acu)       = /aws1/cl_acu_factory=>create( go_session ).

Your variable go_acu is an instance of /AWS1/IF_ACU, and all of the operations in the AWS User Experience Customization service are accessed by calling methods in /AWS1/IF_ACU.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS User Experience Customization, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_ACU.

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_acu` `/AWS1/IF_ACU`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS User Experience Customization can be created via get_paginator() which returns a paginator object of type /AWS1/IF_ACU_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 User Experience Customization can be found in interface /AWS1/IF_ACU_PAGINATOR.