API for AWS DevOps Agent Service¶
| ABAP Package | /AWS1/API_DOA |
|---|---|
| ABAP SDK "TLA" | DOA |
| ABAP Interface | /AWS1/IF_DOA |
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 DevOps Agent Service is DOA.
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 Agent 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¶
AWS DevOps Agent is a frontier agent that resolves and proactively prevents incidents, continuously improving reliability and performance. AWS DevOps Agent investigates incidents and identifies operational improvements as an experienced DevOps engineer.
The agent works by:
- Learning your resources and their relationships.
- Working with your observability tools, runbooks, code repositories, and CI/CD pipelines.
- Correlating telemetry, code, and deployment data to understand relationships between your application resources.
- Supporting applications in multicloud and hybrid environments.
Using the SDK¶
In your code, create a client using the SDK module for AWS DevOps Agent Service, which is created with
factory method /AWS1/CL_DOA_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_doa) = /aws1/cl_doa_factory=>create( go_session ).
Your variable go_doa is an instance of /AWS1/IF_DOA,
and all of the operations
in the AWS DevOps Agent Service service are accessed by calling methods in /AWS1/IF_DOA.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS DevOps Agent Service, see the Operation List.
Factory Method¶
/AWS1/CL_DOA_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_DOA.
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_doa /AWS1/IF_DOA¶
/AWS1/IF_DOArepresents the ABAP client for the DevOps Agent service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_doa)->get_config( ).
lo_config is a variable of type /AWS1/CL_DOA_CONFIG. See the documentation for /AWS1/CL_DOA_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for AWS DevOps Agent Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_DOA_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 AWS DevOps Agent Service can be found in interface /AWS1/IF_DOA_PAGINATOR.