API for Amazon Simple Systems Manager (SSM)¶

ABAP Package	`/AWS1/API_SSM_IMPL`
ABAP SDK "TLA"	`SSM`
ABAP Interface	`/AWS1/IF_SSM`

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 Simple Systems Manager (SSM) is SSM. 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 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 Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .

Using the SDK¶

In your code, create a client using the SDK module for Amazon Simple Systems Manager (SSM), which is created with factory method /AWS1/CL_SSM_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_ssm)       = /aws1/cl_ssm_factory=>create( go_session ).

Your variable go_ssm is an instance of /AWS1/IF_SSM, and all of the operations in the Amazon Simple Systems Manager (SSM) service are accessed by calling methods in /AWS1/IF_SSM.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Simple Systems Manager (SSM), see the Operation List.

Factory Method¶

`/AWS1/CL_SSM_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_SSM.

IMPORTING¶

Required arguments:¶

`IO_SESSION` `TYPE REF TO` `/AWS1/CL_RT_SESSION_BASE`¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE` `/AWS1/RT_PROTOCOL`¶

`IV_REGION` `TYPE` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO` `/AWS1/IF_SSM`¶

/AWS1/IF_SSM represents the ABAP client for the SSM service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_ssm)->get_config( ).

lo_config is a variable of type /AWS1/CL_SSM_CONFIG. See the documentation for /AWS1/CL_SSM_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_SSM_WAITER.

Paginators¶

Paginators for Amazon Simple Systems Manager (SSM) can be created via get_paginator() which returns a paginator object of type /AWS1/IF_SSM_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 Simple Systems Manager (SSM) can be found in interface /AWS1/IF_SSM_PAGINATOR.