API for AWS Sustainability¶

ABAP Package	`/AWS1/API_SUS`
ABAP SDK "TLA"	`SUS`
ABAP Interface	`/AWS1/IF_SUS`

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 Sustainability is SUS. 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 Sustainability 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 Sustainability service provides programmatic access to estimated carbon emissions data for your Amazon Web Services usage. Use the AWS Sustainability service to retrieve, analyze, and track the carbon footprint of your cloud infrastructure over time.

With the AWS Sustainability service, you can:

Retrieve estimated carbon emissions for your Amazon Web Services usage across different time periods
Group emissions data by dimensions such as account, region, and service
Filter emissions data to focus on specific accounts, regions, or services
Access multiple emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM)
Aggregate emissions data at various time granularities including monthly, quarterly, and yearly periods

The API supports pagination for efficient data retrieval and provides dimension values to help you understand the available grouping and filtering options for your account.

All emissions values are calculated using methodologies aligned with the Greenhouse Gas (GHG) Protocol and are provided in metric tons of carbon dioxide-equivalent (MTCO2e).

Using the SDK¶

In your code, create a client using the SDK module for AWS Sustainability, which is created with factory method /AWS1/CL_SUS_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_sus)       = /aws1/cl_sus_factory=>create( go_session ).

Your variable go_sus is an instance of /AWS1/IF_SUS, and all of the operations in the AWS Sustainability service are accessed by calling methods in /AWS1/IF_SUS.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_SUS.

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_sus` `/AWS1/IF_SUS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS Sustainability can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SUS_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 Sustainability can be found in interface /AWS1/IF_SUS_PAGINATOR.