API for Amazon DevOps Guru¶
ABAP Package | /AWS1/API_DOG_IMPL |
---|---|
ABAP SDK "TLA" | DOG |
ABAP Interface | /AWS1/IF_DOG |
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 DevOps Guru is DOG
.
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 DevOps Guru 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 DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an insight that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see What is Amazon DevOps Guru.
You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights.
To learn about the DevOps Guru workflow, see How DevOps Guru works. To learn about DevOps Guru concepts, see Concepts in DevOps Guru.
Using the SDK¶
In your code, create a client using the SDK module for Amazon DevOps Guru, which is created with
factory method /AWS1/CL_DOG_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_dog) = /aws1/cl_dog_factory=>create( go_session ).
Your variable go_dog
is an instance of /AWS1/IF_DOG
,
and all of the operations
in the Amazon DevOps Guru service are accessed by calling methods in /AWS1/IF_DOG
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon DevOps Guru, see the Operation List.
Factory Method¶
/AWS1/CL_DOG_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_DOG
.
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_DOG
/AWS1/IF_DOG
¶
/AWS1/IF_DOG
represents the ABAP client for the DevOps Guru service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_dog)->get_config( ).
lo_config
is a variable of type /AWS1/CL_DOG_CONFIG
. See the documentation for /AWS1/CL_DOG_CONFIG
for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon DevOps Guru can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_DOG_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 DevOps Guru can be found in interface /AWS1/IF_DOG_PAGINATOR
.