Skip to content

API for EC2 Image Builder

ABAP Package /AWS1/API_IMG_IMPL
ABAP SDK "TLA" IMG
ABAP Interface /AWS1/IF_IMG

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 EC2 Image Builder is IMG. 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 imagebuilder 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

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Using the SDK

In your code, create a client using the SDK module for EC2 Image Builder, which is created with factory method /AWS1/CL_IMG_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_img)       = /aws1/cl_img_factory=>create( go_session ).

Your variable go_img is an instance of /AWS1/IF_IMG, and all of the operations in the EC2 Image Builder service are accessed by calling methods in /AWS1/IF_IMG.

API Operations

For an overview of ABAP method calls corresponding to API operations in EC2 Image Builder, see the Operation List.

Factory Method

/AWS1/CL_IMG_FACTORY=>create( )

Creates an object of type /AWS1/IF_IMG.

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_IMG

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

Configuring Programmatically

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

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

Paginators

Paginators for EC2 Image Builder can be created via get_paginator() which returns a paginator object of type /AWS1/IF_IMG_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 EC2 Image Builder can be found in interface /AWS1/IF_IMG_PAGINATOR.