API for Amazon CloudWatch Application Signals¶
ABAP Package | /AWS1/API_CWS_IMPL |
---|---|
ABAP SDK "TLA" | CWS |
ABAP Interface | /AWS1/IF_CWS |
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 Application Signals is CWS
.
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 Application Signals 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¶
Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.
Application Signals provides the following benefits:
-
Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.
-
Create and monitor service level objectives (SLOs).
-
See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.
Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.
Using the SDK¶
In your code, create a client using the SDK module for Amazon CloudWatch Application Signals, which is created with
factory method /AWS1/CL_CWS_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_cws) = /aws1/cl_cws_factory=>create( go_session ).
Your variable go_cws
is an instance of /AWS1/IF_CWS
,
and all of the operations
in the Amazon CloudWatch Application Signals service are accessed by calling methods in /AWS1/IF_CWS
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon CloudWatch Application Signals, see the Operation List.
Factory Method¶
/AWS1/CL_CWS_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_CWS
.
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_CWS
/AWS1/IF_CWS
¶
/AWS1/IF_CWS
represents the ABAP client for the Application Signals service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_cws)->get_config( ).
lo_config
is a variable of type /AWS1/CL_CWS_CONFIG
. See the documentation for /AWS1/CL_CWS_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon CloudWatch Application Signals can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_CWS_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 Application Signals can be found in interface /AWS1/IF_CWS_PAGINATOR
.