API for Amazon CloudWatch¶
| ABAP Package | /AWS1/API_CWT |
|---|---|
| ABAP SDK "TLA" | CWT |
| ABAP Interface | /AWS1/IF_CWT |
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 Amazon CloudWatch is CWT.
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 CloudWatch 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 CloudWatch enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. This guide provides detailed information about CloudWatch actions, data types, parameters, and errors. For more information about CloudWatch features, see Amazon CloudWatch and the Amazon CloudWatch User Guide.
For information about the metrics that other Amazon Web Services products send to CloudWatch, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
Use the following links to get started using the CloudWatch Query API:
: An alphabetical list of all CloudWatch actions.
: An alphabetical list of all CloudWatch data types.
CommonParameters: Parameters that all Query actions can use.
CommonErrors: Client and server errors that all actions can return.
Regions and Endpoints: Supported regions and endpoints for all Amazon Web Services products.
Alternatively, you can use one of the Amazon Web Services SDKs to access CloudWatch using an API tailored to your programming language or platform.
Developers in the Amazon Web Services developer community also provide their own libraries, which you can find at the following Amazon Web Services developer centers:
Amazon Web Services Mobile Services
Windows and .NET Developer Center
Using the SDK¶
In your code, create a client using the SDK module for Amazon CloudWatch, which is created with
factory method /AWS1/CL_CWT_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_cwt) = /aws1/cl_cwt_factory=>create( go_session ).
Your variable go_cwt is an instance of /AWS1/IF_CWT,
and all of the operations
in the Amazon CloudWatch service are accessed by calling methods in /AWS1/IF_CWT.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon CloudWatch, see the Operation List.
Factory Method¶
/AWS1/CL_CWT_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_CWT.
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_cwt /AWS1/IF_CWT¶
/AWS1/IF_CWTrepresents the ABAP client for the CloudWatch service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cwt)->get_config( ).
lo_config is a variable of type /AWS1/CL_CWT_CONFIG. See the documentation for /AWS1/CL_CWT_CONFIG for
details on the settings that can be configured.
Waiters¶
Waiters for Implementation can be accessed via get_waiter() method followed by the waiter method to be called.
Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_CWT_WAITER.
Paginators¶
Paginators for Amazon CloudWatch can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CWT_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 Amazon CloudWatch can be found in interface /AWS1/IF_CWT_PAGINATOR.