API for AWS Well-Architected Tool¶

ABAP Package	`/AWS1/API_WAD`
ABAP SDK "TLA"	`WAD`
ABAP Interface	`/AWS1/IF_WAD`

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 Well-Architected Tool is WAD. 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 WellArchitected 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 Well-Architected

Amazon Web Services Well-Architected helps you evaluate your architectures against Amazon Web Services best practices across operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability. The service includes the Amazon Web Services Well-Architected Agent for AI-powered recommendations tailored to your specific environment, and the Well-Architected Tool for conducting reviews and tracking improvements.

This is the Amazon Web Services Well-Architected API Reference. Through this API, you can programmatically access personalized recommendations and automation scripts from the Amazon Web Services Well-Architected Agent, and create and manage workloads, conduct lens reviews, track milestones, manage custom lenses, share workloads across accounts, and manage profiles with the Well-Architected Tool.

For more information about the service, see the Amazon Web Services Well-Architected User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Well-Architected Tool, which is created with factory method /AWS1/CL_WAD_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_wad)       = /aws1/cl_wad_factory=>create( go_session ).

Your variable go_wad is an instance of /AWS1/IF_WAD, and all of the operations in the AWS Well-Architected Tool service are accessed by calling methods in /AWS1/IF_WAD.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS Well-Architected Tool, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_WAD.

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_wad` `/AWS1/IF_WAD`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Well-Architected Tool can be created via get_paginator() which returns a paginator object of type /AWS1/IF_WAD_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 Well-Architected Tool can be found in interface /AWS1/IF_WAD_PAGINATOR.