API for AWS Systems Manager Incident Manager¶
| ABAP Package | /AWS1/API_SMI_IMPL |
|---|---|
| ABAP SDK "TLA" | SMI |
| ABAP Interface | /AWS1/IF_SMI |
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 Systems Manager Incident Manager is SMI.
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 SSM Incidents 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¶
Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Using the SDK¶
In your code, create a client using the SDK module for AWS Systems Manager Incident Manager, which is created with
factory method /AWS1/CL_SMI_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_smi) = /aws1/cl_smi_factory=>create( go_session ).
Your variable go_smi is an instance of /AWS1/IF_SMI,
and all of the operations
in the AWS Systems Manager Incident Manager service are accessed by calling methods in /AWS1/IF_SMI.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS Systems Manager Incident Manager, see the Operation List.
Factory Method¶
/AWS1/CL_SMI_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_SMI.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_smi /AWS1/IF_SMI¶
/AWS1/IF_SMIrepresents the ABAP client for the SSM Incidents service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_smi)->get_config( ).
lo_config is a variable of type /AWS1/CL_SMI_CONFIG. See the documentation for /AWS1/CL_SMI_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_SMI_WAITER`](./_AWS1_IF_SMI_WAITER.md).
Paginators¶
Paginators for AWS Systems Manager Incident Manager can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_SMI_PAGINATOR`](./_AWS1_IF_SMI_PAGINATOR.md). 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 Systems Manager Incident Manager can be found in interface [`/AWS1/IF_SMI_PAGINATOR`](./_AWS1_IF_SMI_PAGINATOR.md).