API for AWS Cost Explorer Service¶
ABAP Package | /AWS1/API_CEX_IMPL |
---|---|
ABAP SDK "TLA" | CEX |
ABAP Interface | /AWS1/IF_CEX |
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 Cost Explorer Service is CEX
.
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 Cost Explorer 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 Cost Explorer API to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data. This might include the number of daily write operations for Amazon DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
-
https://ce.us-east-1.amazonaws.com
For information about the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.
Using the SDK¶
In your code, create a client using the SDK module for AWS Cost Explorer Service, which is created with
factory method /AWS1/CL_CEX_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_cex) = /aws1/cl_cex_factory=>create( go_session ).
Your variable go_cex
is an instance of /AWS1/IF_CEX
,
and all of the operations
in the AWS Cost Explorer Service service are accessed by calling methods in /AWS1/IF_CEX
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Cost Explorer Service, see the Operation List.
Factory Method¶
/AWS1/CL_CEX_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_CEX
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_CEX
/AWS1/IF_CEX
¶
/AWS1/IF_CEX
represents the ABAP client for the Cost Explorer service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cex)->get_config( ).
lo_config
is a variable of type /AWS1/CL_CEX_CONFIG
. See the documentation for /AWS1/CL_CEX_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for AWS Cost Explorer Service can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_CEX_PAGINATOR`](./_AWS1_IF_CEX_PAGINATOR.md). 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 Cost Explorer Service can be found in interface [`/AWS1/IF_CEX_PAGINATOR`](./_AWS1_IF_CEX_PAGINATOR.md).