API for Synthetics¶
|ABAP SDK "TLA"
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 Synthetics is
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the synthetics 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 Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.
Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.
Using the SDK¶
In your code, create a client using the SDK module for Synthetics, which is created with
In this example we will assume you have configured
an SDK profile in transaction
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_syn) = /aws1/cl_syn_factory=>create( go_session ).
For an overview of ABAP method calls corresponding to API operations in Synthetics, see the Operation List.
Creates an object of type
TYPE REF TO
TYPE REF TO
/AWS1/IF_SYNrepresents the ABAP client for the synthetics service, representing each operation as a method call. For more information see the API Page page.
DATA(lo_config) = DATA(go_syn)->get_config( ).
Paginators for Synthetics can be created via
get_paginator() which returns a paginator object of type
/AWS1/IF_SYN_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
Details about the paginator methods available for service Synthetics can be found in interface