API for AWS Free Tier¶

ABAP Package	`/AWS1/API_BCF_IMPL`
ABAP SDK "TLA"	`BCF`
ABAP Interface	`/AWS1/IF_BCF`

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 Free Tier is BCF. 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 FreeTier 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¶

You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.

Free Tier tracks your monthly usage data for all free tier offers that are associated with your Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.

Service endpoint

The Free Tier API provides the following endpoint:

https://freetier.us-east-1.api.aws

For more information, see Using the Amazon Web Services Free Tier in the Billing User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Free Tier, which is created with factory method /AWS1/CL_BCF_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_bcf)       = /aws1/cl_bcf_factory=>create( go_session ).

Your variable go_bcf is an instance of /AWS1/IF_BCF, and all of the operations in the AWS Free Tier service are accessed by calling methods in /AWS1/IF_BCF.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_BCF.

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_BCF` `/AWS1/IF_BCF`¶

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

Configuring Programmatically¶

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

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

Paginators¶

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